otel_metrics_source

otel_metrics_source is an OpenTelemetry Collector source that collects metric data. The following table describes options you can use to configure the otel_metrics_source source.

OptionRequiredTypeDescription
portNoIntegerThe port that the OpenTelemtry metrics source runs on. Default value is 21891.
request_timeoutNoIntegerThe request timeout, in milliseconds. Default value is 10000.
health_check_serviceNoBooleanEnables a gRPC health check service under grpc.health.v1/Health/Check. Default value is false.
proto_reflection_serviceNoBooleanEnables a reflection service for Protobuf services (see gRPC reflection and gRPC Server Reflection Tutorial docs). Default value is false.
unframed_requestsNoBooleanEnables requests not framed using the gRPC wire protocol.
thread_countNoIntegerThe number of threads to keep in the ScheduledThreadPool. Default value is 200.
max_connection_countNoIntegerThe maximum allowed number of open connections. Default value is 500.
sslNoBooleanEnables connections to the OpenTelemetry source port over TLS/SSL. Default value is true.
sslKeyCertChainFileConditionallyStringFile-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.
sslKeyFileConditionallyStringFile-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.
useAcmCertForSSLNoBooleanWhether to enable TLS/SSL using a certificate and private key from AWS Certificate Manager (ACM). Default value is false.
acmCertificateArnConditionallyStringRepresents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificates. Required if useAcmCertForSSL is set to true.
awsRegionConditionallyStringRepresents the AWS Region used by ACM or Amazon S3. Required if useAcmCertForSSL is set to true or sslKeyCertChainFile and sslKeyFile is the Amazon S3 path.
authenticationNoObjectAn authentication configuration. By default, an unauthenticated server is created for the pipeline. This 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

The otel_metrics_source source includes the following metrics.

Counters

  • requestTimeouts: Measures the total number of requests that time out.

  • requestsReceived: Measures the total number of requests received by the OpenTelemetry metrics source.

    otel_metrics_source - 图1