Grafana Alloy

https://grafana.com/docs/alloy/latest/
Admin
Grafana Alloy is an OpenTelemetry Collector distribution with Prometheus pipelines for collecting...
Tokens:750,566
Snippets:5,800
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Silent install with custom config and directory

Source: https://grafana.com/docs/alloy/latest/set-up/install/windows

Example silent install with a custom configuration file and installation directory. The /D option must be the last argument and must not be quoted.

```cmd
<PATH>\alloy-installer-windows-amd64.exe /S /CONFIG=C:\alloy\config.alloy /D=C:\GrafanaLabs\Alloy
```

--------------------------------

### Example: loki.source.api with loki.write

Source: https://grafana.com/docs/alloy/latest/reference/components/loki/loki.source.api

This example starts an HTTP server on 0.0.0.0:9999, receives log entries, adds a 'forwarded="true"' label, and forwards them to a loki.write component. The loki.write component sends logs to a Loki instance using basic auth. Replace <USERNAME> and <PASSWORD_FILE> with your credentials.

```alloy
loki.write "local" {
    endpoint {
        url = "http://loki:3100/api/v1/push"
        basic_auth {
            username = "<USERNAME>"
            password_file = "<PASSWORD_FILE>"
        }
    }
}

loki.source.api "loki_push_api" {
    http {
        listen_address = "0.0.0.0"
        listen_port = 9999
    }
    forward_to = [
        loki.write.local.receiver,
    ]
    labels = {
        forwarded = "true",
    }
}
```

--------------------------------

### Deploy the Grafana stack with Docker Compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-logs-from-file

Navigate to the logs-file example directory and start the Grafana stack using Docker Compose.

```shell
cd alloy-scenarios/logs-file
docker compose up -d
```

--------------------------------

### Start Alloy with brew services

Source: https://grafana.com/docs/alloy/latest/set-up/run/macos

Starts the Alloy launchd service on macOS. Alloy automatically runs when the system starts.

```shell
brew services start grafana/grafana/alloy
```

--------------------------------

### string.trim_prefix example

Source: https://grafana.com/docs/alloy/latest/reference/stdlib/string

Removes the specified prefix from the start of a string. If the string does not start with the prefix, it is returned unchanged.

```alloy
> string.trim_prefix("helloworld", "hello")
"world"
```

--------------------------------

### Create directory and files for Alloy tutorial

Source: https://grafana.com/docs/alloy/latest/tutorials/send-logs-to-loki

Creates a directory named alloy-tutorial, changes into it, and creates an empty docker-compose.yml file.

```bash
mkdir alloy-tutorial
cd alloy-tutorial
touch docker-compose.yml
```

--------------------------------

### Start the Grafana stack with docker compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-docker-containers

Starts the Docker containers for the Grafana stack in the docker-monitoring example.

```shell
cd alloy-scenarios/docker-monitoring
docker compose up -d
```

--------------------------------

### Navigate to the Kubernetes logs example directory

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-kubernetes-logs

Changes to the directory containing the Kubernetes logs example configuration files.

```shell
cd alloy-scenarios/k8s/logs
```

--------------------------------

### Run Alloy and verify startup logs

Source: https://grafana.com/docs/alloy/latest/collect/opentelemetry-to-lgtm-stack

Run the Alloy configuration with `./alloy run alloy-config.alloy` and observe the expected startup logs. The logs show successful component evaluation, WAL replay, and OTLP receivers listening on 0.0.0.0:4317 (gRPC) and 0.0.0.0:4318 (HTTP).

```plaintext
./alloy run alloy-config.alloy
```

