2021-05-05 13:09:47 -04:00
---
layout: default
title: API
parent: Alerting
nav_order: 15
---
# Alerting API
Use the alerting API to programmatically manage monitors and alerts.
---
#### Table of contents
- TOC
{:toc}
---
2021-09-20 19:06:09 -04:00
## Create query-level monitor
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2021-09-28 19:06:54 -04:00
Query-level monitors run the query and check whether the results should trigger any alerts. As such, query-level monitors can only trigger one alert at a time. For more information about query-level monitors versus bucket-level monitors, see [Create monitors ]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/#create-monitors ).
2021-09-20 19:06:09 -04:00
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/monitors
2021-05-05 13:09:47 -04:00
{
"type": "monitor",
"name": "test-monitor",
2021-09-20 19:06:09 -04:00
"monitor_type": "query_level_monitor",
2021-05-05 13:09:47 -04:00
"enabled": true,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": ["movies"],
"query": {
"size": 0,
"aggregations": {},
"query": {
"bool": {
"filter": {
"range": {
"@timestamp": {
"gte": "||-1h",
"lte": "",
"format": "epoch_millis"
}
}
}
}
}
}
}
}],
"triggers": [{
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "ctx.results[0].hits.total.value > 0",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "ld7912sBlQ5JUWWFThoW",
"message_template": {
"source": "This is my message body."
},
"throttle_enabled": true,
"throttle": {
"value": 27,
"unit": "MINUTES"
},
"subject_template": {
"source": "TheSubject"
}
}]
}]
}
```
If you use a custom webhook for your destination and need to embed JSON in the message body, be sure to escape your quotes:
```json
{
"message_template": {
{% raw %}"source": "{ \"text\": \"Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue. - Trigger: {{ctx.trigger.name}} - Severity: {{ctx.trigger.severity}} - Period start: {{ctx.periodStart}} - Period end: {{ctx.periodEnd}}\" }"{% endraw %}
}
}
```
#### Sample response
```json
{
"_id": "vd5k2GsBlQ5JUWWFxhsP",
"_version": 1,
"_seq_no": 7,
"_primary_term": 1,
"monitor": {
"type": "monitor",
"schema_version": 1,
"name": "test-monitor",
"enabled": true,
"enabled_time": 1562703611363,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"movies"
],
"query": {
"size": 0,
"query": {
"bool": {
"filter": [{
"range": {
"@timestamp": {
"from": "||-1h",
"to": "",
"include_lower": true,
"include_upper": true,
"format": "epoch_millis",
"boost": 1
}
}
}],
"adjust_pure_negative": true,
"boost": 1
}
},
"aggregations": {}
}
}
}],
"triggers": [{
"id": "ud5k2GsBlQ5JUWWFxRvi",
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "ctx.results[0].hits.total.value > 0",
"lang": "painless"
}
},
"actions": [{
"id": "ut5k2GsBlQ5JUWWFxRvj",
"name": "test-action",
"destination_id": "ld7912sBlQ5JUWWFThoW",
"message_template": {
"source": "This is my message body.",
"lang": "mustache"
},
"throttle_enabled": false,
"subject_template": {
2021-09-20 19:06:09 -04:00
"source": "Subject",
2021-05-05 13:09:47 -04:00
"lang": "mustache"
}
}]
}],
"last_update_time": 1562703611363
}
}
```
2021-06-09 22:15:41 -04:00
If you want to specify a timezone, you can do so by including a [cron expression ]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/cron/ ) with a timezone name in the `schedule` section of your request.
2021-05-05 13:09:47 -04:00
The following example creates a monitor that runs at 12:10 PM Pacific Time on the 1st day of every month.
#### Request
```json
{
"type": "monitor",
"name": "test-monitor",
2021-09-20 19:06:09 -04:00
"monitor_type": "query_level_monitor",
2021-05-05 13:09:47 -04:00
"enabled": true,
"schedule": {
"cron" : {
"expression": "10 12 1 * * ",
"timezone": "America/Los_Angeles"
}
},
"inputs": [{
"search": {
"indices": ["movies"],
"query": {
"size": 0,
"aggregations": {},
"query": {
"bool": {
"filter": {
"range": {
"@timestamp": {
"gte": "||-1h",
"lte": "",
"format": "epoch_millis"
}
}
}
}
}
}
}
}],
"triggers": [{
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "ctx.results[0].hits.total.value > 0",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "ld7912sBlQ5JUWWFThoW",
"message_template": {
2021-09-20 19:06:09 -04:00
"source": "This is a message body."
2021-05-05 13:09:47 -04:00
},
"throttle_enabled": true,
"throttle": {
"value": 27,
"unit": "MINUTES"
},
"subject_template": {
2021-09-20 19:06:09 -04:00
"source": "Subject"
2021-05-05 13:09:47 -04:00
}
}]
}]
}
```
For a full list of timezone names, refer to [Wikipedia ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones ). The alerting plugin uses the Java [TimeZone ](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/TimeZone.html ) class to convert a [`ZoneId` ](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/ZoneId.html ) to a valid timezone.
---
2021-09-20 19:06:09 -04:00
## Create bucket-level monitor
2021-09-28 19:06:54 -04:00
Bucket-level monitors categorize results into buckets separated by fields. The monitor then runs your script with each bucket's results and evaluates whether to trigger an alert. For more information about bucket-level monitors versus query-level monitors, see [Create monitors ]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/#create-monitors ).
2021-09-27 19:09:53 -04:00
2021-09-20 19:06:09 -04:00
```json
POST _plugins/_alerting/monitors
{
"type": "monitor",
"name": "test-bucket-level-monitor",
"monitor_type": "bucket_level_monitor",
"enabled": true,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [
{
"search": {
"indices": [
"movies"
],
"query": {
"size": 0,
"query": {
"bool": {
"filter": [
{
"range": {
"order_date": {
"from": "{{period_end}}||-1h",
"to": "{{period_end}}",
"include_lower": true,
"include_upper": true,
"format": "epoch_millis"
}
}
}
]
}
},
"aggregations": {
"composite_agg": {
"composite": {
"sources": [
{
"user": {
"terms": {
"field": "user"
}
}
}
]
},
"aggregations": {
"avg_products_base_price": {
"avg": {
"field": "products.base_price"
}
}
}
}
}
}
}
}
],
"triggers": [
{
"bucket_level_trigger": {
"name": "test-trigger",
"severity": "1",
"condition": {
"buckets_path": {
"_count": "_count",
"avg_products_base_price": "avg_products_base_price"
},
"parent_bucket_path": "composite_agg",
"script": {
"source": "params._count > 50 || params.avg_products_base_price < 35 " ,
"lang": "painless"
}
},
"actions": [
{
"name": "test-action",
"destination_id": "E4o5hnsB6KjPKmHtpfCA",
"message_template": {
"source": """Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue. - Trigger: {{ctx.trigger.name}} - Severity: {{ctx.trigger.severity}} - Period start: {{ctx.periodStart}} - Period end: {{ctx.periodEnd}} - Deduped Alerts: {{ctx.dedupedAlerts}} * {{id}} : {{bucket_keys}} {{ctx.dedupedAlerts}} - New Alerts: {{ctx.newAlerts}} * {{id}} : {{bucket_keys}} {{ctx.newAlerts}} - Completed Alerts: {{ctx.completedAlerts}} * {{id}} : {{bucket_keys}} {{ctx.completedAlerts}}""",
"lang": "mustache"
},
"throttle_enabled": false,
2021-09-28 19:06:54 -04:00
"throttle": {
"value": 10,
"unit": "MINUTES"
},
2021-09-20 19:06:09 -04:00
"action_execution_policy": {
"action_execution_scope": {
"per_alert": {
"actionable_alerts": [
"DEDUPED",
"NEW"
]
}
}
},
"subject_template": {
2021-09-28 19:06:54 -04:00
"source": "The Subject",
2021-09-20 19:06:09 -04:00
"lang": "mustache"
}
}
]
}
}
]
}
```
#### Sample response
```json
{
"_id" : "Dfxr63sBwex6DxEhHV5N",
"_version" : 1,
"_seq_no" : 3,
"_primary_term" : 1,
"monitor" : {
"type" : "monitor",
"schema_version" : 4,
"name" : "test-bucket-level-monitor",
"monitor_type" : "bucket_level_monitor",
"user" : {
"name" : "",
"backend_roles" : [ ],
"roles" : [ ],
"custom_attribute_names" : [ ],
"user_requested_tenant" : null
},
"enabled" : true,
"enabled_time" : 1631742270785,
"schedule" : {
"period" : {
"interval" : 1,
"unit" : "MINUTES"
}
},
"inputs" : [
{
"search" : {
"indices" : [
"opensearch_dashboards_sample_data_flights"
],
"query" : {
"size" : 0,
"query" : {
"bool" : {
"filter" : [
{
"range" : {
"order_date" : {
"from" : "{{period_end}}||-1h",
"to" : "{{period_end}}",
"include_lower" : true,
"include_upper" : true,
"format" : "epoch_millis",
"boost" : 1.0
}
}
}
],
"adjust_pure_negative" : true,
"boost" : 1.0
}
},
"aggregations" : {
"composite_agg" : {
"composite" : {
"size" : 10,
"sources" : [
{
"user" : {
"terms" : {
"field" : "user",
"missing_bucket" : false,
"order" : "asc"
}
}
}
]
},
"aggregations" : {
"avg_products_base_price" : {
"avg" : {
"field" : "products.base_price"
}
}
}
}
}
}
}
}
],
"triggers" : [
{
"bucket_level_trigger" : {
"id" : "C_xr63sBwex6DxEhHV5B",
"name" : "test-trigger",
"severity" : "1",
"condition" : {
"buckets_path" : {
"_count" : "_count",
"avg_products_base_price" : "avg_products_base_price"
},
"parent_bucket_path" : "composite_agg",
"script" : {
"source" : "params._count > 50 || params.avg_products_base_price < 35 " ,
"lang" : "painless"
},
"gap_policy" : "skip"
},
"actions" : [
{
"id" : "DPxr63sBwex6DxEhHV5B",
"name" : "test-action",
"destination_id" : "E4o5hnsB6KjPKmHtpfCA",
"message_template" : {
"source" : "Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue. - Trigger: {{ctx.trigger.name}} - Severity: {{ctx.trigger.severity}} - Period start: {{ctx.periodStart}} - Period end: {{ctx.periodEnd}} - Deduped Alerts: {{ctx.dedupedAlerts}} * {{id}} : {{bucket_keys}} {{ctx.dedupedAlerts}} - New Alerts: {{ctx.newAlerts}} * {{id}} : {{bucket_keys}} {{ctx.newAlerts}} - Completed Alerts: {{ctx.completedAlerts}} * {{id}} : {{bucket_keys}} {{ctx.completedAlerts}}",
"lang" : "mustache"
},
"throttle_enabled" : false,
"subject_template" : {
"source" : "The Subject",
"lang" : "mustache"
},
"throttle" : {
"value" : 10,
"unit" : "MINUTES"
},
"action_execution_policy" : {
"action_execution_scope" : {
"per_alert" : {
"actionable_alerts" : [
"DEDUPED",
"NEW"
]
}
}
}
}
]
}
}
],
"last_update_time" : 1631742270785
}
}
```
2021-05-05 13:09:47 -04:00
## Update monitor
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2022-01-04 20:46:31 -05:00
When updating a monitor, you can optionally include `seq_no` and `primary_term` as URL parameters. If these numbers don't match the existing monitor or the monitor doesn't exist, the alerting plugin throws an error. OpenSearch increments the version number and the sequence number automatically (see the sample response).
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
PUT _plugins/_alerting/monitors/< monitor_id >
2021-05-05 13:09:47 -04:00
{
"type": "monitor",
"name": "test-monitor",
"enabled": true,
"enabled_time": 1551466220455,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"*"
],
"query": {
"query": {
"match_all": {
"boost": 1
}
}
}
}
}],
"triggers": [{
"id": "StaeOmkBC25HCRGmL_y-",
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "return true",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "RtaaOmkBC25HCRGm0fxi",
"subject_template": {
"source": "My Message Subject",
"lang": "mustache"
},
"message_template": {
"source": "This is my message body.",
"lang": "mustache"
}
}]
}],
"last_update_time": 1551466639295
}
2022-01-04 02:04:31 -05:00
PUT _plugins/_alerting/monitors/< monitor_id > ?if_seq_no=3& if_primary_term=1
{
"type": "monitor",
"name": "test-monitor",
"enabled": true,
"enabled_time": 1551466220455,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"*"
],
"query": {
"query": {
"match_all": {
"boost": 1
}
}
}
}
}],
"triggers": [{
"id": "StaeOmkBC25HCRGmL_y-",
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "return true",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "RtaaOmkBC25HCRGm0fxi",
"subject_template": {
"source": "My Message Subject",
"lang": "mustache"
},
"message_template": {
"source": "This is my message body.",
"lang": "mustache"
}
}]
}],
"last_update_time": 1551466639295
}
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id": "Q9aXOmkBC25HCRGmzfw-",
"_version": 4,
2022-01-04 02:04:31 -05:00
"_seq_no": 4,
"_primary_term": 1,
2021-05-05 13:09:47 -04:00
"monitor": {
"type": "monitor",
"name": "test-monitor",
"enabled": true,
"enabled_time": 1551466220455,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"*"
],
"query": {
"query": {
"match_all": {
"boost": 1
}
}
}
}
}],
"triggers": [{
"id": "StaeOmkBC25HCRGmL_y-",
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "return true",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "RtaaOmkBC25HCRGm0fxi",
"subject_template": {
"source": "My Message Subject",
"lang": "mustache"
},
"message_template": {
"source": "This is my message body.",
"lang": "mustache"
}
}]
}],
"last_update_time": 1551466761596
}
}
```
---
## Get monitor
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/monitors/< monitor_id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id": "Q9aXOmkBC25HCRGmzfw-",
"_version": 3,
2022-01-04 02:04:31 -05:00
"_seq_no": 3,
"_primary_term": 1,
2021-05-05 13:09:47 -04:00
"monitor": {
"type": "monitor",
"name": "test-monitor",
"enabled": true,
"enabled_time": 1551466220455,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"*"
],
"query": {
"query": {
"match_all": {
"boost": 1
}
}
}
}
}],
"triggers": [{
"id": "StaeOmkBC25HCRGmL_y-",
"name": "test-trigger",
"severity": "1",
"condition": {
"script": {
"source": "return true",
"lang": "painless"
}
},
"actions": [{
"name": "test-action",
"destination_id": "RtaaOmkBC25HCRGm0fxi",
"subject_template": {
"source": "My Message Subject",
"lang": "mustache"
},
"message_template": {
"source": "This is my message body.",
"lang": "mustache"
}
}]
}],
"last_update_time": 1551466639295
}
}
```
---
## Monitor stats
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2021-05-24 16:47:48 -04:00
Returns statistics about the alerting feature. Use `_plugins/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values.
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/stats
GET _plugins/_alerting/stats/< metric >
GET _plugins/_alerting/< node-id > /stats
GET _plugins/_alerting/< node-id > /stats/< metric >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_nodes": {
"total": 9,
"successful": 9,
"failed": 0
},
"cluster_name": "475300751431:alerting65-dont-delete",
2021-06-08 18:35:12 -04:00
"plugins.scheduled_jobs.enabled": true,
2021-05-05 13:09:47 -04:00
"scheduled_job_index_exists": true,
"scheduled_job_index_status": "green",
"nodes_on_schedule": 9,
"nodes_not_on_schedule": 0,
"nodes": {
"qWcbKbb-TVyyI-Q7VSeOqA": {
"name": "qWcbKbb",
"schedule_status": "green",
"roles": [
"MASTER"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 207017,
"full_sweep_on_time": true
},
"jobs_info": {}
},
"Do-DX9ZcS06Y9w1XbSJo1A": {
"name": "Do-DX9Z",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 230516,
"full_sweep_on_time": true
},
"jobs_info": {}
},
"n5phkBiYQfS5I0FDzcqjZQ": {
"name": "n5phkBi",
"schedule_status": "green",
"roles": [
"MASTER"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 228406,
"full_sweep_on_time": true
},
"jobs_info": {}
},
"Tazzo8cQSY-g3vOjgYYLzA": {
"name": "Tazzo8c",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 211722,
"full_sweep_on_time": true
},
"jobs_info": {
"i-wsFmkB8NzS6aXjQSk0": {
"last_execution_time": 1550864912882,
"running_on_time": true
}
}
},
"Nyf7F8brTOSJuFPXw6CnpA": {
"name": "Nyf7F8b",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 223300,
"full_sweep_on_time": true
},
"jobs_info": {
"NbpoFmkBeSe-hD59AKgE": {
"last_execution_time": 1550864928354,
"running_on_time": true
},
"-LlLFmkBeSe-hD59Ydtb": {
"last_execution_time": 1550864732727,
"running_on_time": true
},
"pBFxFmkBNXkgNmTBaFj1": {
"last_execution_time": 1550863325024,
"running_on_time": true
},
"hfasEmkBNXkgNmTBrvIW": {
"last_execution_time": 1550862000001,
"running_on_time": true
}
}
},
"oOdJDIBVT5qbbO3d8VLeEw": {
"name": "oOdJDIB",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 227570,
"full_sweep_on_time": true
},
"jobs_info": {
"4hKRFmkBNXkgNmTBKjYX": {
"last_execution_time": 1550864806101,
"running_on_time": true
}
}
},
"NRDG6JYgR8m0GOZYQ9QGjQ": {
"name": "NRDG6JY",
"schedule_status": "green",
"roles": [
"MASTER"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 227652,
"full_sweep_on_time": true
},
"jobs_info": {}
},
"URMrXRz3Tm-CB72hlsl93Q": {
"name": "URMrXRz",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 231048,
"full_sweep_on_time": true
},
"jobs_info": {
"m7uKFmkBeSe-hD59jplP": {
"running_on_time": true
}
}
},
"eXgt1k9oTRCLmx2HBGElUw": {
"name": "eXgt1k9",
"schedule_status": "green",
"roles": [
"DATA",
"INGEST"
],
"job_scheduling_metrics": {
"last_full_sweep_time_millis": 229234,
"full_sweep_on_time": true
},
"jobs_info": {
"wWkFFmkBc2NG-PeLntxk": {
"running_on_time": true
},
"3usNFmkB8NzS6aXjO1Gs": {
"last_execution_time": 1550863959848,
"running_on_time": true
}
}
}
}
}
```
---
## Delete monitor
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```
2021-05-24 16:47:48 -04:00
DELETE _plugins/_alerting/monitors/< monitor_id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_index": ".opensearch-scheduled-jobs",
"_type": "_doc",
"_id": "OYAHOmgBl3cmwnqZl_yH",
"_version": 2,
"result": "deleted",
"forced_refresh": true,
"_shards": {
"total": 2,
"successful": 2,
"failed": 0
},
"_seq_no": 11,
"_primary_term": 1
}
```
---
## Search monitors
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/monitors/_search
2021-05-05 13:09:47 -04:00
{
"query": {
"match" : {
"monitor.name": "my-monitor-name"
}
}
}
```
#### Sample response
```json
{
"took": 17,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 0.6931472,
"hits": [{
"_index": ".opensearch-scheduled-jobs",
"_type": "_doc",
"_id": "eGQi7GcBRS7-AJEqfAnr",
"_score": 0.6931472,
"_source": {
"type": "monitor",
"name": "my-monitor-name",
"enabled": true,
"enabled_time": 1545854942426,
"schedule": {
"period": {
"interval": 1,
"unit": "MINUTES"
}
},
"inputs": [{
"search": {
"indices": [
"*"
],
"query": {
"size": 0,
"query": {
"bool": {
"filter": [{
"range": {
"@timestamp": {
"from": "{{period_end}}||-1h",
"to": "{{period_end}}",
"include_lower": true,
"include_upper": true,
"format": "epoch_millis",
"boost": 1
}
}
}],
"adjust_pure_negative": true,
"boost": 1
}
},
"aggregations": {}
}
}
}],
"triggers": [{
"id": "Sooi7GcB53a0ewuj_6MH",
"name": "Over",
"severity": "1",
"condition": {
"script": {
"source": "_ctx.results[0].hits.total > 400000",
"lang": "painless"
}
},
"actions": []
}],
"last_update_time": 1545854975758
}
}]
}
}
```
---
## Run monitor
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
You can add the optional `?dryrun=true` parameter to the URL to show the results of a run without actions sending any message.
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/monitors/< monitor_id > /_execute
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"monitor_name": "logs",
"period_start": 1547161872322,
"period_end": 1547161932322,
"error": null,
"trigger_results": {
"Sooi7GcB53a0ewuj_6MH": {
"name": "Over",
"triggered": true,
"error": null,
"action_results": {}
}
}
}
```
---
## Get alerts
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
Returns an array of all alerts.
#### Request
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/monitors/alerts
2021-05-05 13:09:47 -04:00
```
#### Response
```json
{
"alerts": [
{
"id": "eQURa3gBKo1jAh6qUo49",
"version": 300,
"monitor_id": "awUMa3gBKo1jAh6qu47E",
"schema_version": 2,
"monitor_version": 2,
"monitor_name": "Example_monitor_name",
"monitor_user": {
"name": "admin",
"backend_roles": [
"admin"
],
"roles": [
"all_access",
"own_index"
],
"custom_attribute_names": [],
"user_requested_tenant": null
},
"trigger_id": "bQUQa3gBKo1jAh6qnY6G",
"trigger_name": "Example_trigger_name",
"state": "ACTIVE",
"error_message": null,
"alert_history": [
{
"timestamp": 1617314504873,
"message": "Example error emssage"
},
{
"timestamp": 1617312543925,
"message": "Example error message"
}
],
"severity": "1",
"action_execution_results": [
{
"action_id": "bgUQa3gBKo1jAh6qnY6G",
"last_execution_time": 1617317979908,
"throttled_count": 0
}
],
"start_time": 1616704000492,
"last_notification_time": 1617317979908,
"end_time": null,
"acknowledged_time": null
}
],
"totalAlerts": 1
}
```
---
## Acknowledge alert
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2021-08-10 14:54:40 -04:00
[After getting your alerts ](#get-alerts ), you can acknowledge any number of active alerts in one call. If the alert is already in an ERROR, COMPLETED, or ACKNOWLEDGED state, it appears in the `failed` array.
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/monitors/< monitor-id > /_acknowledge/alerts
2021-05-05 13:09:47 -04:00
{
"alerts": ["eQURa3gBKo1jAh6qUo49"]
}
```
#### Sample response
```json
{
"success": [
"eQURa3gBKo1jAh6qUo49"
],
"failed": []
}
```
---
## Create destination
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Requests
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations
2021-05-05 13:09:47 -04:00
{
"name": "my-destination",
"type": "slack",
"slack": {
"url": "http://www.example.com"
}
}
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations
2021-05-05 13:09:47 -04:00
{
"type": "custom_webhook",
"name": "my-custom-destination",
"custom_webhook": {
"path": "incomingwebhooks/123456-123456-XXXXXX",
"header_params": {
"Content-Type": "application/json"
},
"scheme": "HTTPS",
"port": 443,
"query_params": {
"token": "R2x1UlN4ZHF8MXxxVFJpelJNVDgzdGNwXXXXXXXXX"
},
"host": "hooks.chime.aws"
}
}
2021-06-22 21:21:34 -04:00
POST _plugins/_alerting/destinations
{
"type": "email",
"name": "my-email-destination",
"email": {
"email_account_id": "YjY7mXMBx015759_IcfW",
"recipients": [
{
"type": "email_group",
"email_group_id": "YzY-mXMBx015759_dscs"
},
{
"type": "email",
"email": "example@email.com"
}
]
}
}
// The email_account_id and email_group_id will be the document IDs of the email_account and email_group you have created.
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id": "nO-yFmkB8NzS6aXjJdiI",
2022-01-04 02:04:31 -05:00
"_version" : 1,
"_seq_no" : 3,
"_primary_term" : 1,
2021-05-05 13:09:47 -04:00
"destination": {
"type": "slack",
"name": "my-destination",
"last_update_time": 1550863967624,
"slack": {
"url": "http://www.example.com"
}
}
}
```
---
## Update destination
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2022-01-04 20:46:31 -05:00
When updating a destination, you can optionally include `seq_no` and `primary_term` as URL parameters. If these numbers don't match the existing destination or the destination doesn't exist, the alerting plugin throws an error. OpenSearch increments the version number and the sequence number automatically (see the sample response).
2022-01-04 02:04:31 -05:00
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
PUT _plugins/_alerting/destinations/< destination-id >
2021-05-05 13:09:47 -04:00
{
"name": "my-updated-destination",
"type": "slack",
"slack": {
"url": "http://www.example.com"
}
}
2022-01-04 02:04:31 -05:00
PUT _plugins/_alerting/destinations/< destination-id > ?if_seq_no=3& if_primary_term=1
{
"name": "my-updated-destination",
"type": "slack",
"slack": {
"url": "http://www.example.com"
}
}
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id": "pe-1FmkB8NzS6aXjqvVY",
2022-01-04 02:04:31 -05:00
"_version" : 2,
"_seq_no" : 4,
"_primary_term" : 1,
2021-05-05 13:09:47 -04:00
"destination": {
"type": "slack",
"name": "my-updated-destination",
"last_update_time": 1550864289375,
"slack": {
"url": "http://www.example.com"
}
}
}
```
---
## Get destination
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
Retrieve one destination.
#### Requests
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/destinations/< destination-id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"totalDestinations": 1,
"destinations": [{
"id": "1a2a3a4a5a6a7a",
"type": "slack",
"name": "sample-destination",
"user": {
"name": "psantos",
"backend_roles": [
"human-resources"
],
"roles": [
"alerting_full_access",
"hr-role"
],
"custom_attribute_names": []
},
"schema_version": 3,
"seq_no": 0,
"primary_term": 6,
"last_update_time": 1603943261722,
"slack": {
"url": "https://example.com"
}
}
]
}
```
---
## Get destinations
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
Retrieve all destinations.
#### Requests
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/destinations
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"totalDestinations": 1,
"destinations": [{
"id": "1a2a3a4a5a6a7a",
"type": "slack",
"name": "sample-destination",
"user": {
"name": "psantos",
"backend_roles": [
"human-resources"
],
"roles": [
"alerting_full_access",
"hr-role"
],
"custom_attribute_names": []
},
"schema_version": 3,
"seq_no": 0,
"primary_term": 6,
"last_update_time": 1603943261722,
"slack": {
"url": "https://example.com"
}
}
]
}
```
---
## Delete destination
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```
2021-05-24 16:47:48 -04:00
DELETE _plugins/_alerting/destinations/< destination-id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
2021-05-11 12:13:04 -04:00
"_index": ".opendistro-alerting-config",
2021-05-05 13:09:47 -04:00
"_type": "_doc",
"_id": "Zu-zFmkB8NzS6aXjLeBI",
"_version": 2,
"result": "deleted",
"forced_refresh": true,
"_shards": {
"total": 2,
"successful": 2,
"failed": 0
},
"_seq_no": 8,
"_primary_term": 1
}
```
---
## Create email account
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations/email_accounts
2021-05-05 13:09:47 -04:00
{
"name": "example_account",
"email": "example@email.com",
"host": "smtp.email.com",
"port": 465,
"method": "ssl"
}
```
#### Sample response
```json
{
"_id" : "email_account_id",
"_version" : 1,
"_seq_no" : 7,
"_primary_term" : 2,
"email_account" : {
"schema_version" : 2,
"name" : "example_account",
"email" : "example@email.com",
"host" : "smtp.email.com",
"port" : 465,
"method" : "ssl"
}
}
```
## Update email account
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2022-01-04 20:46:31 -05:00
When updating an email account, you can optionally include `seq_no` and `primary_term` as URL parameters. If these numbers don't match the existing email account or the email account doesn't exist, the alerting plugin throws an error. OpenSearch increments the version number and the sequence number automatically (see the sample response).
2022-01-04 02:04:31 -05:00
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
PUT _plugins/_alerting/destinations/email_accounts/< email_account_id >
2021-05-05 13:09:47 -04:00
{
"name": "example_account",
"email": "example@email.com",
"host": "smtp.email.com",
"port": 465,
"method": "ssl"
}
2022-01-04 02:04:31 -05:00
PUT _plugins/_alerting/destinations/email_accounts/< email_account_id > ?if_seq_no=18& if_primary_term=2
{
"name": "example_account",
"email": "example@email.com",
"host": "smtp.email.com",
"port": 465,
"method": "ssl"
}
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id" : "email_account_id",
"_version" : 3,
"_seq_no" : 19,
"_primary_term" : 2,
"email_account" : {
"schema_version" : 2,
"name" : "example_account",
"email" : "example@email.com",
"host" : "smtp.email.com",
"port" : 465,
"method" : "ssl"
}
}
```
## Get email account
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/destinations/email_accounts/< email_account_id >
2021-05-05 13:09:47 -04:00
{
"name": "example_account",
"email": "example@email.com",
"host": "smtp.email.com",
"port": 465,
"method": "ssl"
}
```
#### Sample response
```json
{
"_id" : "email_account_id",
"_version" : 2,
"_seq_no" : 8,
"_primary_term" : 2,
"email_account" : {
"schema_version" : 2,
"name" : "test_account",
"email" : "test@email.com",
"host" : "smtp.test.com",
"port" : 465,
"method" : "ssl"
}
}
```
## Delete email account
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```
2021-05-24 16:47:48 -04:00
DELETE _plugins/_alerting/destinations/email_accounts/< email_account_id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
2021-05-11 12:13:04 -04:00
"_index" : ".opendistro-alerting-config",
2021-05-05 13:09:47 -04:00
"_type" : "_doc",
"_id" : "email_account_id",
"_version" : 1,
"result" : "deleted",
"forced_refresh" : true,
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"_seq_no" : 12,
"_primary_term" : 2
}
```
## Search email account
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations/email_accounts/_search
2021-05-05 13:09:47 -04:00
{
"from": 0,
"size": 20,
"sort": { "email_account.name.keyword": "desc" },
"query": {
"bool": {
"must": {
"match_all": {}
}
}
}
}
```
#### Sample response
```json
{
"took" : 8,
"timed_out" : false,
"_shards" : {
"total" : 1,
"successful" : 1,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : {
"value" : 2,
"relation" : "eq"
},
"max_score" : null,
"hits" : [
{
2021-05-11 12:13:04 -04:00
"_index" : ".opendistro-alerting-config",
2021-05-05 13:09:47 -04:00
"_type" : "_doc",
"_id" : "email_account_id",
"_seq_no" : 8,
"_primary_term" : 2,
"_score" : null,
"_source" : {
"schema_version" : 2,
"name" : "example_account",
"email" : "example@email.com",
"host" : "smtp.email.com",
"port" : 465,
"method" : "ssl"
},
"sort" : [
"example_account"
]
},
...
]
}
}
```
---
## Create email group
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations/email_groups
2021-05-05 13:09:47 -04:00
{
"name": "example_email_group",
"emails": [{
"email": "example@email.com"
}]
}
```
#### Sample response
```json
{
"_id" : "email_group_id",
"_version" : 1,
"_seq_no" : 9,
"_primary_term" : 2,
"email_group" : {
"schema_version" : 2,
"name" : "example_email_group",
"emails" : [
{
"email" : "example@email.com"
}
]
}
}
```
## Update email group
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
2022-01-04 20:46:31 -05:00
When updating an email group, you can optionally include `seq_no` and `primary_term` as URL parameters. If these numbers don't match the existing email group or the email group doesn't exist, the alerting plugin throws an error. OpenSearch increments the version number and the sequence number automatically (see the sample response).
2022-01-04 02:04:31 -05:00
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
PUT _plugins/_alerting/destinations/email_groups/< email_group_id >
2021-05-05 13:09:47 -04:00
{
"name": "example_email_group",
"emails": [{
"email": "example@email.com"
}]
}
2022-01-04 02:04:31 -05:00
PUT _plugins/_alerting/destinations/email_groups/< email_group_id > ?if_seq_no=16& if_primary_term=2
{
"name": "example_email_group",
"emails": [{
"email": "example@email.com"
}]
}
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
"_id" : "email_group_id",
"_version" : 4,
"_seq_no" : 17,
"_primary_term" : 2,
"email_group" : {
"schema_version" : 2,
"name" : "example_email_group",
"emails" : [
{
"email" : "example@email.com"
}
]
}
}
```
## Get email group
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
GET _plugins/_alerting/destinations/email_groups/< email_group_id >
2021-05-05 13:09:47 -04:00
{
"name": "example_email_group",
"emails": [{
"email": "example@email.com"
}]
}
```
#### Sample response
```json
{
"_id" : "email_group_id",
"_version" : 4,
"_seq_no" : 17,
"_primary_term" : 2,
"email_group" : {
"schema_version" : 2,
"name" : "example_email_group",
"emails" : [
{
"email" : "example@email.com"
}
]
}
}
```
## Delete email group
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```
2021-05-24 16:47:48 -04:00
DELETE _plugins/_alerting/destinations/email_groups/< email_group_id >
2021-05-05 13:09:47 -04:00
```
#### Sample response
```json
{
2021-05-11 12:13:04 -04:00
"_index" : ".opendistro-alerting-config",
2021-05-05 13:09:47 -04:00
"_type" : "_doc",
"_id" : "email_group_id",
"_version" : 1,
"result" : "deleted",
"forced_refresh" : true,
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"_seq_no" : 11,
"_primary_term" : 2
}
```
## Search email group
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-05-05 13:09:47 -04:00
#### Request
```json
2021-05-24 16:47:48 -04:00
POST _plugins/_alerting/destinations/email_groups/_search
2021-05-05 13:09:47 -04:00
{
"from": 0,
"size": 20,
"sort": { "email_group.name.keyword": "desc" },
"query": {
"bool": {
"must": {
"match_all": {}
}
}
}
}
```
#### Sample response
```json
{
"took" : 7,
"timed_out" : false,
"_shards" : {
"total" : 1,
"successful" : 1,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : {
"value" : 5,
"relation" : "eq"
},
"max_score" : null,
"hits" : [
{
2021-05-11 12:13:04 -04:00
"_index" : ".opendistro-alerting-config",
2021-05-05 13:09:47 -04:00
"_type" : "_doc",
"_id" : "email_group_id",
"_seq_no" : 10,
"_primary_term" : 2,
"_score" : null,
"_source" : {
"schema_version" : 2,
"name" : "example_email_group",
"emails" : [
{
"email" : "example@email.com"
}
]
},
"sort" : [
"example_email_group"
]
},
...
]
}
}
```
---
