Get All Alerts¶

On this page

Resource
Response
Example Request
Example Response
- Response Header
- Response Body

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource¶

copy

GET /groups/{GROUP-ID}/alerts

Request Path Parameters¶

Parameter	Type	Description
GROUP-ID	string	(Required.) Group identifier.

Request Query Parameters¶

Name	Type	Description	Default
pageNum	integer	Page number (1-based).	`1`
itemsPerPage	integer	Maximum number of items to return, up to a maximum of 100.	`100`
pretty	boolean	Flag indicating whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Flag indicating whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope=true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Ops Manager adds the `status` field to the response body.	`false`

status

string

Optional. Specify a status to return only those alerts with the specified status. Omit to return all alerts

Possible values are:

TRACKING

To return alerts with TRACKING status. If an alert’s configuration specifies a notification delay, MongoDB Atlas assigns the alert the TRACKING status until the delay period ends. After the delay, MongoDB Atlas sets the status to OPEN, if the condition persists.

If an alert’s configuration has multiple notifications, each with its own notification delay, MongoDB Atlas uses the smallest delay value to determine when to move the alert from TRACKING to OPEN.
OPEN

To return all open alerts.
CLOSED

To return all closed alerts.

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Response Document¶

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name	Type	Description
results	object array	This array includes one object for each item detailed in the results Embedded Document section.
links	object array	This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount	number	The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document¶

Each result is one alert.

Name	Type	Description
`id`	string	Unique identifier.
`groupId`	string	ID of the group that this alert was opened for.
`alertConfigId`	string	ID of the alert configuration that triggered this alert.
`eventTypeName`	string	The name of the event that triggered the alert. Host alerts support these values: `HOST_DOWN` `HOST_RECOVERING` `VERSION_BEHIND` `HOST_EXPOSED` `OUTSIDE_METRIC_THRESHOLD` Agent alerts support these values: `MONITORING_AGENT_DOWN` `MONITORING_AGENT_VERSION_BEHIND` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_CONF_CALL_FAILURE` Backup alerts support these values: `OPLOG_BEHIND` `CLUSTER_MONGOS_IS_MISSING` `RESYNC_REQUIRED` `BAD_CLUSTERSHOTS` `RS_BIND_ERROR` (x alerts only) `BACKUP_TOO_MANY_RETRIES` (global alerts only) `BACKUP_IN_UNEXPECTED_STATE` (global alerts only) `LATE_SNAPSHOT` (global alerts only) `SYNC_SLICE_HAS_NOT_PROGRESSED` (global alerts only) `BACKUP_JOB_TOO_BUSY` (global alerts only) `GROUP_TAGS_CHANGED` (global alerts only) Project alerts support these values: `USERS_AWAITING_APPROVAL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Replica set alerts support these values: `CONFIGURATION_CHANGED` `PRIMARY_ELECTED` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_UNHEALTHY_MEMBERS` `NO_PRIMARY` Sharded cluster alerts support this value: `CLUSTER_MONGOS_IS_MISSING` User alerts support these values: `JOINED_GROUP` `REMOVED_FROM_GROUP`
`typeName`	string	This field is deprecated and will be ignored.
`status`	string	The current state of the alert. Possible values are: `TRACKING` The alert condition exists but has not persisted beyond the defined notification delay. For details, see Request Query Parameters. `OPEN` `CLOSED` `CANCELLED`
`acknowledgedUntil`	date	The date through which the alert has been acknowledged. Will not be present if the alert has never been acknowledged.
`acknowledgementComment`	string	The comment left by the user who acknowledged the alert. Will not be present if the alert has never been acknowledged.
`acknowledgingUsername`	string	The username of the user who acknowledged the alert. Will not be present if the alert has never been acknowledged.
`created`	date	When the alert was opened.
`updated`	date	When the alert was last updated.
`resolved`	date	When the alert was closed. Only present if the status is `CLOSED`.
`lastNotified`	date	When the last notification was sent for this alert. Only present if notifications have been sent.
`hostnameAndPort`	string	The hostname and port of each host to which the alert applies. Only present for alerts of type `HOST`, `HOST_METRIC`, and `REPLICA_SET`.
`hostId`	string	ID of the host to which the metric pertains. Only present for alerts of type `HOST`, `HOST_METRIC`, and `REPLICA_SET`.
`replicaSetName`	string	Name of the replica set. Only present for alerts of type `HOST`, `HOST_METRIC`, `BACKUP`, and `REPLICA_SET`.
`metricName`	string	The name of the measurement whose value went outside the threshold. Only present if `eventTypeName` is set to `OUTSIDE_METRIC_THRESHOLD`. For possible values, see below.
`currentValue`	object	The current value of the metric that triggered the alert. Only present for alerts of type `HOST_METRIC`.
`currentValue.number`	number	The value of the metric.
`currentValue.units`	string	The units for the value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`clusterId`	string	The ID of the cluster to which this alert applies. Only present for alerts of type `BACKUP`, `REPLICA_SET`, and `CLUSTER`.
`clusterName`	string	The name the cluster to which this alert applies. Only present for alerts of type `BACKUP`, `REPLICA_SET`, and `CLUSTER`.
`sourceTypeName`	string	For alerts of the type `BACKUP`, the type of server being backed up. Possible values are: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`

