Grafana Agent FlowReferenceComponentsotelcol.receiver.jaeger

otelcol.receiver.jaeger

otelcol.receiver.jaeger accepts Jaeger-formatted data over the network and forwards it to other otelcol.* components.

NOTE: otelcol.receiver.jaeger is a wrapper over the upstream OpenTelemetry Collector jaeger receiver. Bug reports or feature requests will be redirected to the upstream repository, if necessary.

Multiple otelcol.receiver.jaeger components can be specified by giving them different labels.

Usage

otelcol.receiver.jaeger "LABEL" {
  protocols {
    grpc {}
    thrift_http {}
    thrift_binary {}
    thrift_compact {}
  }

  output {
    metrics = [...]
    logs    = [...]
    traces  = [...]
  }
}

Arguments

otelcol.receiver.jaeger doesn’t support any arguments and is configured fully through inner blocks.

Blocks

The following blocks are supported inside the definition of otelcol.receiver.jaeger:

HierarchyBlockDescriptionRequired
protocolsprotocolsConfigures the protocols the component can accept traffic over.yes
protocols > grpcgrpcConfigures a Jaeger gRPC server to receive traces.no
protocols > grpc > tlstlsConfigures TLS for the gRPC server.no
protocols > grpc > keepalivekeepaliveConfigures keepalive settings for the configured server.no
protocols > grpc > keepalive > server_parametersserver_parametersServer parameters used to configure keepalive settings.no
protocols > grpc > keepalive > enforcement_policyenforcement_policyEnforcement policy for keepalive settings.no
protocols > thrift_httpthrift_httpConfigures a Thrift HTTP server to receive traces.no
protocols > thrift_http > tlstlsConfigures TLS for the Thrift HTTP server.no
protocols > thrift_http > corscorsConfigures CORS for the Thrift HTTP server.no
protocols > thrift_binarythrift_binaryConfigures a Thrift binary UDP server to receive traces.no
protocols > thrift_compactthrift_compactConfigures a Thrift compact UDP server to receive traces.no
outputoutputConfigures where to send received telemetry data.yes

The > symbol indicates deeper levels of nesting. For example, protocols > grpc refers to a grpc block defined inside a protocols block.

protocols block

The protocols block defines a set of protocols that will be used to accept traces over the network.

protocols doesn’t support any arguments and is configured fully through inner blocks.

otelcol.receiver.jeager requires at least one protocol block (grpc, thrift_http, thrift_binary, or thrift_compact) to be provided.

grpc block

The grpc block configures a gRPC server which can accept Jaeger traces. If the grpc block isn’t provided, a gRPC server isn’t started.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
endpointstringhost:port to listen for traffic on."0.0.0.0:14250"no
transportstringTransport to use for the gRPC server."tcp"no
max_recv_msg_sizestringMaximum size of messages the server will accept. 0 disables a limit.no
max_concurrent_streamsnumberLimit the number of concurrent streaming RPC calls.no
read_buffer_sizestringSize of the read buffer the gRPC server will use for reading from clients."512KiB"no
write_buffer_sizestringSize of the write buffer the gRPC server will use for writing to clients.no
include_metadatabooleanPropagate incoming connection metadata to downstream consumers.no

tls block

The tls block configures TLS settings used for a server. If the tls block isn’t provided, TLS won’t be used for connections to the server.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
ca_filestringPath to the CA file.no
cert_filestringPath to the TLS certificate.no
key_filestringPath to the TLS certificate key.no
min_versionstringMinimum acceptable TLS version for connections."TLS 1.2"no
max_versionstringMaximum acceptable TLS version for connections."TLS 1.3"no
reload_intervaldurationFrequency to reload the certificates.no
client_ca_filestringPath to the CA file used to authenticate client certificates.no

keepalive block

The keepalive block configures keepalive settings for connections to a gRPC server.

keepalive doesn’t support any arguments and is configured fully through inner blocks.

server_parameters block

