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 Collectorotlp
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
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.
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 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
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.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
otelcol_receiver_accepted_spans_total
(counter): Number of spans successfully pushed into the pipeline.otelcol_receiver_refused_spans_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:
Technical details
otelcol.receiver.otlp
supports gzip for compression.
Enable authentication
You can create a otelcol.reciever.otlp
component that requires authentication for requests. This is useful for limiting who can push data to the server.
Note
Not all OpenTelemetry Collector authentication plugins support receiver authentication. Refer to the documentation for eachotelcol.auth.*
component to determine its compatibility.
otelcol.receiver.otlp "default" {
http {
auth = otelcol.auth.basic.creds.handler
}
grpc {
auth = otelcol.auth.basic.creds.handler
}
output {
...
}
}
otelcol.auth.basic "creds" {
username = sys.env("USERNAME")
password = sys.env("PASSWORD")
}
Compatible components
otelcol.receiver.otlp
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.