Raspberry Pi integration for Grafana Cloud

The Raspberry Pi integration uses the agent to collect metrics related to the operating system (Linux-based), including aspects like CPU usage, load average, memory usage, and disk and networking I/O. It also supports system logs being scraped by the agent using promtail. An accompanying dashboard is provided to visualize these metrics and logs.

This integration includes 8 useful alerts and 1 pre-built dashboard to help monitor and visualize Raspberry Pi metrics and logs.

Before you begin

Each Raspberry Pi node being observed must have its dedicated Grafana Agent running.

Install Raspberry Pi integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find Raspberry Pi and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Raspberry Pi metrics and logs to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard and alerts to your Grafana Cloud instance, and you can start monitoring your Raspberry Pi setup.

Post-install configuration for the Raspberry Pi integration

This integration is configured to work with the node_exporter, which is embedded in Grafana Agent.

Enable the integration by adding the snippets provided to your agent configuration file.

Note: The instance label must uniquely identify the node being scraped. Also, ensure each deployed Grafana Agent has a configuration that matches the node it is deployed to.

This integration supports metrics and logs from Raspberry Pi. If you want to monitor your Raspberry Pi node logs, there are 3 options. You can:

scrape the journal
scrape your OS log files directly
scrape both your journal and OS log files

We recommend that you enable journal scraping because it comes with a unit label that can be used to filter logs on the dashboards. Config snippets for both cases are provided.

If you want to show logs and metrics signals correlated in your dashboards, as a single pane of glass, ensure the following:

job and instance label values must match for node_exporter integration and logs scrape config in your agent configuration file.
job label must be set to integrations/raspberrypi-node (already configured in the snippets).
instance label must be set to a value that uniquely identifies your Linux Node. Please replace the default <your-instance-name> value according to your environment - it should be set manually. Note that if you use localhost for multiple nodes, the dashboards will not be able to filter correctly by instance.

For a full description of configuration options see how to configure the node_exporter_config block in the agent documentation.

Configuration snippets for Grafana Agent

Below integrations, insert the following lines and change the URLs according to your environment:

  node_exporter:
    enabled: true
    relabel_configs:
    - replacement: <your-instance-name>
      target_label: instance
    - replacement: integrations/raspberrypi-node
      target_label: job

Below logs.configs.scrape_configs, insert the following lines according to your environment.

    - job_name: integrations/node_exporter_journal_scrape
      journal:
        max_age: 24h
        labels:
          instance: <your-instance-name>
          job: integrations/raspberrypi-node
      relabel_configs:
      - source_labels: ['__journal__systemd_unit']
        target_label: 'unit'
      - source_labels: ['__journal__boot_id']
        target_label: 'boot_id'
      - source_labels: ['__journal__transport']
        target_label: 'transport'
      - source_labels: ['__journal_priority_keyword']
        target_label: 'level'
    - job_name: integrations/node_exporter_direct_scrape
      static_configs:
      - targets:
        - localhost
        labels:
          instance: hostname
          __path__: /var/log/{syslog,messages,*.log}
          job: integrations/raspberrypi-node

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Raspberry Pi integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

integrations:
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  node_exporter:
    enabled: true
    relabel_configs:
    - replacement: <your-instance-name>
      target_label: instance
    - replacement: integrations/raspberrypi-node
      target_label: job
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
    - job_name: integrations/node_exporter_journal_scrape
      journal:
        max_age: 24h
        labels:
          instance: <your-instance-name>
          job: integrations/raspberrypi-node
      relabel_configs:
      - source_labels: ['__journal__systemd_unit']
        target_label: 'unit'
      - source_labels: ['__journal__boot_id']
        target_label: 'boot_id'
      - source_labels: ['__journal__transport']
        target_label: 'transport'
      - source_labels: ['__journal_priority_keyword']
        target_label: 'level'
    - job_name: integrations/node_exporter_direct_scrape
      static_configs:
      - targets:
        - localhost
        labels:
          instance: hostname
          __path__: /var/log/{syslog,messages,*.log}
          job: integrations/raspberrypi-node
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The Raspberry Pi integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

Node Exporter / Raspberry

Raspberry Pi overview

Raspberry Pi logs

Alerts

The Raspberry Pi integration includes the following useful alerts:

Alert	Description
NodeFilesystemAlmostOutOfSpace	Warning: Filesystem has less than 5% space left.
NodeFilesystemAlmostOutOfSpace	Critical: Filesystem has less than 3% space left.
NodeFilesystemFilesFillingUp	Warning: Filesystem is predicted to run out of inodes within the next 24 hours.
NodeFilesystemFilesFillingUp	Critical: Filesystem is predicted to run out of inodes within the next 4 hours.
NodeFilesystemAlmostOutOfFiles	Warning: Filesystem has less than 5% inodes left.
NodeFilesystemAlmostOutOfFiles	Critical: Filesystem has less than 3% inodes left.
NodeNetworkReceiveErrs	Warning: Network interface is reporting many receive errors.
NodeNetworkTransmitErrs	Warning: Network interface is reporting many transmit errors.

Metrics

The most important metrics provided by the Raspberry Pi integration, which are used on the pre-built dashboard and Prometheus alerts, are as follows:

node_cpu_seconds_total
node_disk_io_time_seconds_total
node_disk_io_time_weighted_seconds_total
node_disk_read_bytes_total
node_disk_written_bytes_total
node_filesystem_avail_bytes
node_filesystem_files
node_filesystem_files_free
node_filesystem_readonly
node_filesystem_size_bytes
node_load1
node_load15
node_load5
node_memory_Buffers_bytes
node_memory_Cached_bytes
node_memory_MemAvailable_bytes
node_memory_MemFree_bytes
node_memory_MemTotal_bytes
node_memory_Slab_bytes
node_network_receive_bytes_total
node_network_receive_drop_total
node_network_receive_errs_total
node_network_receive_packets_total
node_network_transmit_bytes_total
node_network_transmit_drop_total
node_network_transmit_errs_total
node_network_transmit_packets_total
node_uname_info
node_vmstat_pgmajfault

Changelog

# 0.0.1 - September 2022

* Initial release

Cost

By connecting your Raspberry Pi instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.