Skip to content

Commit 01936d2

Browse files
authored
Add batching config docs (#10601)
* Add batching config docs * Tech review edits
1 parent bd11fa9 commit 01936d2

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

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

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313
- id: edot-collector
1414
---
1515

16-
# Default configuration of the EDOT Collector (Standalone)
16+
# Default configuration of the EDOT Collector (standalone)
1717

1818
The default configuration of the {{edot}} (EDOT) Collector includes pipelines for the collection of logs, host metrics, and data from OpenTelemetry SDKs.
1919

@@ -65,7 +65,7 @@ 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-
{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.
68+
{applies_to}`edot_collector: ga 9.2` The [`elasticapm`] processor enriches trace data with additional attributes that improve the user experience in the {{product.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

@@ -102,6 +102,32 @@ Data from OTel SDKs is piped through the [`OTLP`] receiver directly to the OTLP
102102

103103
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

105+
### Batching configuration for contrib OpenTelemetry Collector
106+
107+
When using contrib or upstream OpenTelemetry collectors, the following batching configuration is recommended when sending data to the {{motlp}}:
108+
109+
```yaml
110+
otlp/ingest:
111+
endpoint: <ingest endpoint>
112+
headers:
113+
Authorization: ApiKey <value>
114+
sending_queue:
115+
enabled: true
116+
sizer: bytes
117+
queue_size: 50000000 # 50MB uncompressed
118+
block_on_overflow: true
119+
batch:
120+
flush_interval: 1s
121+
min_size: 1_000_000 # 1MB uncompressed
122+
max_size: 4_000_000 # 4MB uncompressed
123+
```
124+
125+
The previous configuration leverages an in-memory queue and optimized batching defaults to improve throughput, minimize data loss, and maintain low end-to-end latency.
126+
127+
:::{note}
128+
The previous configuration is already included in the {{edot}} Collector.
129+
:::
130+
105131
## Gateway mode
106132
107133
In Gateway mode, the Collector ingests data from other Collectors running in Agent mode and forwards it to Elastic.

0 commit comments

Comments
 (0)