This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.
Set up meta-monitoring to collect Alloy telemetry
You can configure Alloy to collect its own telemetry and forward it to the backend of your choosing.
This topic describes how to collect and forward metrics, logs, and traces data from Alloy.
Components and configuration blocks used in this topic
Before you begin
- Identify where to send Alloy’s telemetry data.
- Be familiar with the concept of Components in Alloy.
Meta-monitoring metrics
Alloy exposes its internal metrics using the Prometheus exposition format.
In this task, you will use the prometheus.exporter.self and prometheus.scrape components to scrape Alloy’s internal metrics and forward it to compatible Alloy components.
Add the following
prometheus.exporter.self
component to your configuration. The component accepts no arguments.prometheus.exporter.self "<SELF_LABEL>" { }
Add the following
prometheus.scrape
component to your configuration file.prometheus.scrape "<SCRAPE_LABEL>" { targets = prometheus.exporter.self.<SELF_LABEL>.targets forward_to = [<METRICS_RECEIVER_LIST>] }
Replace the following:
<SELF_LABEL>
: The label for the component such asdefault
ormetamonitoring
. The label must be unique across allprometheus.exporter.self
components in the same configuration file.<SCRAPE_LABEL>
: The label for the scrape component such asdefault
. The label must be unique across allprometheus.scrape
components in the same configuration file.<METRICS_RECEIVER_LIST>
: A comma-delimited list of component receivers to forward metrics to. For example, to send to an existing remote write component, useprometheus.remote_write.WRITE_LABEL.receiver
. Similarly, to send data to an existing relabeling component, useprometheus.relabel.PROCESS_LABEL.receiver
. To use data in the OTLP format, you can send data to an existing converter component, likeotelcol.receiver.prometheus.OTEL.receiver
.
The following example demonstrates configuring a possible sequence of components.
prometheus.exporter.self "default" {
}
prometheus.scrape "metamonitoring" {
targets = prometheus.exporter.self.default.targets
forward_to = [prometheus.remote_write.default.receiver]
}
prometheus.remote_write "default" {
endpoint {
url = "http://mimir:9009/api/v1/push"
}
}
Meta-monitoring logs
The logging block defines the logging behavior of Alloy.
In this task, you will use the logging block to forward Alloy’s logs to a compatible component. The block is specified without a label and can only be provided once per configuration file.
Add the following
logging
configuration block to the top level of your configuration file.logging { level = "<LOG_LEVEL>" format = "<LOG_FORMAT>" write_to = [<LOGS_RECEIVER_LIST>] }
Replace the following:
<LOG_LEVEL>
: The log level to use for Alloy’s logs. If the attribute isn’t set, it defaults toinfo
.<LOG_FORMAT>
: The log format to use for Alloy’s logs. If the attribute isn’t set, it defaults tologfmt
.<LOGS_RECEIVER_LIST>
: A comma-delimited list of component receivers to forward logs to. For example, to send to an existing processing component, useloki.process.PROCESS_LABEL.receiver
. Similarly, to send data to an existing relabeling component, useloki.relabel.PROCESS_LABEL.receiver
. To use data in the OTLP format, you can send data to an existing converter component, likeotelcol.receiver.loki.OTEL.receiver
.
The following example demonstrates configuring the logging block and sending to a compatible component.
logging {
level = "warn"
format = "json"
write_to = [loki.write.default.receiver]
}
loki.write "default" {
endpoint {
url = "http://loki:3100/loki/api/v1/push"
}
}
Meta-monitoring traces
The tracing block defines the tracing behavior of Alloy.
In this task you will use the tracing block to forward Alloy internal traces to a compatible component. The block is specified without a label and can only be provided once per configuration file.
Add the following
tracing
configuration block to the top level of your configuration file.tracing { sampling_fraction = <SAMPLING_FRACTION> write_to = [<TRACES_RECEIVER_LIST>] }
Replace the following:
<SAMPLING_FRACTION>
: The fraction of traces to keep. If the attribute isn’t set, it defaults to0.1
.<TRACES_RECEIVER_LIST>
: A comma-delimited list of component receivers to forward traces to. For example, to send to an existing OpenTelemetry exporter component useotelcol.exporter.otlp.EXPORT_LABEL.input
.
The following example demonstrates configuring the tracing block and sending to a compatible component.
tracing {
sampling_fraction = 0.1
write_to = [otelcol.exporter.otlp.default.input]
}
otelcol.exporter.otlp "default" {
client {
endpoint = "tempo:4317"
}
}