ZFS

Ship your ZFS Metrics via Telegraf to your Logit.io Stack

Follow the steps below to send your observability data to Logit.io

Metrics

Configure Telegraf to ship ZFS metrics to your Logit.io stacks.

Install Integration

Please click on the Install Integration button to configure your stack for this source.

Install Telegraf

This integration allows you to configure a Telegraf agent to send your metrics to Logit.io.

Choose the installation method for your operating system:

Debian and Ubuntu users can install the latest stable version of Telegraf using the apt package manager.

The command line below will:

  • Download and install repository signing key
  • Configure the influxdata repository
  • Install telegraf
curl --silent --location -O \
https://repos.influxdata.com/influxdata-archive.key \
&& echo "943666881a1b8d9b849b74caebf02d3465d6beb716510d86a39f6c8e8dac7515  influxdata-archive.key" \
| sha256sum -c - && cat influxdata-archive.key \
| gpg --dearmor \
| sudo tee /etc/apt/trusted.gpg.d/influxdata-archive.gpg > /dev/null \
&& echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive.gpg] https://repos.influxdata.com/debian stable main' \
| sudo tee /etc/apt/sources.list.d/influxdata.list
sudo apt-get update && sudo apt-get install telegraf

The default configuration file is location at:
/etc/telegraf/telegraf.conf

Configure the Telegraf input plugin

The configuration file below is pre-configured to scrape the system metrics from your hosts, add the following code to the configuration file telegraf.conf from the previous step.

telegraf.conf
# Read metrics of ZFS from arcstats, zfetchstats, vdev_cache_stats, pools and datasets
# This plugin ONLY supports Linux & FreeBSD
[[inputs.zfs]]
  ## ZFS kstat path. Ignored on FreeBSD
  ## If not specified, then default is:
  # kstatPath = "/proc/spl/kstat/zfs"
 
  ## By default, telegraf gather all zfs stats
  ## Override the stats list using the kstatMetrics array:
  ## For FreeBSD, the default is:
  # kstatMetrics = ["arcstats", "zfetchstats", "vdev_cache_stats"]
  ## For Linux, the default is:
  # kstatMetrics = ["abdstats", "arcstats", "dnodestats", "dbufcachestats",
  #     "dmu_tx", "fm", "vdev_mirror_stats", "zfetchstats", "zil"]
 
  ## By default, don't gather zpool stats
  # poolMetrics = false
 
  ## By default, don't gather dataset stats
  # datasetMetrics = false
 
### System metrics
[[inputs.disk]]
[[inputs.net]]
[[inputs.mem]]
[[inputs.system]]
[[inputs.cpu]]
  percpu = false
  totalcpu = true
  collect_cpu_time = true
  report_active = true
 
### Output
[[outputs.http]]
  url = "https://@metricsUsername:@metricsPassword@@metrics_id-vm.logit.io:@vmAgentPort/api/v1/write"
  data_format = "prometheusremotewrite"
 
  [outputs.http.headers]
    Content-Type = "application/x-protobuf"
    Content-Encoding = "snappy"

Read more about how to configure data scraping and configuration options for ZFS (opens in a new tab)

Start Telegraf

For systemd installations use systemctl to start telegraf

sudo systemctl start telegraf

Launch Grafana to View Your Data

Launch Grafana

How to diagnose no data in Stack

If you don't see data appearing in your stack after following this integration, take a look at the troubleshooting guide for steps to diagnose and resolve the problem or contact our support team and we'll be happy to assist.

Telegraf ZFS Overview

In order to effectively monitor and analyze ZFS metrics across a distributed environment, it's essential to employ a comprehensive and efficient metrics management solution. Telegraf, an open-source server agent for collecting and sending telemetry data, fits this requirement perfectly, able to gather ZFS metrics from a variety of sources including operational ZFS instances, databases, and other associated applications.

Telegraf's extensive selection of input plugins enables users to collect metrics from diverse sources such as CPU usage, memory utilization, disk I/O, and more, all of which can be vital for understanding ZFS performance. To store and scrutinize these collected metrics, organizations can utilize Prometheus, an open-source monitoring and alerting tool known for its flexible querying language and powerful data visualization capabilities.

To convey ZFS metrics from Telegraf to Prometheus, organizations must configure Telegraf to output metrics in Prometheus format, then establish Prometheus to scrape these metrics from the Telegraf server. This procedure includes setting up Telegraf to gather ZFS metrics, outputting them in Prometheus format, configuring Prometheus to fetch these metrics from the Telegraf server, and subsequently interpreting the data through Prometheus's robust querying and visualization tools.

Upon successful integration of the metrics into Prometheus, further analysis and visualization can be carried out using Grafana. Grafana, an open-source software recognized for its monitoring and observability capabilities, is fully compatible with Prometheus. It empowers users to design dynamic, interactive dashboards for a deeper exploration of metrics data, delivering a comprehensive understanding of performance trends and potential bottlenecks in the ZFS system.

If you need any further assistance with shipping your log data to Logit.io we're here to help you get started. Feel free to get in contact with our support team by sending us a message via live chat & we'll be happy to assist.