Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Componentsbreadcrumb arrow otelcolbreadcrumb arrow otelcol.receiver.jaeger
Open source

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.

You can specify multiple otelcol.receiver.jaeger components by giving them different labels.

Usage

Alloy 
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
debug_metricsdebug_metricsConfigures the metrics that this component generates to monitor its state.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 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).

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."4MiB"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 isn’t used for connections to the server.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
ca_filestringPath to the CA file.no
ca_pemstringCA PEM-encoded text to validate the server with.no
cert_filestringPath to the TLS certificate.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
include_system_ca_certs_poolbooleanWhether to load the system certificate authorities pool alongside the certificate authority.falseno
key_filestringPath to the TLS certificate key.no
key_pemsecretKey PEM-encoded text for client authentication.no
max_versionstringMaximum acceptable TLS version for connections."TLS 1.3"no
min_versionstringMinimum acceptable TLS version for connections."TLS 1.2"no
cipher_suiteslist(string)A list of TLS cipher suites that the TLS transport can use.[]no
reload_intervaldurationThe duration after which the certificate is reloaded."0s"no
client_ca_filestringPath to the TLS cert to use by the server to verify a client certificate.no

If reload_interval is set to "0s", the certificate never reloaded.

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_file

If cipher_suites is left blank, a safe default list is used. Refer to the Go Cipher Suites documentation for a list of supported cipher suites.

client_ca_file sets the ClientCA and ClientAuth to RequireAndVerifyClientCert in the TLSConfig. Refer to the Go TLS documentation for more information.

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 don’t respond to liveness checks."20s"no

enforcement_policy block

The enforcement_policy block configures the keepalive enforcement policy for gRPC servers. The server closes 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.20MiBno
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 are 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

debug_metrics block

The debug_metrics block configures the metrics that this component generates to monitor its state.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
disable_high_cardinality_metricsbooleanWhether to disable certain high cardinality metrics.trueno
levelstringControls the level of detail for metrics emitted by the wrapped collector."detailed"no

disable_high_cardinality_metrics is the Grafana Alloy equivalent to the telemetry.disableHighCardinalityMetrics feature gate in the OpenTelemetry Collector. It removes attributes that could cause high cardinality metrics. For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.

Note

If configured, disable_high_cardinality_metrics only applies to otelcol.exporter.* and otelcol.receiver.* components.

level is the Alloy equivalent to the telemetry.metrics.level feature gate in the OpenTelemetry Collector. Possible values are "none", "basic", "normal" and "detailed".

output block

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

The following arguments are supported:

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

You must specify the output block, but all its arguments are optional. By default, telemetry data is dropped. Configure the metrics, logs, and traces arguments accordingly to send telemetry data to other components.

Exported fields

otelcol.receiver.jaeger doesn’t export any fields.

Component health

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

Debug information

otelcol.receiver.jaeger doesn’t expose any component-specific debug information.

Example

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

Alloy 
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"
  }
}

Technical details

otelcol.receiver.jaeger supports Gzip for compression.

Compatible components

otelcol.receiver.jaeger can accept arguments from the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.