The server_parameters block controls keepalive and maximum age settings for gRPC servers.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
max_connection_idledurationMaximum age for idle connections."infinity"no
max_connection_agedurationMaximum age for non-idle connections."infinity"no
max_connection_age_gracedurationTime to wait before forcibly closing connections."infinity"no
timedurationHow often to ping inactive clients to check for liveness."2h"no
timeoutdurationTime to wait before closing inactive clients that do not respond to liveness checks."20s"no

enforcement_policy block

The enforcement_policy block configures the keepalive enforcement policy for gRPC servers. The server will close connections from clients that violate the configured policy.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
min_timedurationMinimum time clients should wait before sending a keepalive ping."5m"no
permit_without_streambooleanAllow clients to send keepalive pings when there are no active streams.falseno

thrift_http block

The thrift_http block configures an HTTP server which can accept Thrift-formatted traces. If the thrift_http block isn’t specified, an HTTP server isn’t started.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
endpointstringhost:port to listen for traffic on."0.0.0.0:14268"no
max_request_body_sizestringMaximum request body size the server will allow. No limit when unset.no
include_metadatabooleanPropagate incoming connection metadata to downstream consumers.no

cors block

The cors block configures CORS settings for an HTTP server.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
allowed_originslist(string)Allowed values for the Origin header.no
allowed_headerslist(string)Accepted headers from CORS requests.["X-Requested-With"]no
max_agenumberConfigures the Access-Control-Max-Age response header.no

The allowed_headers specifies which headers are acceptable from a CORS request. The following headers are always implicitly allowed:

  • Accept
  • Accept-Language
  • Content-Type
  • Content-Language

If allowed_headers includes "*", all headers will be permitted.

thrift_binary block

The thrift_binary block configures a UDP server which can accept traces formatted to the Thrift binary protocol. If the thrift_binary block isn’t provided, a UDP server isn’t started.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
endpointstringhost:port to listen for traffic on."0.0.0.0:6832"no
queue_sizenumberMaximum number of UDP messages that can be queued at once.1000no
max_packet_sizestringMaximum UDP message size."65KiB"no
workersnumberNumber of workers to concurrently read from the message queue.10no
socket_buffer_sizestringBuffer to allocate for the UDP socket.no

thrift_compact block

The thrift_compact block configures a UDP server which can accept traces formatted to the Thrift compact protocol. If the thrift_compact block isn’t provided, a UDP server isn’t started.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
endpointstringhost:port to listen for traffic on."0.0.0.0:6831"no
queue_sizenumberMaximum number of UDP messages that can be queued at once.1000no
max_packet_sizestringMaximum UDP message size."65KiB"no
workersnumberNumber of workers to concurrently read from the message queue.10no
socket_buffer_sizestringBuffer to allocate for the UDP socket.no

output block

The output block configures a set of components to forward resulting telemetry data to.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
metricslist(otelcol.Consumer)List of consumers to send metrics to.[]no
logslist(otelcol.Consumer)List of consumers to send logs to.[]no
traceslist(otelcol.Consumer)List of consumers to send traces to.[]no

The output block must be specified, but all of its arguments are optional. By default, telemetry data is dropped. To send telemetry data to other components, configure the metrics, logs, and traces arguments accordingly.

Exported fields

otelcol.receiver.jaeger does not export any fields.

Component health

otelcol.receiver.jaeger is only reported as unhealthy if given an invalid configuration.

Debug information

otelcol.receiver.jaeger does not expose any component-specific debug information.

Example

This example creates a pipeline which accepts Jaeger-formatted traces and writes them to an OTLP server:

otelcol.receiver.jaeger "default" {
  protocols {
    grpc {}
    thrift_http {}
    thrift_binary {}
    thrift_compact {}
  }

  output {
    traces = [otelcol.processor.batch.default.input]
  }
}

otelcol.processor.batch "default" {
  output {
    traces = [otelcol.exporter.otlp.default.input]
  }
}

otelcol.exporter.otlp "default" {
  client {
    endpoint = "my-otlp-server:4317"
  }
}