datadog-smartd 0.1.5

The smartd check

smartd

Overview

This integration monitors S.M.A.R.T. disk health by reading state files written by the smartd daemon (part of smartmontools). It collects key disk health attributes such as temperature, reallocated sectors, power-on hours, and pending sector counts, and reports the overall health status of each drive as a service check.

Unlike other approaches that shell out to smartctl (which requires root privileges), this integration reads the state files that smartd already maintains, making it work without any privilege escalation.

Setup

Prerequisites

smartd must be persisting state files

This integration reads the per-drive state files that smartd writes on every poll cycle. smartd does not persist state files by default — it must be launched with the -s <prefix> argument, where <prefix> is usually /var/lib/smartmontools/smartd. so that files land as /var/lib/smartmontools/smartd.<MODEL>-<SERIAL>.<type>.state.

Distros handle this differently:

• Debian / Ubuntu: the packaged systemd unit already passes -s /var/lib/smartmontools/smartd. via /etc/default/smartmontools. Nothing to do.
• Arch Linux (and anything else running smartd as just smartd -n): state persistence is not enabled by default. Create /etc/conf.d/smartd with:

  SMARTD_ARGS='-s /var/lib/smartmontools/smartd.'
  

  Then mkdir -p /var/lib/smartmontools && systemctl restart smartd. State files will start appearing on the next poll cycle (default every 30 minutes).

To verify smartd is persisting state, wait a poll cycle after starting smartd and check that /var/lib/smartmontools/smartd.*.state files exist and contain lines like ata-smart-attribute.0.id = 1.

If the integration can't find any state files it will emit a CRITICAL smartd.can_read service check with a message pointing back to this section. If a state file exists but has no SMART attribute data yet (normal right after smartd starts), smartd.disk_health will report UNKNOWN for that drive until the next poll cycle populates the file.

File permissions

The dd-agent user must have read access to the state files. They are typically world-readable with 644 permissions, so no special configuration is needed.

Installation

The integration is published to PyPI. The Datadog Agent does not use public PyPI directly, so install it by downloading the wheel and handing it to the Agent's integration install command.

# Download the wheel using the Agent's embedded pip
/opt/datadog-agent/embedded/bin/pip download --no-deps -d /tmp datadog-smartd

# Install the downloaded wheel into the Agent
datadog-agent integration install --local-wheel /tmp/datadog_smartd-*.whl

# Drop the example config into place and edit as needed
mkdir -p /etc/datadog-agent/conf.d/smartd.d
cp /opt/datadog-agent/embedded/lib/python*/site-packages/datadog_checks/smartd/data/conf.yaml.example \
   /etc/datadog-agent/conf.d/smartd.d/conf.yaml

Configuration

Edit /etc/datadog-agent/conf.d/smartd.d/conf.yaml to configure the check:

init_config:

instances:
  - smartd_state_dir: /var/lib/smartmontools
    min_collection_interval: 120

Then restart the Agent.

Validation

Run the Agent's status subcommand and look for smartd under the Checks section:

datadog-agent status

Or run the check directly:

datadog-agent check smartd

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Service Checks

smartd.disk_health: Returns OK if the drive is healthy, WARNING if reallocated sectors, pending sectors, or offline uncorrectable counts are non-zero, CRITICAL if a normalized attribute value reaches 0.

smartd.can_read: Returns OK if smartd state files were found and parsed successfully, CRITICAL otherwise.

Events

The smartd integration does not include any events.

Support

For help, open an issue on the GitHub repository.