This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.
otelcol.receiver.prometheus
Public preview: This is a public preview component. Public preview components are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case. The
stability.level
flag must be set topublic-preview
or below to use the component.
otelcol.receiver.prometheus
receives Prometheus metrics, converts them to the
OpenTelemetry metrics format, and forwards them to other otelcol.*
components.
Multiple otelcol.receiver.prometheus
components can be specified by giving them
different labels.
Usage
otelcol.receiver.prometheus "LABEL" {
output {
metrics = [...]
}
}
Arguments
otelcol.receiver.prometheus
doesn’t support any arguments and is configured fully
through inner blocks.
Blocks
The following blocks are supported inside the definition of
otelcol.receiver.prometheus
:
Hierarchy | Block | Description | Required |
---|---|---|---|
output | output | Configures where to send received telemetry data. | yes |
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
The following fields are exported and can be referenced by other components:
Name | Type | Description |
---|---|---|
receiver | MetricsReceiver | A value that other components can use to send Prometheus metrics to. |
Component health
otelcol.receiver.prometheus
is only reported as unhealthy if given an invalid
configuration.
Debug information
otelcol.receiver.prometheus
does not expose any component-specific debug
information.
Example
This example uses the otelcol.receiver.prometheus
component as a bridge
between the Prometheus and OpenTelemetry ecosystems. The component exposes a
receiver which the prometheus.scrape
component uses to send Prometheus metric
data to. The metrics are converted to the OTLP format before they are forwarded
to the otelcol.exporter.otlp
component to be sent to an OTLP-capable
endpoint:
prometheus.scrape "default" {
// Collect metrics from the default HTTP listen address.
targets = [{"__address__" = "127.0.0.1:12345"}]
forward_to = [otelcol.receiver.prometheus.default.receiver]
}
otelcol.receiver.prometheus "default" {
output {
metrics = [otelcol.exporter.otlp.default.input]
}
}
otelcol.exporter.otlp "default" {
client {
endpoint = sys.env("OTLP_ENDPOINT")
}
}
Compatible components
otelcol.receiver.prometheus
can accept arguments from the following components:
- Components that export OpenTelemetry
otelcol.Consumer
otelcol.receiver.prometheus
has exports that can be consumed by the following components:
- Components that consume Prometheus
MetricsReceiver
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.