Nagios/Icinga2 Plugin: Monitor Disk Usage of Hetzner Storagebox

A plugin that monitors disk usage of a Hetzner StorageBox using the Hetzner API. Depending on the used percentage the status (OK, WARNING, CRITICAL or UNKNOWN) is returned.

Preparation

• Get the credentials for the Robot-Webservice API through the Hetzner Robot Webservice User Interface
  • You can create the credentials under User Icon/Settings/Webservice and app Settings (DE: Nutzer Icon /Einstellungen/Webservice- und App-Einstellungen)
  • The password is set by yourself, the username gets send to you via E-Mail
• Get the id of your storagebox
  • Through the browser
    • Access https://robot-ws.your-server.de/storagebox
    • Enter username and password you set in the previous step
    • Now you see a JSON-String containing Information of all storageboxes in your account
    • Find the (numeric) value of the id field belonging to the storagebox you want to query
  • Using cURL
    • Execute curl -u user:password https://robot-ws.your-server.de/storagebox (substitute user and password accordingly)
    • Find the (numeric) value of the id field belonging to the storagebox you want to query

Setup

Downloads binary from releases and set executable bit.

wget https://github.com/muensmedia/check_hetzner_storagebox/releases/download/latest/check_hetzner_storagebox-amd64 -O check_hetzner_storagebox
chmod +x check_hetzner_storagebox

Example for Icinga2 CheckCommand

Click to see example for Icinga2 CheckCommand

object CheckCommand "check_hetzner_storagebox" {
import "plugin-check-command"
command = [ "/etc/icinga2-scripts/check_hetzner_storagebox" ]
timeout = 1m
arguments += {
        "-c" = {
            description = "Critical"
            repeat_key = false
            required = false
            value = "$critical$"
        }
        "-id" = {
            description = "ID of the Storagebox"
            repeat_key = false
            required = true
            value = "$storagebox_id$"
        }
        "-p" = {
            description = "Password"
            repeat_key = false
            required = true
            value = "$storagebox_password$"
        }
        "-u" = {
            description = "Username"
            repeat_key = false
            required = true
            value = "$storagebox_username$"
        }
        "-w" = {
            description = "Warning"
            repeat_key = false
            required = true
            value = "$warning$"
        }
    }
    vars.critical = "90"
    vars.storagebox_password = "default-password"
    vars.storagebox_username = "default-username"
    vars.warning = "80"
}

CLI Usage:

usage: check_hetzner_storagebox [-h] -u USER -p PASSWORD -id ID [-w WARNING_PERCENT] [-c CRITICAL_PERCENT]

Nagios/Icinga Plugin to measure disk usage of Hetzner Storagebox via API.

optional arguments:
  -h, --help            show this help message and exit
  -u USER, --user USER  Hetzner API user
  -p PASSWORD, --password PASSWORD
                        Hetzner API password
  -id ID, --identifier ID
                        ID of Hetzner Storagebox
  -w WARNING_PERCENT, --warning WARNING_PERCENT
                        Percentage threshold the status "WARNING"
  -c CRITICAL_PERCENT, --critical CRITICAL_PERCENT
                        Percentage threshold the status "CRITICAL"