-
Notifications
You must be signed in to change notification settings - Fork 193
edot/docs: add support for profiles #10146
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.
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
+98
−2
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
018331f
edot/docs: add support for profiles
florianl 297c36e
fixup: new line at end of file
florianl bde7396
Reorganize docs
theletterf 7456ee5
drop link to UP
florianl c205076
Update configure-profiles-collection.md
theletterf aefd6cf
Merge branch 'main' into edot-profiling-config-doc
theletterf ad272d2
drop regular profiling
florianl 94fe07d
drop second part
florianl 12246cf
Update docs/reference/edot-collector/config/configure-profiles-collec…
theletterf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Kind can be one of: | ||
# - breaking-change: a change to previously-documented behavior | ||
# - deprecation: functionality that is being removed in a later release | ||
# - bug-fix: fixes a problem in a previous version | ||
# - enhancement: extends functionality but does not break or fix existing behavior | ||
# - feature: new functionality | ||
# - known-issue: problems that we are aware of in a given version | ||
# - security: impacts on the security of a product or a user’s deployment. | ||
# - upgrade: important information for someone upgrading from a prior version | ||
# - other: does not fit into any of the other categories | ||
kind: feature | ||
|
||
# Change summary; a 80ish characters long description of the change. | ||
summary: add documentation for the profiles support in EDOT | ||
|
||
# Long description; in case the summary is not enough to describe the change | ||
# this field accommodate a description without length limits. | ||
# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment. | ||
#description: | ||
|
||
# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc. | ||
component: "elastic-agent" | ||
|
||
# PR URL; optional; the PR number that added the changeset. | ||
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added. | ||
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number. | ||
# Please provide it if you are adding a fragment for a different PR. | ||
#pr: https://github.com/owner/repo/1234 | ||
|
||
# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of). | ||
# If not present is automatically filled by the tooling with the issue linked to the PR number. | ||
#issue: https://github.com/owner/repo/1234 |
2 changes: 1 addition & 1 deletion
2
docs/reference/edot-collector/config/configure-logs-collection.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/reference/edot-collector/config/configure-metrics-collection.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
docs/reference/edot-collector/config/configure-profiles-collection.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
navigation_title: Profiles collection | ||
description: Learn how to configure and customize profiles collection through the Elastic Distribution of OpenTelemetry Collector. | ||
applies_to: | ||
stack: preview 9.2 | ||
serverless: | ||
observability: | ||
product: | ||
edot_collector: preview | ||
products: | ||
- id: observability | ||
- id: edot-collector | ||
--- | ||
|
||
# Configure profiles collection | ||
|
||
The {{edot}} (EDOT) Collector includes a profiling receiver, which offers an eBPF-based, system-wide profiler. | ||
|
||
To activate and configure profiling and send profiles to {{ecloud}} or {{es}}, follow these instructions. | ||
|
||
:::{important} | ||
OpenTelemetry profiling is still under active development. Refer to [The State of Profiling](https://opentelemetry.io/blog/2024/state-profiling/) blog post for more information. | ||
::: | ||
|
||
## Turn on profiling | ||
|
||
Follow these steps to turn on profiles collection through the EDOT Collector. | ||
|
||
:::::{stepper} | ||
::::{step} Set up Universal Profiling | ||
Universal Profiling must be set up before profiles can be ingested and visualized. | ||
|
||
To set up Universal Profiling, go to **Observability** in Kibana and then to **Infrastructure** > **Universal Profiling**. If it's not yet configured, select **Set up Universal Profiling** and follow the instructions. | ||
|
||
:::{note} | ||
The setup dialog doesn't appear if Universal Profiling is already configured. | ||
::: | ||
:::: | ||
|
||
::::{step} Full profiles collection | ||
For full profiles collection and reporting, use this Collector configuration: | ||
|
||
```yaml | ||
receivers: | ||
profiling: | ||
SamplesPerSecond: 19 | ||
|
||
service: | ||
pipelines: | ||
profiles: | ||
receivers: [ profiling ] | ||
exporters: [ elasticsearch ] | ||
``` | ||
:::: | ||
|
||
::::{step} Activate profiling in the Collector | ||
To activate profiling in the EDOT Collector, start it using the additional argument `--feature-gates=service.profilesSupport`. | ||
|
||
For example: | ||
|
||
```sh | ||
sudo ./otelcol --config otel.yml --feature-gates=service.profilesSupport | ||
``` | ||
:::: | ||
::::: | ||
|
||
## Generate metrics from profiles | ||
|
||
You can configure the components to generate and report metrics exclusively from profile information. This method contributes to a reduction in ingest traffic and storage costs. | ||
|
||
The following example generates profiling metrics by frame, frame type, and classification: | ||
|
||
```yaml | ||
connectors: | ||
profilingmetrics: | ||
by_frame: true | ||
by_frametype: true | ||
by_classification: true | ||
|
||
receivers: | ||
profiling: | ||
SamplesPerSecond: 19 | ||
|
||
service: | ||
pipelines: | ||
profiles: | ||
receivers: [ profiling ] | ||
exporters: [ profilingmetrics ] | ||
metrics: | ||
receivers: [ profilingmetrics ] | ||
exporters: [ elasticsearch ] | ||
``` | ||
|
||
## Kubernetes deployments | ||
|
||
In Kubernetes, deploy the EDOT Collector with a profiling receiver as a DaemonSet. This ensures comprehensive, node-level profiling across the entire complete cluster, providing consistent data collection, resilience, scalability, and simplified management. This approach is recommended for optimal performance and full observability. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
receivers: | ||
profiling: | ||
SamplesPerSecond: 19 | ||
exporters: | ||
elasticsearch: | ||
endpoints: [ "${env:ELASTIC_ENDPOINT}" ] | ||
api_key: ${env:ELASTIC_API_KEY} | ||
mapping: | ||
mode: otel | ||
|
||
service: | ||
pipelines: | ||
profiles: | ||
receivers: [ profiling ] | ||
exporters: [ elasticsearch ] | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
receivers: | ||
profiling: | ||
SamplesPerSecond: 19 | ||
|
||
connectors: | ||
profilingmetrics: | ||
by_frametype: true | ||
by_frame: true | ||
by_classification: true | ||
|
||
exporters: | ||
elasticsearch: | ||
endpoints: [ "${env:ELASTIC_ENDPOINT}" ] | ||
api_key: ${env:ELASTIC_API_KEY} | ||
mapping: | ||
mode: otel | ||
|
||
service: | ||
pipelines: | ||
profiles: | ||
receivers: [ profiling ] | ||
exporters: [ profilingmetrics ] | ||
metrics: | ||
receivers: [ profilingmetrics ] | ||
exporters: [ elasticsearch ] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.