Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 4.23 KB

otlp.md

File metadata and controls

79 lines (63 loc) · 4.23 KB
Raw

OpenTelemetry Protocol Destination

This defines the options for defining a destination for OpenTelemetry data that use the OTLP protocol.

Values

Authentication - Bearer Token

Key Type Default Description
auth.bearerToken string "" The bearer token for bearer token authentication.
auth.bearerTokenFrom string "" Raw config for accessing the bearer token.
auth.bearerTokenKey string "bearerToken" The key for storing the bearer token in the secret.

Authentication - Basic

Key Type Default Description
auth.password string "" The password for basic authentication.
auth.passwordFrom string "" Raw config for accessing the password.
auth.passwordKey string "password" The key for storing the password in the secret.
auth.username string "" The username for basic authentication.
auth.usernameFrom string "" Raw config for accessing the username.
auth.usernameKey string "username" The key for storing the username in the secret.

Authentication

Key Type Default Description
auth.type string none The type of authentication to do. Options are "none" (default), "basic", "bearerToken".

General

Key Type Default Description
extraHeaders object {} Extra headers to be set when sending data. All values are treated as strings and automatically quoted.
extraHeadersFrom object {} Extra headers to be set when sending data through a dynamic reference. All values are treated as raw strings and not quoted.
name string "" The name for this OTLP destination.
protocol string "grpc" The protocol for the OTLP destination. Options are "grpc" (default), "http".
readBufferSize string "" Size of the read buffer the gRPC client to use for reading server responses.
tenantId string "" The tenant ID for the OTLP destination.
tenantIdFrom string "" Raw config for accessing the tenant ID.
tenantIdKey string "tenantId" The key for storing the tenant ID in the secret.
url string "" The URL for the OTLP destination.
urlFrom string "" Raw config for accessing the URL.
writeBufferSize string "" Size of the write buffer the gRPC client to use for writing requests.

Telemetry

Key Type Default Description
logs.enabled bool false Whether to send logs to the OTLP destination.
metrics.enabled bool false Whether to send metrics to the OTLP destination.
traces.enabled bool true Whether to send traces to the OTLP destination.

Secret

Key Type Default Description
secret.create bool true Whether to create a secret for this Prometheus destination.
secret.embed bool false If true, skip secret creation and embed the credentials directly into the configuration.
secret.name string "" The name of the secret to create.
secret.namespace string "" The namespace for the secret.

TLS

Key Type Default Description
tls.ca string "" The CA certificate for the server (as a string).
tls.caFile string "" The CA certificate for the server (as a path to a file).
tls.caFrom string "" Raw config for accessing the server CA certificate.
tls.cert string "" The client certificate for the server (as a string).
tls.certFile string "" The client certificate for the server (as a path to a file).
tls.certFrom string "" Raw config for accessing the client certificate.
tls.insecure bool false Whether to use TLS for the OTLP destination.
tls.insecureSkipVerify bool false Disables validation of the server certificate.
tls.key string "" The client key for the server (as a string).
tls.keyFile string "" The client key for the server (as a path to a file).
tls.keyFrom string "" Raw config for accessing the client key.