Measurement Types for Alerts¶

The alerts resource returns measurement types in the metricName field. The field is present only if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD.

Host Measurements¶

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	Rate of asserts for a MongoDB process found in the `asserts` document that the serverStatus command generates.
`BACKGROUND_FLUSH_AVG`	Amount of data flushed in the background.
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_USAGE_DIRTY` `CACHE_USAGE_USED` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITES`	Amount of bytes in the WiredTiger storage engine cache and tickets found in the `wiredTiger.cache` and `wiredTiger.concurrentTransactions` documents that the serverStatus command generates.
`CONNECTIONS`	Number of connections to a MongoDB process found in the `connections` document that the serverStatus command generates.
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	Number of cursors for a MongoDB process found in the `metrics.cursor` document that the serverStatus command generates.
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	Numbers of `Memory Issues` and `Page Faults` for a MongoDB process.
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	Number of operations waiting on locks for the MongoDB process that the serverStatus command generates. Ops Manager computes these values based on the type of storage engine.
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	Number of index btree operations.
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	Number of journaling operations.
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	Amount of memory for a MongoDB process found in the `mem` document that the serverStatus command collects.
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	Amount of throughput for MongoDB process found in the `network` document that the serverStatus command collects.
`OPLOG_SLAVE_LAG_MASTER_TIME` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_RATE_GB_PER_HOUR`	Durations and throughput of the MongoDB process’ oplog.
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	Number of database operations on a MongoDB process since the process last started.
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	Rate of database operations on a MongoDB process since the process last started found in the `opcounters` document that the serverStatus command collects.
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	Rate of database operations on MongoDB secondaries found in the `opcountersRepl` document that the serverStatus command collects.
`DOCUMENT_RETURNED` `DOCUMENT_INSERTED` `DOCUMENT_UPDATED` `DOCUMENT_DELETED`	Average rate of documents returned, inserted, updated, or deleted per second during a selected time period.
`OPERATIONS_SCAN_AND_ORDER`	Average rate for operations per second during a selected time period that perform a sort but cannot perform the sort using an index.
`AVG_READ_EXECUTION_TIME` `AVG_WRITE_EXECUTION_TIME` `AVG_COMMAND_EXECUTION_TIME`	Average execution time in milliseconds per read, write, or command operation during a selected time period. Available to hosts running MongoDB 3.4 or later.
`RESTARTS_IN_LAST_HOUR`	Number of times the host restarted within the previous hour.

`QUERY_EXECUTOR_SCANNED`	Average rate per second to scan index items during queries and query-plan evaluations found in the value of `totalKeysExamined` from the explain command.
`QUERY_EXECUTOR_SCANNED_OBJECTS`	Average rate of documents scanned per second during queries and query-plan evaluations found in the value of `totalDocsExamined` from the explain command.
`QUERY_TARGETING_SCANNED_PER_RETURNED`	Ratio of the number of index items scanned to the number of documents returned.
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	Ratio of the number of documents scanned to the number of documents returned.

Example Request¶

The following returns all OPEN alerts:

copy

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{GROUP-ID}/alerts?status=OPEN"

Example Response¶

Response Header¶

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body¶

copy

{
  "totalCount": 1,
  "results": [ {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "id" : "533dc45ee4b00835ff81ec2a",
    "groupId" : "{GROUP-ID}",
    "hostId":"51714c7fa22cbe473a9573d3629ff53c",
    "hostnameAndPort":"example.test.4182.mongodbdns.com:27017",
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "status" : "OPEN",
    "created" : "2014-04-03T20:28:14Z",
    "updated" : "2014-04-03T20:28:14Z",
    "lastNotified" : "2014-04-03T20:28:23Z",
    "metricName": "ASSERTS_REGULAR",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "links" : []
  } ],
  "links" : []
}

← Alerts Get One Alert →