Skip to main content

S.M.A.R.T.

Plugin: python.d.plugin Module: smartd_log

Overview

This collector monitors HDD/SSD S.M.A.R.T. metrics about drive health and performance.

It reads smartd log files to collect the metrics.

This collector is supported on all platforms.

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

Upon satisfying the prerequisites, the collector will auto-detect metrics if written in either /var/log/smartd/ or /var/lib/smartmontools/.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

The metrics listed below are split in terms of availability on device type, SCSI or ATA.

Per S.M.A.R.T. instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnitSCSIATA
smartd_log.read_error_ratea dimension per devicevalue
smartd_log.seek_error_ratea dimension per devicevalue
smartd_log.soft_read_error_ratea dimension per deviceerrors
smartd_log.write_error_ratea dimension per devicevalue
smartd_log.read_total_err_correcteda dimension per deviceerrors
smartd_log.read_total_unc_errorsa dimension per deviceerrors
smartd_log.write_total_err_correcteda dimension per deviceerrors
smartd_log.write_total_unc_errorsa dimension per deviceerrors
smartd_log.verify_total_err_correcteda dimension per deviceerrors
smartd_log.verify_total_unc_errorsa dimension per deviceerrors
smartd_log.sata_interface_downshifta dimension per deviceevents
smartd_log.udma_crc_error_counta dimension per deviceerrors
smartd_log.throughput_performancea dimension per devicevalue
smartd_log.seek_time_performancea dimension per devicevalue
smartd_log.start_stop_counta dimension per deviceevents
smartd_log.power_on_hours_counta dimension per devicehours
smartd_log.power_cycle_counta dimension per deviceevents
smartd_log.unexpected_power_lossa dimension per deviceevents
smartd_log.spin_up_timea dimension per devicems
smartd_log.spin_up_retriesa dimension per deviceretries
smartd_log.calibration_retriesa dimension per deviceretries
smartd_log.airflow_temperature_celsiusa dimension per devicecelsius
smartd_log.temperature_celsiusa dimension per devicecelsius
smartd_log.reallocated_sectors_counta dimension per devicesectors
smartd_log.reserved_block_counta dimension per devicepercentage
smartd_log.program_fail_counta dimension per deviceerrors
smartd_log.erase_fail_counta dimension per devicefailures
smartd_log.wear_leveller_worst_case_erase_counta dimension per deviceerases
smartd_log.unused_reserved_nand_blocksa dimension per deviceblocks
smartd_log.reallocation_event_counta dimension per deviceevents
smartd_log.current_pending_sector_counta dimension per devicesectors
smartd_log.offline_uncorrectable_sector_counta dimension per devicesectors
smartd_log.percent_lifetime_useda dimension per devicepercentage
smartd_log.media_wearout_indicatora dimension per devicepercentage
smartd_log.nand_writes_1giba dimension per deviceGiB

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Configure smartd to write attribute information to files.

smartd must be running with -A option to write smartd attribute information to files.

For this you need to set smartd_opts (or SMARTD_ARGS, check smartd.service content) in /etc/default/smartmontools:

# dump smartd attrs info every 600 seconds
smartd_opts="-A /var/log/smartd/ -i 600"

You may need to create the smartd directory before smartd will write to it:

mkdir -p /var/log/smartd

Otherwise, all the smartd .csv files may get written to /var/lib/smartmontools (default location). See also https://linux.die.net/man/8/smartd for more info on the -A --attributelog=PREFIX command.

smartd appends logs at every run. It's strongly recommended to use logrotate for smartd files.

Configuration

File

The configuration file name for this integration is python.d/smartd_log.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/smartd_log.conf

Options

This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.

There are 2 sections:

  • Global variables
  • One or more JOBS that can define multiple different instances to monitor.

The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.

Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

Every configuration JOB starts with a job_name value which will appear in the dashboard, unless a name parameter is specified.

Config options
NameDescriptionDefaultRequired
log_pathpath to smartd log files./var/log/smartdyes
exclude_disksSpace-separated patterns. If the pattern is in the drive name, the module will not collect data for it.no
ageTime in minutes since the last dump to file.30no
update_everySets the default data collection frequency.1no
priorityControls the order of charts at the netdata dashboard.60000no
autodetection_retrySets the job re-check interval in seconds.0no
penaltyIndicates whether to apply penalty to update_every in case of failures.yesno
nameJob name. This value will overwrite the job_name value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.no

Examples

Basic

A basic configuration example.

custom:
name: smartd_log
log_path: '/var/log/smartd/'

Troubleshooting

Debug Mode

To troubleshoot issues with the smartd_log collector, run the python.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the python.d.plugin to debug the collector:

    ./python.d.plugin smartd_log debug trace

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.