Grafana Dashboard

A pre-built Grafana dashboard is included for monitoring the bouncer and router health.

Screenshots

Dark theme:

Light theme:

Prerequisites

Before importing the dashboard, you need:

1. A running Grafana instance (v9.0+ recommended)
2. A running Prometheus instance scraping the bouncer
3. The bouncer running with metrics.enabled: true

Setup Guide

1. Configure the Bouncer for Metrics

Enable Prometheus metrics in your bouncer configuration:

config.yaml

metrics:
  enabled: true
  listen_addr: "0.0.0.0"
  listen_port: 2112
  routeros_poll_interval: 30s # Enables RouterOS system metrics

Verify the metrics endpoint is working:

curl -s http://<bouncer-host>:2112/metrics | head -20

2. Configure Prometheus to Scrape the Bouncer

Add a scrape job to your Prometheus configuration:

prometheus.yml

scrape_configs:
  - job_name: "cs-routeros-bouncer"
    static_configs:
      - targets: ["<bouncer-host>:2112"]
    scrape_interval: 15s

Replace <bouncer-host> with the IP or hostname where the bouncer is running.

Tip

If the bouncer runs on the same host as Prometheus, use localhost:2112. For Docker setups, use the container name or network IP.

After adding the scrape config, reload Prometheus:

# Reload via HTTP (if --web.enable-lifecycle is set)
curl -X POST http://localhost:9090/-/reload

# Or restart Prometheus
systemctl restart prometheus

Verify the target is healthy in Prometheus UI: Status → Targets — the cs-routeros-bouncer target should show UP.

3. Add Prometheus Data Source in Grafana

1. Open Data Sources

   In Grafana, navigate to Connections → Data sources → Add data source.

2. Select Prometheus

   Choose Prometheus from the list.

3. Configure the connection

   Set the Prometheus server URL to your Prometheus instance (e.g., http://localhost:9090 or http://prometheus:9090 for Docker).

4. Save & Test

   Click Save & Test — you should see “Successfully queried the Prometheus API.”

4. Import the Dashboard

1. Open Grafana import

   Navigate to Dashboards → New → Import.

2. Upload the dashboard JSON

   Upload grafana/dashboard.json from the repository.

3. Select Prometheus data source

   Choose the Prometheus data source you configured in step 3.

4. Click Import

   The dashboard will be created and immediately display data.

Note

If panels show “No data”, verify: (1) Prometheus is scraping the bouncer successfully, (2) the correct data source is selected, and (3) the bouncer has been running long enough to generate metrics.

Dashboard Panels

The dashboard is organized into the following sections:

| Section | Panels | | ---------------------------- | ------------------------------------------------------------------------------------------- | | Overview | RouterOS Connected, Active Decisions (IPv4/IPv6/Total), Uptime, Bouncer Info | | Active Decisions | Active Decisions Over Time, IPv4/IPv6 Ratio | | Decision Processing | Decisions Processed (Rate), Cumulative Decisions | | Performance & Operations | Operation Latency (p50/p95/p99), Operation Rate | | Errors & Reconciliation | Error Rate, Total Errors, RouterOS Connection, Last Reconciliation, Reconciliation Duration | | Dropped Traffic | Dropped Bytes, Dropped Packets, Dropped Traffic Rate, Dropped Traffic (Cumulative) | | Processed Traffic | Processed Traffic Rate (Bytes/s, Packets/s), Drop Rate % | | Decisions by Origin | Active Decisions by Origin, Decisions by Origin (Rate), Cumulative by Origin | | RouterOS | RouterOS Info, RouterOS Uptime, Router CPU, Router Memory, Router Temperature | | Configuration | Current bouncer configuration parameters | | Process Resources | Memory Usage, CPU Usage, Goroutines & File Descriptors |

Tip

Use the time range selector to zoom into specific events. The “Decisions Processed” panel is useful for correlating ban spikes with specific incidents.

Related

Prometheus Metrics Full reference of all exported metrics

Health Endpoint HTTP health check for uptime monitoring