```plaintext
ts=2023-05-09T09:37:15.300959Z level=info msg="running usage stats reporter"
ts=2023-05-09T09:37:15.300958Z level=info msg="now listening for http traffic" addr=127.0.0.1:12345
ts=2023-05-09T09:37:15.301104Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="starting complete graph evaluation"
ts=2023-05-09T09:37:15.301307Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=loki.write.grafana_cloud_logs duration=188.209µs
ts=2023-05-09T09:37:15.301334Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.exporter.loki.grafana_cloud_logs duration=18.791µs
ts=2023-05-09T09:37:15.303138Z component=prometheus.remote_write.grafana_cloud_metrics level=info subcomponent=wal msg="replaying WAL, this may take a while" dir=data-alloy/prometheus.remote_write.grafana_cloud_metrics/wal
ts=2023-05-09T09:37:15.303257Z component=prometheus.remote_write.grafana_cloud_metrics level=info subcomponent=wal msg="WAL segment loaded" segment=0 maxSegment=1
ts=2023-05-09T09:37:15.303302Z component=prometheus.remote_write.grafana_cloud_metrics level=info subcomponent=wal msg="WAL segment loaded" segment=1 maxSegment=1
ts=2023-05-09T09:37:15.303507Z component=prometheus.remote_write.grafana_cloud_metrics subcomponent=rw level=info remote_name=7f623a url=https://prometheus-us-central1.grafana.net/api/prom/push msg="Starting WAL watcher" queue=7f623a
ts=2023-05-09T09:37:15.303515Z component=prometheus.remote_write.grafana_cloud_metrics subcomponent=rw level=info remote_name=7f623a url=https://prometheus-us-central1.grafana.net/api/prom/push msg="Starting scraped metadata watcher"
ts=2023-05-09T09:37:15.303522Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=prometheus.remote_write.grafana_cloud_metrics duration=2.181958ms
ts=2023-05-09T09:37:15.303557Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.exporter.prometheus.grafana_cloud_metrics duration=30.083µs
ts=2023-05-09T09:37:15.303611Z component=prometheus.remote_write.grafana_cloud_metrics subcomponent=rw level=info remote_name=7f623a url=https://prometheus-us-central1.grafana.net/api/prom/push msg="Replaying WAL" queue=7f623a
ts=2023-05-09T09:37:15.303618Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.auth.basic.grafana_cloud_traces duration=52.5µs
ts=2023-05-09T09:37:15.303694Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.exporter.otlphttp.grafana_cloud_traces duration=70.375µs
ts=2023-05-09T09:37:15.303782Z component=otelcol.processor.memory_limiter.default level=info msg="Memory limiter configured" limit_mib=150 spike_limit_mib=30 check_interval=1s
ts=2023-05-09T09:37:15.303802Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.processor.memory_limiter.default duration=100.334µs
ts=2023-05-09T09:37:15.303853Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.processor.batch.default duration=44.75µs
ts=2023-05-09T09:37:15.303948Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=otelcol.receiver.otlp.default duration=87.333µs
ts=2023-05-09T09:37:15.303968Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=tracing duration=10.792µs
ts=2023-05-09T09:37:15.303981Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished node evaluation" node_id=logging duration=9µs
ts=2023-05-09T09:37:15.303987Z level=info trace_id=6466516c9e1a556422df7a84c0ade6b0 msg="finished complete graph evaluation" duration=2.960333ms
ts=2023-05-09T09:37:15.304Z level=info msg="scheduling loaded components"
ts=2023-05-09T09:37:15.304109Z component=otelcol.receiver.otlp.default level=info msg="Starting GRPC server" endpoint=0.0.0.0:4317
ts=2023-05-09T09:37:15.304234Z component=otelcol.receiver.otlp.default level=info msg="Starting HTTP server" endpoint=0.0.0.0:4318
```

--------------------------------

### Start the Grafana stack with Docker Compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-windows

Changes to the windows example directory and starts the Grafana stack in detached mode using Docker Compose.

```shell
cd alloy-scenarios/windows
docker compose up -d
```

--------------------------------

### string.trim_space example

Source: https://grafana.com/docs/alloy/latest/reference/stdlib/string

Removes any whitespace characters from the start and end of a string.

```alloy
> string.trim_space("  hello\n\n")
"hello"
```

--------------------------------

### Create a log file with sample content

Source: https://grafana.com/docs/alloy/latest/tutorials/logs-and-relabeling-basics

Use the echo command to create a directory and a log file with sample content for the pipeline to scrape.

```bash
mkdir -p /tmp/alloy-logs
echo "This is a log line" > /tmp/alloy-logs/log.log
```

--------------------------------

### Clone the Alloy scenarios repository

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-logs-from-file

Clone the alloy-scenarios repository from GitHub to get the example deployment.

```shell
git clone https://github.com/grafana/alloy-scenarios.git
```

--------------------------------

### Deploy Grafana Tempo to the prod namespace

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-kubernetes-logs

Installs Grafana Tempo in the prod namespace to generate logs for the example.

```shell
helm install tempo grafana/tempo-distributed -n prod
```

--------------------------------

### Example: collect static metrics with prometheus.scrape and remote_write

Source: https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.static

Complete example that configures prometheus.exporter.static with sample metrics in Prometheus exposition format, then uses prometheus.scrape to collect them and prometheus.remote_write to forward them. Replace the placeholders <PROMETHEUS_REMOTE_WRITE_URL>, <USERNAME>, and <PASSWORD> with actual values.

```alloy
prometheus.exporter.static "demo" {
    text = `
# HELP http_requests_total The total number of HTTP requests.
# TYPE http_requests_total counter
http_requests_total{method="post",code="200"} 1027
http_requests_total{method="post",code="400"}    3

# HELP http_request_duration_seconds A histogram of the request duration.
# TYPE http_request_duration_seconds histogram
http_request_duration_seconds_bucket{le="0.05"} 24054
http_request_duration_seconds_bucket{le="0.1"} 33444
http_request_duration_seconds_bucket{le="0.2"} 100392
http_request_duration_seconds_bucket{le="0.5"} 129389
http_request_duration_seconds_bucket{le="1"} 133988
http_request_duration_seconds_bucket{le="+Inf"} 144320
http_request_duration_seconds_sum 53423
http_request_duration_seconds_count 144320
    `
}

// Configure a prometheus.scrape component to collect static metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.static.demo.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```

