Skip to content

gh-142927: Show module names instead of file paths in flamegraph #146040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogsal merged 8 commits into from
Apr 29, 2026
Merged

gh-142927: Show module names instead of file paths in flamegraph #146040

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e0e7d03
Extract module name utilities to module_utils.py
ivonastojanovic Mar 16, 2026
75e120b
Show module names instead of file paths in flamegraph
ivonastojanovic Mar 16, 2026
44599a4
Add 'Full Paths/Module Names' toggle for flamegraph display
ivonastojanovic Mar 20, 2026
9b17680
Rename module_name/name_module to module/label in flamegraph data
ivonastojanovic Mar 31, 2026
ee3aeaa
Fix module name for files not on sys.path
ivonastojanovic Apr 7, 2026
eee3ce4
Simplify module path resolution in module_utils
ivonastojanovic Apr 7, 2026
26b4f18
Add label field to root nodes for module-name toggle
ivonastojanovic Apr 7, 2026
36764cb
Fix display name consistency in flamegraph toggle
ivonastojanovic Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Rename module_name/name_module to module/label in flamegraph data
  • Loading branch information
@ivonastojanovic
ivonastojanovic committed Apr 7, 2026
commit 9b17680849a4e933a8b5e2a85f247f254cfd7d07
43 changes: 18 additions & 25 deletions Lib/profiling/sampling/_flamegraph_assets/flamegraph.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ function resolveStringIndices(node, table) {
if (typeof resolved.funcname === 'number') {
resolved.funcname = resolveString(resolved.funcname, table);
}
if (typeof resolved.module_name === 'number') {
resolved.module_name = resolveString(resolved.module_name);
if (typeof resolved.module === 'number') {
resolved.module = resolveString(resolved.module, table);
}
if (typeof resolved.name_module === 'number') {
resolved.name_module = resolveString(resolved.name_module);
if (typeof resolved.label === 'number') {
resolved.label = resolveString(resolved.label, table);
}

if (Array.isArray(resolved.source)) {
Expand All @@ -90,7 +90,7 @@ function escapeHtml(str) {
return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
}

// Get display path based on user preference (module name or basename)
// Get display path based on user preference (module or full path)
function getDisplayName(moduleName, filename) {
if (useModuleNames) {
return moduleName || filename;
Expand Down Expand Up @@ -248,7 +248,7 @@ function setupLogos() {
function updateStatusBar(nodeData, rootValue) {
const funcname = resolveString(nodeData.funcname) || resolveString(nodeData.name) || "--";
const filename = resolveString(nodeData.filename) || "";
const moduleName = resolveString(nodeData.module_name) || "";
const moduleName = resolveString(nodeData.module) || "";
const lineno = nodeData.lineno;
const timeMs = (nodeData.value / 1000).toFixed(2);
const percent = rootValue > 0 ? ((nodeData.value / rootValue) * 100).toFixed(1) : "0.0";
Expand Down Expand Up @@ -322,7 +322,7 @@ function createPythonTooltip(data) {

const funcname = resolveString(d.data.funcname) || resolveString(d.data.name);
const filename = resolveString(d.data.filename) || "";
const moduleName = resolveString(d.data.module_name) || "";
const moduleName = resolveString(d.data.module) || "";
const displayName = escapeHtml(useModuleNames ? (moduleName || filename) : filename);
const isSpecialFrame = filename === "~";

Expand Down Expand Up @@ -609,7 +609,7 @@ function createFlamegraph(tooltip, rootValue, data) {
.minFrameSize(1)
.tooltip(tooltip)
.inverted(true)
.getName(d => resolveString(useModuleNames ? d.data.name_module : d.data.name) || resolveString(d.data.name) || '')
.getName(d => resolveString(useModuleNames ? d.data.label : d.data.name) || resolveString(d.data.name) || '')
.setColorMapper(function (d) {
if (d.depth === 0) return 'transparent';

Expand Down Expand Up @@ -652,7 +652,7 @@ function updateSearchHighlight(searchTerm, searchInput) {
const name = resolveString(d.data.name) || "";
const funcname = resolveString(d.data.funcname) || "";
const filename = resolveString(d.data.filename) || "";
const moduleName = resolveString(d.data.module_name) || "";
const moduleName = resolveString(d.data.module) || "";
const displayName = getDisplayName(moduleName, filename);
const lineno = d.data.lineno;
const term = searchTerm.toLowerCase();
Expand Down Expand Up @@ -1071,7 +1071,7 @@ function populateStats(data) {

let filename = resolveString(node.filename);
let funcname = resolveString(node.funcname);
let moduleName = resolveString(node.module_name);
let moduleName = resolveString(node.module);

if (!filename || !funcname) {
const nameStr = resolveString(node.name);
Expand Down Expand Up @@ -1103,14 +1103,14 @@ function populateStats(data) {
existing.directPercent = (existing.directSamples / totalSamples) * 100;
if (directSamples > existing.maxSingleSamples) {
existing.filename = filename;
existing.module_name = moduleName;
existing.module = moduleName;
existing.lineno = node.lineno || '?';
existing.maxSingleSamples = directSamples;
}
} else {
functionMap.set(funcKey, {
filename: filename,
module_name: moduleName,
module: moduleName,
lineno: node.lineno || '?',
funcname: funcname,
directSamples,
Expand Down Expand Up @@ -1145,7 +1145,7 @@ function populateStats(data) {
const h = hotSpots[i];
const filename = h.filename || 'unknown';
const lineno = h.lineno ?? '?';
const moduleName = h.module_name || 'unknown';
const moduleName = h.module || 'unknown';
const isSpecialFrame = filename === '~' && (lineno === 0 || lineno === '?');

let funcDisplay = h.funcname || 'unknown';
Expand Down Expand Up @@ -1173,7 +1173,7 @@ function populateStats(data) {
if (card) {
if (i < hotSpots.length && hotSpots[i]) {
const h = hotSpots[i];
const moduleName = h.module_name || 'unknown';
const moduleName = h.module || 'unknown';
const filename = h.filename || 'unknown';
const displayName = getDisplayName(moduleName, filename);
const hasValidLocation = displayName !== 'unknown' && h.lineno !== '?';
Expand Down Expand Up @@ -1309,12 +1309,12 @@ function accumulateInvertedNode(parent, stackFrame, leaf, isDifferential) {
if (!parent.children[key]) {
const newNode = {
name: stackFrame.name,
name_module: stackFrame.name_module,
label: stackFrame.label,
value: 0,
self: 0,
children: {},
filename: stackFrame.filename,
module_name: stackFrame.module_name,
module: stackFrame.module,
lineno: stackFrame.lineno,
funcname: stackFrame.funcname,
source: stackFrame.source,
Expand Down Expand Up @@ -1409,7 +1409,7 @@ function generateInvertedFlamegraph(data) {

const invertedRoot = {
name: data.name,
name_module: data.name_module,
label: data.label,
value: data.value,
children: {},
stats: data.stats,
Expand Down Expand Up @@ -1437,14 +1437,7 @@ function toggleInvert() {
function togglePathDisplay() {
useModuleNames = !useModuleNames;
updateToggleUI('toggle-path-display', useModuleNames);
const dataToRender = isInverted ? invertedData : normalData;
const filteredData = currentThreadFilter !== 'all'
? filterDataByThread(dataToRender, parseInt(currentThreadFilter))
: dataToRender;

const tooltip = createPythonTooltip(filteredData);
const chart = createFlamegraph(tooltip, filteredData.value);
renderFlamegraph(chart, filteredData);
updateFlamegraphView();
}

// ============================================================================
Expand Down
8 changes: 4 additions & 4 deletions Lib/profiling/sampling/stack_collector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,18 +224,18 @@ def convert_children(children, min_samples, path_info):
funcname_idx = self._string_table.intern(func[2])
module_name = self._get_module_name(func[0], path_info)

module_name_idx = self._string_table.intern(module_name)
module_idx = self._string_table.intern(module_name)
name_idx = self._string_table.intern(self._format_function_name(func))
name_module_idx = self._string_table.intern(self._format_module_name(func, module_name))
label_idx = self._string_table.intern(self._format_module_name(func, module_name))

child_entry = {
"name": name_idx,
"name_module": name_module_idx,
"label": label_idx,
Comment thread
ivonastojanovic marked this conversation as resolved.
"value": samples,
"self": node.get("self", 0),
"children": [],
"filename": filename_idx,
"module_name": module_name_idx,
"module": module_idx,
"lineno": func[1],
"funcname": funcname_idx,
"threads": sorted(list(node.get("threads", set()))),
Expand Down