Skip to content

Commit bde7396

Browse files
authored
Reorganize docs
1 parent 297c36e commit bde7396

File tree

4 files changed

+38
-18
lines changed

4 files changed

+38
-18
lines changed

docs/reference/edot-collector/config/configure-logs-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Configure Logs Collection
2+
navigation_title: Logs collection
33
description: Learn how to configure and customize logs collection through the Elastic Distribution of OpenTelemetry Collector.
44
applies_to:
55
stack:

docs/reference/edot-collector/config/configure-metrics-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Configure Metrics Collection
2+
navigation_title: Metrics collection
33
description: Learn how to configure and customize metrics collection through the Elastic Distribution of OpenTelemetry Collector.
44
applies_to:
55
stack:

docs/reference/edot-collector/config/configure-profiles-collection.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
navigation_title: Profiles collection
3-
description: Configure the EDOT Collector for profiles collection.
3+
description: Learn how to configure and customize profiles collection through the Elastic Distribution of OpenTelemetry Collector.
44
applies_to:
55
stack: preview 9.2
66
serverless:
@@ -12,26 +12,27 @@ products:
1212
- id: edot-collector
1313
---
1414

15-
# Profiles support in EDOT
15+
# Configure profiles collection
1616

17-
Profiles represent the fourth pillar of observability, complementing logs, traces, and metrics.
17+
The {{edot}} (EDOT) Collector includes a profiling receiver, which offers an eBPF-based, system-wide profiler.
1818

19-
The Elastic Distributions of OpenTelemetry (EDOT) Collector includes a profiling receiver, which offers an eBPF-based, system-wide profiler.
19+
To activate and configure profiling and send profiles to {{ecloud}} or {{es}}, follow these instructions.
2020

21-
Deploying the EDOT Collector with a profiling receiver in Kubernetes should be done 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 complete observability.
21+
:::{important}
22+
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.
23+
:::
2224

23-
::{note}
24-
OpenTelemetry profiles is not yet a stable feature. To use it, Elastic Distributions
25-
of OpenTelemetry (EDOT) Collector need to be started with the additional argument `--feature-gates=service.profilesSupport`.
26-
::
25+
## Turn on profiling
2726

28-
## Full profiles collection
27+
Follow these steps to turn on profiles collection through the EDOT Collector.
2928

30-
For full profiles collection and reporting use the following configuration.
29+
:::::{stepper}
30+
::::{step} Set up Universal Profiling
31+
Follow the steps to [`set up Universal Profiling`] before applying the following configuration.
32+
::::
3133

32-
::{note}
33-
Please follow the steps in Kibana to [`set up Universal Profiling`] before applying the following configuration.
34-
::
34+
::::{step} Full profiles collection
35+
For full profiles collection and reporting, use this Collector configuration:
3536

3637
```yaml
3738
receivers:
@@ -44,10 +45,24 @@ service:
4445
receivers: [ profiling ]
4546
exporters: [ elasticsearch ]
4647
```
48+
::::
49+
50+
::::{step} Activate profiling in the Collector
51+
To activate profiling in the EDOT Collector, start it using the additional argument `--feature-gates=service.profilesSupport`.
52+
53+
For example:
54+
55+
```sh
56+
sudo ./otelcol --config otel.yml --feature-gates=service.profilesSupport
57+
```
58+
::::
59+
:::::
4760

4861
## Generate metrics from profiles
4962

50-
The system can be configured to generate and report metrics exclusively from profile information. This method contributes to a reduction in ingest traffic and storage costs.
63+
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.
64+
65+
The following example generates profiling metrics by frame, frame type, and classification:
5166

5267
```yaml
5368
connectors:
@@ -70,4 +85,8 @@ service:
7085
exporters: [ elasticsearch ]
7186
```
7287

73-
[`set up Universal Profiling`]: https://www.elastic.co/docs/solutions/observability/infra-and-hosts/get-started-with-universal-profiling#profiling-configure-data-ingestion
88+
## Kubernetes deployments
89+
90+
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.
91+
92+
[`set up Universal Profiling`]: docs-content://solutions/observability/infra-and-hosts/get-started-with-universal-profiling.md#profiling-configure-data-ingestion

docs/reference/edot-collector/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ toc:
1010
- file: config/configure-metrics-collection.md
1111
- file: config/tail-based-sampling.md
1212
- file: config/authentication-methods.md
13+
- file: config/configure-profiles-collection.md
1314
- file: config/proxy.md
1415
- file: components.md
1516
children:

0 commit comments

Comments
 (0)