diff --git a/docs/content/alerts.md b/docs/content/alerts.md new file mode 100644 index 00000000000..1f71572eeb2 --- /dev/null +++ b/docs/content/alerts.md @@ -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` diff --git a/docs/content/toc.textile b/docs/content/toc.textile index aedf842f20b..0681018abd2 100644 --- a/docs/content/toc.textile +++ b/docs/content/toc.textile @@ -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