Documentation Grafana Agent Flow mode Reference Components reference otelcol.receiver.otlp

otelcol.receiver.otlp

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

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

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

Usage

river Copy

otelcol.receiver.otlp "LABEL" {
  grpc { ... }
  http { ... }

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

Arguments

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

Blocks

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

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

grpc block

The grpc block configures the gRPC server used by the component. 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 won’t be used for connections to the server.

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 will close connections from clients that violate the configured policy.

The following arguments are supported:

http block

The http block configures the HTTP server used by the component. If the http block isn’t specified, an HTTP server isn’t started.

The following arguments are supported:

To send telemetry signals to otelcol.receiver.otlp with HTTP/JSON, POST to:

• [endpoint][traces_url_path] for traces.
• [endpoint][metrics_url_path] for metrics.
• [endpoint][logs_url_path] for logs.

cors block

The cors block configures CORS settings for an HTTP server.

The following arguments are supported:

The allowed_headers argument 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.

debug_metrics block

output block

Exported fields

otelcol.receiver.otlp does not export any fields.

Component health

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

Debug information

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

Debug metrics

• receiver_accepted_spans_ratio_total (counter): Number of spans successfully pushed into the pipeline.
• receiver_refused_spans_ratio_total (counter): Number of spans that could not be pushed into the pipeline.
• rpc_server_duration_milliseconds (histogram): Duration of RPC requests from a gRPC server.
• rpc_server_request_size_bytes (histogram): Measures size of RPC request messages (uncompressed).
• rpc_server_requests_per_rpc (histogram): Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs.
• rpc_server_response_size_bytes (histogram): Measures size of RPC response messages (uncompressed).
• rpc_server_responses_per_rpc (histogram): Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs.

Example

This example forwards received telemetry data through a batch processor before finally sending it to an OTLP-capable endpoint:

river Copy

otelcol.receiver.otlp "default" {
  http {}
  grpc {}

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

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

otelcol.exporter.otlp "default" {
  client {
    endpoint = env("OTLP_ENDPOINT")
  }
}

Technical details

otelcol.receiver.otlp supports gzip for compression.

Compatible components

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

• Components that export OpenTelemetry otelcol.Consumer