Documentation Grafana Cloud Instrument and send data Grafana Alloy Reference Components otelcol otelcol.receiver.prometheus

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. To enable and use a public preview component, you must set the stability.level flag to public-preview or below.

otelcol.receiver.prometheus receives Prometheus metrics, converts them to the OpenTelemetry metrics format, and forwards them to other otelcol.* components.

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

Usage

alloy Copy

otelcol.receiver.prometheus "<LABEL>" {
  output {
    metrics = [...]
  }
}

Arguments

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

Blocks

You can use the following block with otelcol.receiver.prometheus:

output

Required

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

The following fields are exported and can be referenced by other components:

Component health

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

Debug information

otelcol.receiver.prometheus doesn’t 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’re forwarded to the otelcol.exporter.otlp component to be sent to an OTLP-capable endpoint:

alloy Copy

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