--------------------------------

### Example with prometheus.scrape and remote_write

Source: https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.dnsmasq

Complete example that configures prometheus.exporter.dnsmasq, a prometheus.scrape component to collect metrics, and a prometheus.remote_write component to send them to a remote_write compatible server. Replace the placeholders with actual values.

```alloy
prometheus.exporter.dnsmasq "example" {
  address = "localhost:53"
}

// Configure a prometheus.scrape component to collect github metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.dnsmasq.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```

--------------------------------

### Deploy the Grafana stack with Docker Compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-syslog-messages

Changes to the syslog example directory and starts the Grafana stack in detached mode using Docker Compose.

```shell
cd alloy-scenarios/syslog
docker compose up -d
```

--------------------------------

### Configure discovery.gce with prometheus.scrape and prometheus.remote_write

Source: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.gce

This example sets up discovery.gce to discover GCE instances in a specified project and zone, then scrapes them with prometheus.scrape and forwards metrics to a remote_write endpoint. Replace the placeholders <PROMETHEUS_REMOTE_WRITE_URL>, <USERNAME>, and <PASSWORD> with your actual values.

```alloy
discovery.gce "gce" {
  project = "alloy"
  zone    = "us-east1-a"
}

prometheus.scrape "demo" {
  targets    = discovery.gce.gce.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```

--------------------------------

### Deploy the Grafana stack with Docker Compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-logs-over-tcp

Navigates to the logs-tcp example directory and starts the Grafana stack in detached mode using Docker Compose.

```shell
cd alloy-scenarios/logs-tcp
docker compose up -d
```

--------------------------------

### Deploy the Grafana stack with Docker Compose

Source: https://grafana.com/docs/alloy/latest/monitor/monitor-structured-logs

Starts the Docker containers for the Grafana stack in the mail-house example. Run this command from the cloned repository directory.

```shell
cd alloy-scenarios/mail-house
docker compose up -d
```

--------------------------------

### Example: discovery.aws with prometheus.scrape and prometheus.remote_write

Source: https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.aws

Use this example to configure discovery.aws to discover ECS resources in a specific region and scrape them with prometheus.scrape, forwarding metrics to a remote_write endpoint. Replace the placeholders <PROMETHEUS_REMOTE_WRITE_URL>, <USERNAME>, and <PASSWORD> with your actual values.

```alloy
discovery.aws "ecs" {
  role   = "ecs"
  region = "us-east-1"
}

prometheus.scrape "demo" {
  targets    = discovery.aws.ecs.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```

--------------------------------

### Promtail configuration file for basic example

Source: https://grafana.com/docs/alloy/latest/set-up/migrate/from-promtail

This YAML configuration is the input for the conversion example. It defines a client that pushes logs to a Loki endpoint and a scrape config that reads log files from /var/log/*.log.

```yaml
clients:
  - url: http://localhost/loki/api/v1/push
scrape_configs:
  - job_name: example
    static_configs:
      - targets:
          - localhost
        labels:
          __path__: /var/log/*.log

```

--------------------------------

### Example: scrape Alloy metrics with prometheus.scrape and remote_write

Source: https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.self

Shows a complete setup where prometheus.exporter.self exports targets to a prometheus.scrape component, which forwards to prometheus.remote_write. Replace the placeholders with actual values.

```alloy
prometheus.exporter.self "example" {}

// Configure a prometheus.scrape component to collect Alloy metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.self.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```

--------------------------------

### Example logging block with level and format

Source: https://grafana.com/docs/alloy/latest/reference/config-blocks/logging

Example logging block that sets the level to "info" and format to "logfmt".

```alloy
logging {
  level  = "info"
  format = "logfmt"
}
```

--------------------------------

### Basic loki.source.podlogs example

Source: https://grafana.com/docs/alloy/latest/reference/components/loki/loki.source.podlogs

Discovers all PodLogs resources and forwards logs to a loki.write component. The loki.write component sends logs to the URL specified by the LOKI_URL environment variable.

```alloy
loki.source.podlogs "default" {
  forward_to = [loki.write.local.receiver]
}

loki.write "local" {
  endpoint {
    url = sys.env("LOKI_URL")
  }
}
```

--------------------------------

### Collect metrics using an embedded configuration

Source: https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.blackbox

Uses an embedded configuration string instead of a config_file. The rest of the setup is identical to the config_file example, including the prometheus.scrape and prometheus.remote_write components.

```alloy
prometheus.exporter.blackbox "example" {
  config = "{ modules: { http_2xx: { prober: http, timeout: 5s } } }"

  target {
    name    = "example"
    address = "https://example.com"
    module  = "http_2xx"
  }

  target {
    name    = "grafana"
    address = "https://grafana.com"
    module  = "http_2xx"
    labels  = {
      "env" = "dev",
    }
  }
}

// Configure a prometheus.scrape component to collect blackbox metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.blackbox.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}
```
Tokens:
Raw