Merge pull request #1353 from himanshug/alerts_doc

documenting druid alerts schema
This commit is contained in:
Fangjin Yang 2015-05-09 19:05:32 -07:00
commit 9fb9b8a510
2 changed files with 18 additions and 0 deletions

17
docs/content/alerts.md Normal file
View File

@ -0,0 +1,17 @@
---
layout: doc_page
---
# Druid Alerts
Druid generates alerts on getting into unexpected situations.
Alerts are emitted as JSON objects to a runtime log file or over HTTP (to a service such as Apache Kafka). Alert emission is disabled by default.
All Druid alerts share a common set of fields:
* `timestamp` - the time the alert was created
* `service` - the service name that emitted the alert
* `host` - the host name that emitted the alert
* `severity` - severity of the alert e.g. anomaly, component-failure, service-failure etc.
* `description` - a description of the alert
* `data` - if there was an exception then a JSON object with fields `exceptionType`, `exceptionMessage` and `exceptionStackTrace`

View File

@ -52,6 +52,7 @@ h2. Operations
* "Including Extensions":./Including-Extensions.html
* "Data Retention":./Rule-Configuration.html
* "Metrics and Monitoring":./Metrics.html
* "Alerts":./alerts.html
* "Updating the Cluster":./Rolling-Updates.html
* "Different Hadoop Versions":./Other-Hadoop.html
* "Performance FAQ":./Performance-FAQ.html