Documentation Grafana Alloy Reference Components otelcol otelcol.receiver.jaeger

otelcol.receiver.jaeger

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

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

Usage

Alloy Copy

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

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

Arguments

The otelcol.receiver.jaeger component doesn’t support any arguments. You can configure this component with blocks.

Blocks

You can use the following blocks with otelcol.receiver.jaeger:

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

output

protocols

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

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

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.

tpm

The tpm block configures retrieving the TLS key_file from a trusted device.

The following arguments are supported:

Expand table

Name	Type	Description	Default	Required
auth	string	The authorization value used to authenticate the TPM device.	""	no
enabled	bool	Load the tls.key_file from TPM.	false	no
owner_auth	string	The owner authorization value used to authenticate the TPM device.	""	no
path	string	Path to the TPM device or Unix domain socket.	""	no

The trusted platform module (TPM) configuration can be used for loading TLS key from TPM. Currently only TSS2 format is supported.

The path attribute is not supported on Windows.

Example

Alloy Copy

otelcol.example.component "<LABEL>" {
    ...
    tls {
        ...
        key_file = "my-tss2-key.key"
        tpm {
            enabled = true
            path = "/dev/tpmrm0"
        }
    }
}

In the above example, the private key my-tss2-key.key in TSS2 format will be loaded from the TPM device /dev/tmprm0.

keepalive

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

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

The following arguments are supported:

enforcement_policy

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

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

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

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

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

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 Copy

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.

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.

Alloy Copy

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