Skip to content

gh-150327: Add Perfetto trace output to profiling.sampling #154541

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

Open
LalitMaganti wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gh-150327: Add Perfetto trace output to profiling.sampling #154541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 24 additions & 4 deletions Lib/profiling/sampling/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from .stack_collector import CollapsedStackCollector, FlamegraphCollector, DiffFlamegraphCollector
from .heatmap_collector import HeatmapCollector
from .gecko_collector import GeckoCollector
from .perfetto_collector import PerfettoCollector
from .jsonl_collector import JsonlCollector
from .binary_collector import BinaryCollector
from .binary_reader import BinaryReader
Expand Down Expand Up @@ -101,6 +102,7 @@ def __call__(self, parser, namespace, values, option_string=None):
"flamegraph": "html",
"diff_flamegraph": "html",
"gecko": "json",
"perfetto": "pftrace",
"heatmap": "html",
"jsonl": "jsonl",
"binary": "bin",
Expand All @@ -112,6 +114,7 @@ def __call__(self, parser, namespace, values, option_string=None):
"flamegraph": FlamegraphCollector,
"diff_flamegraph": DiffFlamegraphCollector,
"gecko": GeckoCollector,
"perfetto": PerfettoCollector,
"heatmap": HeatmapCollector,
"jsonl": JsonlCollector,
"binary": BinaryCollector,
Expand Down Expand Up @@ -483,6 +486,13 @@ def _add_format_options(parser, include_compression=True, include_binary=True):
dest="format",
help="Generate Gecko format for Firefox Profiler",
)
format_group.add_argument(
"--perfetto",
action="store_const",
const="perfetto",
dest="format",
help="Generate a Perfetto trace (StackSample protos) for the Perfetto UI",
)
format_group.add_argument(
"--heatmap",
action="store_const",
Expand Down Expand Up @@ -631,7 +641,7 @@ def _sort_to_mode(sort_choice):

def _create_collector(format_type, sample_interval_usec, skip_idle, opcodes=False,
mode=None, output_file=None, compression='auto',
diff_baseline=None):
diff_baseline=None, target_pid=None):
"""Create the appropriate collector based on format type.

Args:
Expand All @@ -645,6 +655,7 @@ def _create_collector(format_type, sample_interval_usec, skip_idle, opcodes=Fals
output_file: Output file path (required for binary format)
compression: Compression type for binary format ('auto', 'zstd', 'none')
diff_baseline: Path to baseline binary file for differential flamegraph
target_pid: PID of the process being profiled

Returns:
A collector instance of the appropriate type
Expand Down Expand Up @@ -677,6 +688,13 @@ def _create_collector(format_type, sample_interval_usec, skip_idle, opcodes=Fals
skip_idle = False
return collector_class(sample_interval_usec, skip_idle=skip_idle, opcodes=opcodes)

if format_type == "perfetto":
# Like gecko, keep all threads so idle/GIL-wait state intervals are seen.
return collector_class(
sample_interval_usec, skip_idle=False, opcodes=opcodes,
pid=target_pid,
)

if format_type == "jsonl":
return collector_class(
sample_interval_usec, skip_idle=skip_idle, mode=mode
Expand Down Expand Up @@ -957,7 +975,7 @@ def _validate_args(args, parser):
)

# Validate --opcodes is only used with compatible formats
opcodes_compatible_formats = ("live", "gecko", "flamegraph", "diff_flamegraph", "heatmap", "binary")
opcodes_compatible_formats = ("live", "gecko", "perfetto", "flamegraph", "diff_flamegraph", "heatmap", "binary")
if getattr(args, 'opcodes', False) and args.format not in opcodes_compatible_formats:
parser.error(
f"--opcodes is only compatible with {', '.join('--' + f for f in opcodes_compatible_formats)}."
Expand Down Expand Up @@ -1177,7 +1195,8 @@ def _handle_attach(args):
args.format, args.sample_interval_usec, skip_idle, args.opcodes, mode,
output_file=output_file,
compression=getattr(args, 'compression', 'auto'),
diff_baseline=args.diff_baseline
diff_baseline=args.diff_baseline,
target_pid=args.pid,
)

with _get_child_monitor_context(args, args.pid):
Expand Down Expand Up @@ -1284,7 +1303,8 @@ def _handle_run(args):
args.format, args.sample_interval_usec, skip_idle, args.opcodes, mode,
output_file=output_file,
compression=getattr(args, 'compression', 'auto'),
diff_baseline=args.diff_baseline
diff_baseline=args.diff_baseline,
target_pid=process.pid,
)

with _get_child_monitor_context(args, process.pid):
Expand Down
Loading
Loading