This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
otel_trace source
Overview
The otel_trace source is a source for the OpenTelemetry Collector. The following table describes options you can use to configure the otel_trace source.
| Option | Required | Type | Description |
|---|---|---|---|
| port | No | Integer | The port that the otel_trace source runs on. Default value is 21890. |
| request_timeout | No | Integer | The request timeout, in milliseconds. Default value is 10000. |
| health_check_service | No | Boolean | Enables a gRPC health check service under grpc.health.v1/Health/Check. Default value is false. |
| unauthenticated_health_check | No | Boolean | Determines whether or not authentication is required on the health check endpoint. Data Prepper ignores this option if no authentication is defined. Default value is false. |
| proto_reflection_service | No | Boolean | Enables a reflection service for Protobuf services (see gRPC reflection and gRPC Server Reflection Tutorial docs). Default value is false. |
| unframed_requests | No | Boolean | Enable requests not framed using the gRPC wire protocol. |
| thread_count | No | Integer | The number of threads to keep in the ScheduledThreadPool. Default value is 200. |
| max_connection_count | No | Integer | The maximum allowed number of open connections. Default value is 500. |
| ssl | No | Boolean | Enables connections to the OTel source port over TLS/SSL. Defaults to true. |
| sslKeyCertChainFile | Conditionally | String | File system path or Amazon Simple Storage Service (Amazon S3) path to the security certificate (for example, "config/demo-data-prepper.crt" or "s3://my-secrets-bucket/demo-data-prepper.crt"). Required if ssl is set to true. |
| sslKeyFile | Conditionally | String | File system path or Amazon S3 path to the security key (for example, "config/demo-data-prepper.key" or "s3://my-secrets-bucket/demo-data-prepper.key"). Required if ssl is set to true. |
| useAcmCertForSSL | No | Boolean | Whether to enable TLS/SSL using a certificate and private key from AWS Certificate Manager (ACM). Default value is false. |
| acmCertificateArn | Conditionally | String | Represents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificate. Required if useAcmCertForSSL is set to true. |
| awsRegion | Conditionally | String | Represents the AWS region used by ACM or Amazon S3. Required if useAcmCertForSSL is set to true or sslKeyCertChainFile and sslKeyFile are Amazon S3 paths. |
| authentication | No | Object | An authentication configuration. By default, an unauthenticated server is created for the pipeline. This parameter uses pluggable authentication for HTTPS. To use basic authentication, define the http_basic plugin with a username and password. To provide customer authentication, use or create a plugin that implements GrpcAuthenticationProvider. |
Metrics
Counters
requestTimeouts: Measures the total number of requests that time out.requestsReceived: Measures the total number of requests received by theotel_tracesource.successRequests: Measures the total number of requests successfully processed by theotel_tracesource plugin.badRequests: Measures the total number of requests with an invalid format processed by theotel_tracesource plugin.requestsTooLarge: Measures the total number of requests whose number of spans exceeds the buffer capacity.internalServerError: Measures the total number of requests processed by theotel_tracesource with a custom exception type.
Timers
requestProcessDuration: Measures the latency of requests processed by theotel_tracesource plugin in seconds.
Distribution summaries
payloadSize: Measures the incoming request payload size distribution in bytes.