From 5506b651eb37648dbace7d7adf7b8cb7cd53cb0f Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Mon, 16 Oct 2023 15:35:40 +0200 Subject: [PATCH] Document OpenTelemetry batch processor Signed-off-by: Israel Blancas --- .../distr-tracing-otel-config-collector.adoc | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/modules/distr-tracing-otel-config-collector.adoc b/modules/distr-tracing-otel-config-collector.adoc index 472027229884..3cafd83f0ef1 100644 --- a/modules/distr-tracing-otel-config-collector.adoc +++ b/modules/distr-tracing-otel-config-collector.adoc @@ -245,6 +245,57 @@ The Zipkin receiver ingests data in the Zipkin v1 and v2 formats. [id="processors_{context}"] === Processors + +[id="batch-processor_{context}"] +==== Batch processor + +The batch processor batches the data to reduce the number of outgoing connections needed to transfer the telemetry information. + +* Support level: link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] +* Supported signals: traces, metrics + +.Example of the OpenTelemetry Collector custom resource when using the batch processor +[source,yaml] +---- + config: | + processor: + batch: + timeout: 5s + send_batch_max_size: 10000 + service: + pipelines: + traces: + processors: [batch] + metrics: + processors: [batch] +---- + +.Parameters used by the batch processor +[cols="3",options="header"] +|=== +|Parameter |Description |Default + +| `timeout` +| Sends the batch after a specific time duration, irrespective of its size. +| 200ms + +| `send_batch_size` +| Sends the batch of telemetry data after the specified number of spans or metrics. +| 8192 + +| `send_batch_max_size` +| The maximum allowable size of the batch. Must be equal or greater than `send_batch_size`. +| 0 + +| `metadata_keys` +| When activated, a batcher instance is created for each unique set of values found in the `client.Metadata`. +| [] + +| `metadata_cardinality_limit` +| When the `metadata_keys` are populated, this configuration restricts the number of distinct metadata key-value combinations processed throughout the duration of the process. +| 1000 +|=== + [id="resource-detection-processor_{context}"] ==== Resource Detection processor