You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(pyroscope.ebpf): Document comm, pid_label, and kernel_frames (#6254)
### Brief description of Pull Request
Documents the three new arguments added in #5769 (`comm`, `pid_label`,
`kernel_frames`) in the `pyroscope.ebpf` reference page.
### Notes to the Reviewer
#5769 intentionally left these options undocumented. If they should
remain undocumented, close this PR.
### PR Checklist
- [x] Documentation added
---------
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/sources/reference/components/pyroscope/pyroscope.ebpf.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,16 +75,19 @@ You can use the following arguments with `pyroscope.ebpf`:
75
75
|`build_id_cache_size`|`int`| Deprecated (no-op), previously controlled the size of the elf file build id -> symbols table LRU cache. |`64`| no |
76
76
|`cache_rounds`|`int`| Deprecated (no-op), previously controlled the number of cache rounds. || no |
77
77
|`collect_interval`|`duration`| How frequently to collect profiles. |`"15s"`| no |
78
-
|`collect_kernel_profile`|`bool`| Deprecated (no-op), previously enabled collection of kernelspace profiles. |`true`| no |
79
-
|`collect_user_profile`|`bool`| Deprecated (no-op), previously enabled collection of userspace profiles. |`true`| no |
78
+
|`collect_kernel_profile`|`bool`| Deprecated (no-op), previously enabled collection of kernel-space profiles. |`true`| no |
79
+
|`collect_user_profile`|`bool`| Deprecated (no-op), previously enabled collection of user-space profiles. |`true`| no |
80
+
|`comm`|`string`| How the process command name (`comm`) is included in profiles. One of `none`, `label`, `stackframe`, or `both`. |`"none"`| no |
80
81
|`container_id_cache_size`|`int`| The size of the PID -> container ID table LRU cache. |`1024`| no |
81
-
|`demangle`|`string`| C++ demangle mode. Available options are: `none`, `simplified`, `templates`, or `full`.|`"none"`| no |
82
+
|`demangle`|`string`| C++ `demangle` mode. Available options are: `none`, `simplified`, `templates`, or `full`. |`"none"`| no |
82
83
|`dotnet_enabled`|`bool`| A flag to enable or disable .NET profiling. |`true`| no |
83
84
|`go_table_fallback`|`bool`| Deprecated (no-op), previously enabled symbol lookup in `.sym` / `.dynsym` sections when `.gopclntab` lookup failed. |`false`| no |
84
-
|`hotspot_enabled`|`bool`| A flag to enable ordisable hotspot profiling. |`true`| no |
85
+
|`hotspot_enabled`|`bool`| A flag to enable or disable HotSpot profiling. |`true`| no |
86
+
|`kernel_frames`|`bool`| Include kernel-space frames in collected profiles. Set to `false` to drop kernel frames from each stack trace. |`true`| no |
85
87
|`perl_enabled`|`bool`| A flag to enable or disable Perl profiling. |`true`| no |
86
88
|`php_enabled`|`bool`| A flag to enable or disable PHP profiling. |`true`| no |
87
89
|`pid_cache_size`|`int`| Deprecated (no-op), previously controlled the size of the PID -> proc symbols table LRU cache. |`32`| no |
90
+
|`pid_label`|`bool`| Attach the process PID to each pprof sample as a `pid` label. |`false`| no |
88
91
|`pid_map_size`|`int`| Deprecated (no-op), previously controlled the size of eBPF PID map. |`2048`| no |
89
92
|`python_enabled`|`bool`| A flag to enable or disable python profiling. |`true`| no |
90
93
|`ruby_enabled`|`bool`| A flag to enable or disable Ruby profiling. |`true`| no |
0 commit comments