docs(pyroscope.ebpf): Document comm, pid_label, and kernel_frames#6254
Conversation
…uments Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -77,14 +77,17 @@ You can use the following arguments with `pyroscope.ebpf`: | |||
| | `collect_interval` | `duration` | How frequently to collect profiles. | `"15s"` | no | | |||
| | `collect_kernel_profile` | `bool` | Deprecated (no-op), previously enabled collection of kernelspace profiles. | `true` | no | | |||
There was a problem hiding this comment.
Grafana.Spelling (error)
'kernelspace' is not in the Grafana dictionary. If the word is correct, add it to the dictionary by following Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. The spell checker ignores words in the following formatting: - Bold — use for UI elements. - Code — use for paths, configuration, user input, code, class, method, and variable names, status codes, and console output.
Reported by Vale using Grafana Writers' Toolkit style. If you believe we can improve the rule, report an issue.
| @@ -77,14 +77,17 @@ You can use the following arguments with `pyroscope.ebpf`: | |||
| | `collect_interval` | `duration` | How frequently to collect profiles. | `"15s"` | no | | |||
| | `collect_kernel_profile` | `bool` | Deprecated (no-op), previously enabled collection of kernelspace profiles. | `true` | no | | |||
| | `collect_user_profile` | `bool` | Deprecated (no-op), previously enabled collection of userspace profiles. | `true` | no | | |||
There was a problem hiding this comment.
Grafana.Spelling (error)
'userspace' is not in the Grafana dictionary. If the word is correct, add it to the dictionary by following Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. The spell checker ignores words in the following formatting: - Bold — use for UI elements. - Code — use for paths, configuration, user input, code, class, method, and variable names, status codes, and console output.
Reported by Vale using Grafana Writers' Toolkit style. If you believe we can improve the rule, report an issue.
| | `collect_user_profile` | `bool` | Deprecated (no-op), previously enabled collection of userspace profiles. | `true` | no | | ||
| | `comm` | `string` | How the process command name (`comm`) is included in profiles. One of `none`, `label`, `stackframe`, or `both`. | `"none"` | no | | ||
| | `container_id_cache_size` | `int` | The size of the PID -> container ID table LRU cache. | `1024` | no | | ||
| | `demangle` | `string` | C++ demangle mode. Available options are: `none`, `simplified`, `templates`, or `full`. | `"none"` | no | |
There was a problem hiding this comment.
Grafana.Spelling (error)
'demangle' is not in the Grafana dictionary. If the word is correct, add it to the dictionary by following Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. The spell checker ignores words in the following formatting: - Bold — use for UI elements. - Code — use for paths, configuration, user input, code, class, method, and variable names, status codes, and console output.
Reported by Vale using Grafana Writers' Toolkit style. If you believe we can improve the rule, report an issue.
| | `demangle` | `string` | C++ demangle mode. Available options are: `none`, `simplified`, `templates`, or `full`. | `"none"` | no | | ||
| | `dotnet_enabled` | `bool` | A flag to enable or disable .NET profiling. | `true` | no | | ||
| | `go_table_fallback` | `bool` | Deprecated (no-op), previously enabled symbol lookup in `.sym` / `.dynsym` sections when `.gopclntab` lookup failed. | `false` | no | | ||
| | `hotspot_enabled` | `bool` | A flag to enable ordisable hotspot profiling. | `true` | no | |
There was a problem hiding this comment.
Grafana.Spelling (error)
'ordisable' is not in the Grafana dictionary. If the word is correct, add it to the dictionary by following Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. The spell checker ignores words in the following formatting: - Bold — use for UI elements. - Code — use for paths, configuration, user input, code, class, method, and variable names, status codes, and console output.
Reported by Vale using Grafana Writers' Toolkit style. If you believe we can improve the rule, report an issue.
| | `demangle` | `string` | C++ demangle mode. Available options are: `none`, `simplified`, `templates`, or `full`. | `"none"` | no | | ||
| | `dotnet_enabled` | `bool` | A flag to enable or disable .NET profiling. | `true` | no | | ||
| | `go_table_fallback` | `bool` | Deprecated (no-op), previously enabled symbol lookup in `.sym` / `.dynsym` sections when `.gopclntab` lookup failed. | `false` | no | | ||
| | `hotspot_enabled` | `bool` | A flag to enable ordisable hotspot profiling. | `true` | no | |
There was a problem hiding this comment.
Grafana.Spelling (error)
'hotspot' is not in the Grafana dictionary. If the word is correct, add it to the dictionary by following Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. The spell checker ignores words in the following formatting: - Bold — use for UI elements. - Code — use for paths, configuration, user input, code, class, method, and variable names, status codes, and console output.
Reported by Vale using Grafana Writers' Toolkit style. If you believe we can improve the rule, report an issue.
|
💻 Deploy preview deleted (docs(pyroscope.ebpf): Document comm, pid_label, and kernel_frames). |
Address spelling-checker complaints surfaced by Vale on the rows neighboring the new arguments: hyphenate kernelspace/userspace, fix the "ordisable" typo, capitalize HotSpot, and code-format the demangle reference. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
korniltsev-grafanista
deleted the
korniltsev-grafanista/kk/alloy-5769-docs
branch
2 participants
Brief description of Pull Request
Documents the three new arguments added in #5769 (
comm,pid_label,kernel_frames) in thepyroscope.ebpfreference page.Notes to the Reviewer
#5769 intentionally left these options undocumented. If they should remain undocumented, close this PR.
PR Checklist