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.
You can specify multiple otelcol.receiver.jaeger
components 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
:
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:
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:
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.
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:
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:
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:
cors block
The cors
block configures CORS settings for an HTTP server.
The following arguments are supported:
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:
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:
debug_metrics block
The debug_metrics
block configures the metrics that this component generates to monitor its state.
The following arguments are supported:
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 tootelcol.exporter.*
andotelcol.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:
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:
Technical details
otelcol.receiver.jaeger
supports Gzip for compression.
Enable authentication
You can create a otelcol.receiver.jaeger
component that requires authentication for requests. This is useful for limiting who can push data to the server.
Note
This functionality is currently limited to the GRPC/HTTP blocks.
Note
Not all OpenTelemetry Collector authentication plugins support receiver authentication. Refer to the documentation for eachotelcol.auth.*
component to determine its compatibility.
otelcol.receiver.jaeger "default" {
protocols {
grpc {
auth = otelcol.auth.basic.creds.handler
}
thrift_http {
auth = otelcol.auth.basic.creds.handler
}
}
}
otelcol.auth.basic "creds" {
username = sys.env("USERNAME")
password = sys.env("PASSWORD")
}
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.