Exposed metrics
The following metrics related to the API calls towards Hetzner are available for scraping.
| Name | Type | Labels | Description |
|---|---|---|---|
successful_api_calls_total |
Counter | action |
The number of successful Hetzner API calls |
failed_api_calls_total |
Counter | action |
The number of Hetzner API calls that returned an error |
filtered_out_zones |
Gauge | none | The number of zones excluded by the domain filter |
skipped_records |
Gauge | zone |
The number of skipped records per domain |
api_delay_hist |
Histogram | action |
Histogram of the delay (ms) when calling the Hetzner API |
When using the Cloud API also the rate limit metrics will be available:
| Name | Type | Labels | Description |
|---|---|---|---|
ratelimit_limit |
Gauge | none | Total API calls that can be performed in a hour |
ratelimit_remaining |
Gauge | none | Remaining API calls until the next rate limit reset |
ratelimit_reset_seconds |
Gauge | none | UNIX timestamp for the next rate limit reset |
The label action can assume one of the following values, depending on the
Hetzner API endpoint called.
The actions supported by the legacy DNS provider are:
get_zonesget_recordscreate_recorddelete_recordupdate_record
The actions supported by the Cloud API provider are:
get_zonesget_rrsetscreate_rrsetupdate_rrset_ttlupdate_rrset_recordsupdate_rrset(this is the method used to update labels)delete_rrset
In case BULK_MODE is set to true, the following actions will be used instead:
get_zonesget_rrsetsimport_zonefileexport_zonefile
The label zone can assume one of the zone names as its value.