Skip to content

Commit 7c9326d

Browse files
Adds elasticapm processor to the docs (#10239)
* Add elasticapm processor * Apply suggestions from code review Co-authored-by: Visha Angelova <[email protected]> * Update docs/reference/edot-collector/config/default-config-standalone.md Co-authored-by: Visha Angelova <[email protected]> * Update docs/reference/edot-collector/config/default-config-standalone.md Co-authored-by: Visha Angelova <[email protected]> * Update modes.md * Reorder table * Fix table --------- Co-authored-by: Visha Angelova <[email protected]>
1 parent ddbae44 commit 7c9326d

File tree

2 files changed

+25
-11
lines changed

2 files changed

+25
-11
lines changed

docs/reference/edot-collector/config/default-config-standalone.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ Data is exported directly to {{es}} using the [`elasticsearch`] exporter in `OTe
6565

6666
The application pipeline in the EDOT Collector receives data from OTel SDKs through the [`OTLP`] receiver. While logs and metrics are exported verbatim into {{es}}, traces require two additional components.
6767

68-
The [`elastictrace`] processor enriches trace data with additional attributes that improve the user experience in the Elastic Observability UIs. In addition, the [`elasticapm`] connector generates pre-aggregated APM metrics from tracing data.
68+
{applies_to}`edot_collector: ga 9.2` The [`elasticapm`] processor enriches trace data with additional attributes that improve the user experience in the Elastic Observability UIs. In addition, the [`elasticapm`] connector generates pre-aggregated APM metrics from tracing data.
6969

7070
Application-related OTel data is ingested into {{es}} in OTel-native format using the [`elasticsearch`] exporter.
7171

7272
:::{note}
73-
Both components, `elastictrace` and `elasticapm` are required for Elastic APM UIs to work properly. As they aren't included in the OpenTelemetry [Collector Contrib repository](https://github.com/open-telemetry/opentelemetry-collector-contrib), you can:
73+
Both the `elasticapm` processor and the `elasticapm` connector are required for Elastic APM UIs to work properly. As they aren't included in the OpenTelemetry [Collector Contrib repository](https://github.com/open-telemetry/opentelemetry-collector-contrib), you can:
7474

7575
* Use the EDOT Collector with the available configuration to ingest data into {{es}}.
7676
* [Build a custom, EDOT-like Collector](/reference/edot-collector/custom-collector.md) for ingesting data into {{es}}.
@@ -100,23 +100,33 @@ Platform logs are scraped with the [`filelog`] receiver, host metrics are collec
100100

101101
Data from OTel SDKs is piped through the [`OTLP`] receiver directly to the OTLP exporter that sends data for all signals to the {{motlp}}.
102102

103-
With the {{motlp}}, there is no need to configure any Elastic-specific components, such as [`elasticinframetrics`], [`elastictrace`] processors, the [`elasticapm`] connector, or the [`elasticsearch`] exporter. Edge setup and configuration can be 100% vendor agnostic.
103+
With the {{motlp}}, there is no need to configure any Elastic-specific components, such as the [`elasticinframetrics`] and [`elasticapm`] processors, the [`elasticapm`] connector, or the [`elasticsearch`] exporter. Edge setup and configuration can be fully vendor agnostic.
104104

105105
## Gateway mode
106106

107107
In Gateway mode, the Collector ingests data from other Collectors running in Agent mode and forwards it to Elastic.
108108

109-
## Example configuration
109+
### Example configuration
110110

111111
The following example configuration files are available for the Gateway mode:
112112

113+
:::::{tab-set}
114+
115+
::::{tab-item} 9.x
113116
| Version | Configuration |
114117
|---------|----------------|
115-
| 8.17 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.0.4/internal/pkg/otel/samples/linux/gateway.yml) |
116-
| 8.18 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.0.4/internal/pkg/otel/samples/linux/gateway.yml) |
118+
| 9.1 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.1.0/internal/pkg/otel/samples/linux/gateway.yml) |
117119
| 9.0 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.0.4/internal/pkg/otel/samples/linux/gateway.yml) |
120+
::::
121+
122+
::::{tab-item} 8.x
123+
| Version | Configuration |
124+
|---------|----------------|
118125
| 8.19 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v8.19.0/internal/pkg/otel/samples/linux/gateway.yml) |
119-
| 9.1 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.1.0/internal/pkg/otel/samples/linux/gateway.yml) |
126+
| 8.18 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.0.4/internal/pkg/otel/samples/linux/gateway.yml) |
127+
| 8.17 | [Gateway mode](https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v9.0.4/internal/pkg/otel/samples/linux/gateway.yml) |
128+
::::
129+
:::::
120130

121131
Use the previous example configuration as a reference when configuring your Gateway Collector or customizing your EDOT Collector configuration.
122132

@@ -175,9 +185,14 @@ processors:
175185
batch/metrics:
176186
send_batch_max_size: 0 # Prevents splitting metrics requests
177187
timeout: 1s
178-
elastictrace: {}
188+
elasticapm: {}
179189
```
180190

191+
:::{note}
192+
:applies_to: edot_collector: ga 9.2
193+
The `elasticapm` processor replaces the deprecated `elastictrace` processor.
194+
:::
195+
181196
### Data export
182197

183198
The Gateway exports data to Elasticsearch in two formats:
@@ -212,7 +227,6 @@ The service section defines separate pipelines for different telemetry types:
212227

213228
Each pipeline connects specific receivers, processors, and exporters to handle different data types appropriately.
214229

215-
216230
## Central configuration
217231

218232
The EDOT Collector can be configured to use [APM Agent Central Configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md). Refer to [Central configuration docs](opentelemetry://reference/central-configuration.md) for more details.
@@ -312,7 +326,7 @@ The server expects incoming HTTP requests to include an API key with sufficient
312326
[`hostmetrics`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver
313327
[`elasticsearch`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/elasticsearchexporter
314328
[`elasticinframetrics`]: https://github.com/elastic/opentelemetry-collector-components/tree/main/processor/elasticinframetricsprocessor
315-
[`elastictrace`]: https://github.com/elastic/opentelemetry-collector-components/tree/main/processor/elastictraceprocessor
329+
[`elasticapm`]: https://github.com/elastic/opentelemetry-collector-components/tree/main/processor/elasticapmprocessor
316330
[`elasticapm`]: https://github.com/elastic/opentelemetry-collector-components/tree/main/connector/elasticapmconnector
317331
[`resource`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourceprocessor
318332
[`resourcedetection`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor

docs/reference/edot-collector/modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This is the only case where using the {{es}} exporter is recommended. In all oth
5858

5959
The following components are required for APM functionality in self-managed Elastic:
6060

61-
- The `elastictrace` processor enriches trace data with additional attributes that improve the user experience in Elastic Observability UIs.
61+
- {applies_to}`edot_collector: ga 9.2` The `elasticapm` processor enriches trace data with additional attributes that improve the user experience in Elastic Observability UIs.
6262
- The `elasticapm` connector generates pre-aggregated APM metrics from trace data.
6363

6464
In this case, EDOT Collector as a Gateway also handles routing of the different types of telemetry data to the relevant indices.

0 commit comments

Comments
 (0)