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_metrics_source is an OpenTelemetry Collector source that collects metric data. The following table describes options you can use to configure the
|port||No||Integer||The port that the OpenTelemtry metrics source runs on. Default value is |
|request_timeout||No||Integer||The request timeout, in milliseconds. Default value is |
|health_check_service||No||Boolean||Enables a gRPC health check service under |
|proto_reflection_service||No||Boolean||Enables a reflection service for Protobuf services (see gRPC reflection and gRPC Server Reflection Tutorial docs). Default value is |
|unframed_requests||No||Boolean||Enables requests not framed using the gRPC wire protocol.|
|thread_count||No||Integer||The number of threads to keep in the |
|max_connection_count||No||Integer||The maximum allowed number of open connections. Default value is |
|ssl||No||Boolean||Enables connections to the OpenTelemetry source port over TLS/SSL. Default value is |
|sslKeyCertChainFile||Conditionally||String||File-system path or Amazon Simple Storage Service (Amazon S3) path to the security certificate (for example, |
|sslKeyFile||Conditionally||String||File-system path or Amazon S3 path to the security key (for example, |
|useAcmCertForSSL||No||Boolean||Whether to enable TLS/SSL using a certificate and private key from AWS Certificate Manager (ACM). Default value is |
|acmCertificateArn||Conditionally||String||Represents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificates. Required if |
|awsRegion||Conditionally||String||Represents the AWS Region used by ACM or Amazon S3. Required if |
|authentication||No||Object||An authentication configuration. By default, an unauthenticated server is created for the pipeline. This uses pluggable authentication for HTTPS. To use basic authentication, define the |
otel_metrics_source source includes the following metrics.
requestTimeouts: Measures the total number of requests that time out.
requestsReceived: Measures the total number of requests received by the OpenTelemetry metrics source.