otel_metrics_source

Source for the OpenTelemetry Collector for collecting metric data.

OptionRequiredTypeDescription
portNoIntegerThe port OTel metrics source is running on. Default is 21891.
request_timeoutNoIntegerThe request timeout in milliseconds. Default is 10_000.
health_check_serviceNoBooleanEnables a gRPC health check service under grpc.health.v1/Health/Check. Default is false.
proto_reflection_serviceNoBooleanEnables a reflection service for Protobuf services (see gRPC reflection and gRPC Server Reflection Tutorial docs). Default is false.
unframed_requestsNoBooleanEnable requests not framed using the gRPC wire protocol.
thread_countNoIntegerThe number of threads to keep in the ScheduledThreadPool. Default is 200.
max_connection_countNoIntegerThe maximum allowed number of open connections. Default is 500.
sslNoBooleanEnables connections to the OTel source port over TLS/SSL. Defaults to true.
sslKeyCertChainFileConditionallyStringFile-system path or AWS S3 path to the security certificate (e.g. “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 AWS S3 path to the security key (e.g. “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 certificate and private key from AWS Certificate Manager (ACM). Default 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 to use ACM or S3. Required if useAcmCertForSSL is set to true or sslKeyCertChainFile and sslKeyFile are AWS S3 paths.
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.