Caution
Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.
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.
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 Collectorjaeger
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
:
Hierarchy | Block | Description | Required |
---|---|---|---|
protocols | protocols | Configures the protocols the component can accept traffic over. | yes |
protocols > grpc | grpc | Configures a Jaeger gRPC server to receive traces. | no |
protocols > grpc > tls | tls | Configures TLS for the gRPC server. | no |
protocols > grpc > keepalive | keepalive | Configures keepalive settings for the configured server. | no |
protocols > grpc > keepalive > server_parameters | server_parameters | Server parameters used to configure keepalive settings. | no |
protocols > grpc > keepalive > enforcement_policy | enforcement_policy | Enforcement policy for keepalive settings. | no |
protocols > thrift_http | thrift_http | Configures a Thrift HTTP server to receive traces. | no |
protocols > thrift_http > tls | tls | Configures TLS for the Thrift HTTP server. | no |
protocols > thrift_http > cors | cors | Configures CORS for the Thrift HTTP server. | no |
protocols > thrift_binary | thrift_binary | Configures a Thrift binary UDP server to receive traces. | no |
protocols > thrift_compact | thrift_compact | Configures a Thrift compact UDP server to receive traces. | no |
debug_metrics | debug_metrics | Configures the metrics that this component generates to monitor its state. | no |
output | output | Configures 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
endpoint | string | host:port to listen for traffic on. | "0.0.0.0:14250" | no |
transport | string | Transport to use for the gRPC server. | "tcp" | no |
max_recv_msg_size | string | Maximum size of messages the server will accept. 0 disables a limit. | no | |
max_concurrent_streams | number | Limit the number of concurrent streaming RPC calls. | no | |
read_buffer_size | string | Size of the read buffer the gRPC server will use for reading from clients. | "512KiB" | no |
write_buffer_size | string | Size of the write buffer the gRPC server will use for writing to clients. | no | |
include_metadata | boolean | Propagate 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
ca_file | string | Path to the CA file. | no | |
ca_pem | string | CA PEM-encoded text to validate the server with. | no | |
cert_file | string | Path to the TLS certificate. | no | |
cert_pem | string | Certificate PEM-encoded text for client authentication. | no | |
insecure_skip_verify | boolean | Ignores insecure server TLS certificates. | no | |
include_system_ca_certs_pool | boolean | Whether to load the system certificate authorities pool alongside the certificate authority. | false | no |
insecure | boolean | Disables TLS when connecting to the configured server. | no | |
key_file | string | Path to the TLS certificate key. | no | |
key_pem | secret | Key PEM-encoded text for client authentication. | no | |
max_version | string | Maximum acceptable TLS version for connections. | "TLS 1.3" | no |
min_version | string | Minimum acceptable TLS version for connections. | "TLS 1.2" | no |
cipher_suites | list(string) | A list of TLS cipher suites that the TLS transport can use. | [] | no |
reload_interval | duration | The duration after which the certificate is reloaded. | "0s" | no |
server_name | string | Verifies the hostname of server certificates when set. | no |
If the server doesn’t support TLS, you must set the insecure
argument to true
.
To disable tls
for connections to the server, set the insecure
argument to true
.
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
andca_file
cert_pem
andcert_file
key_pem
andkey_file
If cipher_suites
is left blank, a safe default list is used.
See the Go TLS documentation for a list of supported cipher suites.
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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
max_connection_idle | duration | Maximum age for idle connections. | "infinity" | no |
max_connection_age | duration | Maximum age for non-idle connections. | "infinity" | no |
max_connection_age_grace | duration | Time to wait before forcibly closing connections. | "infinity" | no |
time | duration | How often to ping inactive clients to check for liveness. | "2h" | no |
timeout | duration | Time 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
min_time | duration | Minimum time clients should wait before sending a keepalive ping. | "5m" | no |
permit_without_stream | boolean | Allow clients to send keepalive pings when there are no active streams. | false | no |
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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
endpoint | string | host:port to listen for traffic on. | "0.0.0.0:14268" | no |
max_request_body_size | string | Maximum request body size the server will allow. | 20MiB | no |
include_metadata | boolean | Propagate incoming connection metadata to downstream consumers. | no |
cors block
The cors
block configures CORS settings for an HTTP server.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
allowed_origins | list(string) | Allowed values for the Origin header. | no | |
allowed_headers | list(string) | Accepted headers from CORS requests. | ["X-Requested-With"] | no |
max_age | number | Configures 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
endpoint | string | host:port to listen for traffic on. | "0.0.0.0:6832" | no |
queue_size | number | Maximum number of UDP messages that can be queued at once. | 1000 | no |
max_packet_size | string | Maximum UDP message size. | "65KiB" | no |
workers | number | Number of workers to concurrently read from the message queue. | 10 | no |
socket_buffer_size | string | Buffer 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
endpoint | string | host:port to listen for traffic on. | "0.0.0.0:6831" | no |
queue_size | number | Maximum number of UDP messages that can be queued at once. | 1000 | no |
max_packet_size | string | Maximum UDP message size. | "65KiB" | no |
workers | number | Number of workers to concurrently read from the message queue. | 10 | no |
socket_buffer_size | string | Buffer 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:
Name | Type | Description | Default | Required |
---|---|---|---|---|
disable_high_cardinality_metrics | boolean | Whether to disable certain high cardinality metrics. | true | no |
disable_high_cardinality_metrics
is the Grafana Agent 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.
output block
The output
block configures a set of components to forward resulting telemetry data to.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
logs | list(otelcol.Consumer) | List of consumers to send logs to. | [] | no |
metrics | list(otelcol.Consumer) | List of consumers to send metrics to. | [] | no |
traces | list(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
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"
}
}
Technical details
otelcol.receiver.jaeger
supports gzip for compression.
Compatible components
otelcol.receiver.jaeger
can accept arguments from the following components:
- Components that export OpenTelemetry
otelcol.Consumer
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.