luzifer/mondash
1
0
Fork 0
mirror of https://github.com/Luzifer/mondash.git synced 2024-11-12 17:32:42 +00:00
Code Issues Releases Wiki Activity

Update documentation to reflect staleness_status

Browse source 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2018-09-16 14:50:56 +02:00
parent 7aedffbef9
commit 6cbb706680
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
apiary.apib
View file

@ -71,10 +71,11 @@ This API controls the metrics on your dashboard
+ description (required, string) - A descriptive text for the current state of the metric + description (required, string) - A descriptive text for the current state of the metric
+ status (required, enum[string]) - One of: OK, Warning, Critical, Unknown + status (required, enum[string]) - One of: OK, Warning, Critical, Unknown
+ expires: 604800 (optional, number) - Time in seconds when to remove the metric if there is no update (Valid: `0 < x < 604800`) + expires: 604800 (optional, number) - Time in seconds when to remove the metric if there is no update (Valid: `0 < x < 604800`)
+ freshness: 3600 (optional, number) - Time in seconds when to switch to `Unkown` state of there is no update (Valid: `0 < x < 604800`) + freshness: 3600 (optional, number) - Time in seconds when to switch to stale state of there is no update (Valid: `0 < x < 604800`)
+ ignore_mad: false (optional, boolean) - If set to true the status passed in the update will be used instead of the median absolute deviation + ignore_mad: false (optional, boolean) - If set to true the status passed in the update will be used instead of the median absolute deviation
+ hide_mad: false (optional, boolean) - If set to true the median absolute deviation is hidden on the dashboard for this metric + hide_mad: false (optional, boolean) - If set to true the median absolute deviation is hidden on the dashboard for this metric
+ hide_value: false (optional, boolean) - If set to true the current value will not be shown on the dashboard (useful for checks not having values) + hide_value: false (optional, boolean) - If set to true the current value will not be shown on the dashboard (useful for checks not having values)
+ staleness_status: Unknown (optional, string) - If set this status will be set when the metric gets stale (no updates within freshness time range
+ Response 200 (text/plain) + Response 200 (text/plain)