Coder Social home page Coder Social logo

mindflavor / prometheus_smartctl_temperature_exporter Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 0.0 131 KB

An exporter for the disk temperature reported by smartctl, written in Rust

License: MIT License

Rust 74.10% Dockerfile 25.90%
prometheus prometheus-exporter smartctl temperature temperature-monitoring disk

prometheus_smartctl_temperature_exporter's Introduction

Prometheus smartctl temperature exporter

An exporter for the disk temperature reported by smartctl, written in Rust.

legal stability-stable

Crate cratedown cratelastdown

release tag

Rust build commitssince

Docker build

dockeri.co

What is this?

This tool, upon Prometheus's request - enumerates your disks via lsblk command and for each block device of type disk will issue smartctl -a -j. It then proceeds to extract the temperature and present it in a valid Prometheus format, like this:

# HELP smartctl_device_temperature device temperature as reported by smartctl
# TYPE smartctl_device_temperature gauge
smartctl_device_temperature{device="Samsung_SSD_840_EVO_250GB_S1DBNSBF380127V"} 39
smartctl_device_temperature{device="Samsung_SSD_870_QVO_2TB_S5SUNF0R111858P"} 37
smartctl_device_temperature{device="Samsung_SSD_870_QVO_2TB_S5SUNF0R111863B"} 38
smartctl_device_temperature{device="OCZ-VERTEX3_OCZ-90RJ51213OH12OYW"} 30
smartctl_device_temperature{device="CT120BX500SSD1_1915E17BC591"} 48
smartctl_device_temperature{device="Samsung_SSD_870_QVO_2TB_S5SUNF0R111124X"} 38

Why

I needed to resilver my ZFS array and I was concerned by overheating my disks because of the sustained operation. Unfortunately, while smartctl exposes the disk temperature, I was not able to import it in Prometheus in a straightforward manner, so I ended up writing a specialized Rust process that does just that. It's probably an overkill but being Rust it is super cheap to run.

Requirements

You need to have both lsblk and smartctl executables available in the $PATH. Also, since smartctl requires root privileges, you need to run the tool as root (or use the prepend sudo option). Ah, you also need Rust to compile the tool. You can use the docker image, courtesy of Quentin McGaw as it does everything for you.

Options

Option Mandatory Accepted values Default Multiple Description
-a No - No No Prepends sudo to the smartctl commands. Useful to avoid running the exporter as root.
-v No - No No Enable verbose logging. Useful for troubleshooting.
-l No Any valid IP 0.0.0.0 No IP address to listen from. Default listens on every device.
-p No Any valid TCP port 9587 No TCP port opened by the tool. Must be free.
-e No Any valid regex - Yes Regular expressions to exclude from the analysis. For example z.* excludes /dev/zXX disks (in my case these are ZFS virtual block devices). Useful to avoid warnings about not supported disks.

Hey, the tools says it does not support my hard disk! What should I do?

The output of smartctl depends heavily on the disk model. If your disk is not supported (as reported by the tool) all you have to do is to issue sudo systemctl -a -j /dev/sdX (where X is your disk) and open a issue with the resulting json. I will update the tool to support your disk as soon as possible.

prometheus_smartctl_temperature_exporter's People

Contributors

lynix avatar mindflavor avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.