Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.91 KB

README.md

File metadata and controls

41 lines (31 loc) · 2.91 KB
Raw

OTel Trace Source

This is a source which follows the OTLP Protocol. This source supports OTLP/grpc and OTLP/HTTP. Support for OTLP/HTTP+JSON is not complete due as the traceId and spanId will be base64 and not HexString.

Usages

Example .yaml configuration:

source:
    - otel_trace_source:

Configurations

  • port(Optional) => An int represents the port Otel trace source is running on. Default is 21890.
  • request_timeout(Optional) => An int represents request timeout in millis. Default is 10_000.
  • health_check_service(Optional) => A boolean enables a gRPC health check service under grpc.health.v1 / Health / Check. Default is false.
  • proto_reflection_service(Optional) => A boolean enables a reflection service for Protobuf services (see ProtoReflectionService and gRPC reflection docs). Default is false.
  • unframed_requests(Optional) => A boolean to enable requests not framed using the gRPC wire protocol.
  • thread_count(Optional) => the number of threads to keep in the ScheduledThreadPool. Default is 200.
  • max_connection_count(Optional) => the maximum allowed number of open connections. Default is 500.

SSL

  • ssl(Optional) => A boolean enables TLS/SSL. Default is true.
  • sslKeyCertChainFile(Optional) => A String represents the SSL certificate chain file path or AWS S3 path. S3 path example s3://<bucketName>/<path>. Required if ssl is set to true.
  • sslKeyFile(Optional) => A String represents the SSL key file path or AWS S3 path. S3 path example s3://<bucketName>/<path>. Required if ssl is set to true.
  • useAcmCertForSSL(Optional) => A boolean enables TLS/SSL using certificate and private key from AWS Certificate Manager (ACM). Default is false.
  • acmCertificateArn(Optional) => A 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(Optional) => A String represents the AWS region to use ACM or S3. Required if useAcmCertForSSL is set to true or sslKeyCertChainFile and sslKeyFile is AWS S3 path.

Metrics

Counter

  • requestTimeouts: measures total number of requests that time out.
  • requestsReceived: measures total number of requests received by otel trace source.

Developer Guide

This plugin is compatible with Java 8. See