Complimentary Gartner® Report! 'A CTO's Guide to Open-Source Software: Answering the Top 10 FAQs.'Read more

OpenTelemetry (OTLP)

Supported Platforms

PlatformMetricsLogsTraces
Linux
Windows
macOS
Kubernetes Node (DaemonSet)
Kubernetes Gateway
OpenShift 4 Node (DaemonSet)

Configuration Table

ParameterTypeDefaultDescription
telemetry_typestelemetrySelector["Logs", "Metrics", "Traces"]Choose Telemetry Type.
listen_addressstring"0.0.0.0"The IP address to listen on.
grpc_portint4317TCP port to receive OTLP telemetry using the gRPC protocol. The port used must not be the same as the HTTP port. Set to 0 to disable.
http_portint4318TCP port to receive OTLP telemetry using the HTTP protocol. The port used must not be the same as the gRPC port. Set to 0 to disable.
enable_tlsboolfalseWhether or not to use TLS.
insecure_skip_verifyboolfalseEnable to skip TLS certificate verification.
ca_filestringCertificate authority used to validate the OTLP server's TLS certificate.
cert_filestringA TLS certificate used for client authentication if mutual TLS is enabled.
key_filestringA TLS private key used for client authentication if mutual TLS is enabled.

Example Configuration

The OTLP source type does not have any required fields. By default, the OTLP source will listen on ports 4317/gRPC and 4318/HTTP on all IP addresses without TLS.

observIQ docs - OpenTelemetry (OTLP) - image 1

Kubernetes

The OTLP source type supports Kubernetes, OpenShift Node (DaemonSet), and Gateway agents. Applications within the cluster can forward metrics, logs, and traces to the agents using the clusterIP services.

Prerequisites

  • BindPlane OP v1.31.0 or newer

Configuration

The OTLP source type does not require additional configuration. It can be attached to any Kubernetes, OpenShift Node (DaemonSet), or Gateway configuration.

The following endpoints can forward telemetry to the managed Node (DaemonSet) agents.

ProtocolServiceEndpoint
gRPCclusterIPbindplane-node-agent.bindplane-agent.svc.cluster.local:4317
gRPCheadless clusterIPbindplane-node-agent-headless.bindplane-agent.svc.cluster.local:4317
HTTPclusterIPhttp://bindplane-node-agent.bindplane-agent.svc.cluster.local:4318

The following endpoints can forward telemetry to the managed Gateway agents.

ProtocolServiceEndpoint
gRPCclusterIPbindplane-gateway-agent.bindplane-agent.svc.cluster.local:4317
gRPCheadless clusterIPbindplane-gateway-agent-headless.bindplane-agent.svc.cluster.local:4317
HTTPclusterIPhttp://bindplane-gateway-agent.bindplane-agent.svc.cluster.local:4318

It is a matter of preference if you should forward telemetry to the DaemonSet or Gateway agents. It is recommended to use the Gateway agent, if DaemonSet resource consumption is a concern, as the Gateway agent can scale independent of cluster size.