Skip to content

Commit f861349

Browse files
committed
Document OpenTelemetry batch processor
Signed-off-by: Israel Blancas <[email protected]>
1 parent 510a65e commit f861349

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

modules/distr-tracing-otel-config-collector.adoc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,57 @@ The Zipkin receiver ingests data in the Zipkin v1 and v2 formats.
245245
[id="processors_{context}"]
246246
=== Processors
247247

248+
249+
[id="batch-processor_{context}"]
250+
==== Batch processor
251+
252+
The batch processor batches the data to reduce the number of outgoing connections needed to transfer the telemetry information.
253+
254+
* Support level: link:https://access.redhat.com/support/offerings/techpreview[Technology Preview]
255+
* Supported signals: traces, metrics
256+
257+
.Example of the OpenTelemetry Collector custom resource when using the batch processor
258+
[source,yaml]
259+
----
260+
config: |
261+
processor:
262+
batch:
263+
timeout: 5s
264+
send_batch_max_size: 10000
265+
service:
266+
pipelines:
267+
traces:
268+
processors: [batch]
269+
metrics:
270+
processors: [batch]
271+
----
272+
273+
.Parameters used by the batch processor
274+
[cols="3",options="header"]
275+
|===
276+
|Parameter |Description |Default
277+
278+
| `timeout`
279+
| Sends the batch after a specific time duration, irrespective of its size.
280+
| 200ms
281+
282+
| `send_batch_size`
283+
| Sends the batch of telemetry data after the specified number of spans or metrics.
284+
| 8192
285+
286+
| `send_batch_max_size`
287+
| The maximum allowable size of the batch. Must be equal or greater than `send_batch_size`.
288+
| 0
289+
290+
| `metadata_keys`
291+
| When activated, a batcher instance is created for each unique set of values found in the `client.Metadata`.
292+
| []
293+
294+
| `metadata_cardinality_limit`
295+
| When the `metadata_keys` are populated, this configuration restricts the number of distinct metadata key-value combinations processed throughout the duration of the process.
296+
| 1000
297+
|===
298+
248299
[id="resource-detection-processor_{context}"]
249300
==== Resource Detection processor
250301

0 commit comments

Comments
 (0)