- API >
- Public API Resources >
- Measurements and Alerts >
- Alerts >
- Get All Alerts
Get All Alerts¶
On this page
Base URL: https://<ops-manager-host>
¶
Syntax¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required | Group identifier. |
Request Query Parameters¶
Field | Required/Optional | Description |
---|---|---|
status |
Optional. | Specify a status to return only those alerts with the specified status. Omit to return all alerts Possible values are:
|
pageNum |
Optional. | The page to return. |
itemsPerPage |
Optional. | Maximum number of items to return per page. Default is 100. |
envelope |
Optional. | A boolean that specifies whether or not to wrap the response in an envelope. |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response Elements¶
The response includes the totalCount
of the alerts and a
results
array with the list of alert details. Each alert
information includes:
Note
Alert configurations vary. An alert configuration may only include a subset of these elements.
Name | Type | Description |
---|---|---|
id |
string | Unique identifier. |
groupId |
string | ID of the group that owns this alert configuration. |
eventTypeName |
string | The type of event that will trigger an alert.
|
typeName |
string | This field is deprecated and will be ignored. |
created |
date | When this alert configuration was created. |
updated |
date | When this alert configuration was last updated. |
enabled |
boolean | Is this alert configuration enabled? |
matchers |
object array | Rules to apply when matching an object against this alert configuration. Only entities that match all these rules will be checked for an alert condition. You can filter using the |
matchers.fieldName |
string | The name of the field in the target object to match on.
All other types of alerts do not support matchers. |
matchers.operator |
string | The operator to test the field’s value. Possible values are:
|
matchers.value |
string | The value to test with the specified operator. If
|
notifications |
object array | Notifications to send when an alert condition is detected. |
notifications.typeName |
string | The type of alert notification. Possible values are:
|
notifications.intervalMin |
number | The number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. |
notifications.delayMin |
number | The number of minutes to wait after an alert condition is detected before sending out the first notification. |
notifications.emailEnabled |
boolean | Should email notifications be sent? Only present for notifications of type
GROUP and USER . |
notifications.smsEnabled |
boolean | Should SMS notifications be sent? Only present for notifications of type
GROUP and USER . |
notifications.username |
string | The name of an Ops Manager user to which to send notifications. Only a user in the
group that owns the alert configuration is allowed here. Only present for
notifications of type USER . |
notifications.snmpAddress |
string | Hostname and port to send SNMP traps to. At this time
Ops Manager is only able to send SNMP traps to the standard SNMP
port (162). Only present for SNMP notifications. Ops Manager
uses SNMP v2c. |
notifications.emailAddress |
string | The email address to which to send notification. Only present for
notifications of type EMAIL . |
notifications.notificationToken |
string | A HipChat API token. Only present for notifications of type HIP_CHAT .
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.roomName |
string | HipChat room name. Only present for notifications of type HIP_CHAT . |
notifications.channelName |
string | The Slack channel name. Only present for SLACK notifications. |
notifications.apiToken |
string | The Slack API token or Bot token. Only present for SLACK notifications.
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.orgName |
string | The Flowdock organization name in lower-case letters. This is the
name that appears after www.flowdock.com/app/ in the URL
string. Only present for FLOWDOCK notifications. |
notifications.flowName |
string | The flow name, in lower-case letters. Only present for
|
notifications.flowdockApiToken |
string | The Flowdock “personal API token.” Only present for FLOWDOCK
notifications. If the token later becomes invalid, Ops Manager sends an email
to the group owner and eventually removes the token. |
notifications.serviceKey |
string | PagerDuty service key. Only present for PAGER_DUTY notifications.
If the key later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the key. |
metricThreshold |
object | The threshold that will cause an alert to be triggered. Only present
if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD . |
metricThreshold.metricName |
string | The name of the metric to check. Supports the same values as the
metricName field of the alerts resource. |
metricThreshold.operator |
string | The operator to apply when checking the current metric value against the threshold value. Possible values are:
|
metricThreshold.threshold |
number | The threshold value outside of which an alert will be triggered. |
metricThreshold.units |
string | The units for the threshold 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:
|
metricThreshold.mode |
string | This is set to AVERAGE and computes the current metric value as an average. |
threshold |
object | The threshold that will cause an alert to be triggered. Only present
if
|
threshold.operator |
string | The operator to apply when checking the current metric value against the threshold value.
|
threshold.threshold |
number | The threshold value outside of which an alert will be triggered. |
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¶
|
Measure the rate of asserts for a MongoDB process, as collected from
the MongoDB serverStatus
command’s asserts document. |
|
Measurement found on the host’s background flush avg chart. To view the
chart, see View Metrics. |
|
Apply to a MongoDB process’s WiredTiger
storage engine, as collected from the MongoDB serverStatus command’s
wiredTiger.cache and
wiredTiger.concurrentTransactions documents. |
|
Measures connections to a MongoDB process, as collected from the
MongoDB serverStatus
command’s connections document. |
|
Measure the number of cursors for a MongoDB
process, as collected from the MongoDB serverStatus command’s
metrics.cursor document. |
|
Measurements found on the host’s Record Stats and Page Faults
charts. To view the charts, see View Metrics. |
|
Measure operations waiting on locks, as collected from the MongoDB serverStatus command. Ops Manager computes these values based on the type of storage engine. |
|
Applicable only to hosts running MongoDB 2.0 and earlier. Measures operations waiting on the global lock, as collected from the MongoDB serverStatus command. |
|
Measurements found on the host’s btree chart. To view the chart, see
View Metrics. |
|
Measurements found on the host’s journal - commits in write lock chart
and journal stats chart. To view the charts, see
View Metrics. |
|
Measure memory for a MongoDB process, as collected from the MongoDB
serverStatus command’s
mem document. |
|
Measure throughput for MongoDB process, as collected from the MongoDB
serverStatus command’s
network document. |
|
Measurements that apply to the MongoDB process’s oplog. |
|
Measurements displayed on the host’s db storage chart. To view the
chart, see View Metrics. |
|
Measure the rate of database operations on a MongoDB process since the
process last started, as collected from the MongoDB
serverStatus command’s
opcounters document. |
|
Measure the rate of database operations on MongoDB secondaries, as collected from the MongoDB serverStatus command’s
opcountersRepl document. |
|
The average rate per second of documents returned, inserted, updated,
or deleted for a selected time period. These measurements are found on
the host’s Document Metrics chart. To view the chart, see
View Metrics. |
|
For a selected time period, the average rate per second for operations
that perform a sort but cannot perform the sort using an index. This
measurement is found on the host’s Scan and Order chart. To view
the chart, see View Metrics. |
|
Available to hosts running MongoDB v3.4+. The average execution
time in milliseconds per read, write, or command operation
over the selected time period. These measurements are found
on the host’s Operation Execution Times chart. To view the chart,
see View Metrics. |
|
The average rate per second to scan index items during
queries and query-plan evaluations. This rate is driven by
the same value as totalKeysExamined in the output of
explain. This
measurement is found on the host’s Query Executor
chart, accessed when viewing metrics. |
|
The average rate per second to scan documents during queries
and query-plan evaluations. Ops Manager derives the rate using the
explain output’s
totalDocsExamined value. This measurement is found on the
host’s Query Executor chart, accessed when viewing
metrics. |
|
The ratio of the number of index items scanned to the number of
documents returned. This measurement is found on the host’s
Query Targeting chart, accessed when viewing metrics. |
|
The ratio of the number of documents scanned to the number of
documents returned. This measurement is found on the host’s
Query Targeting chart, accessed when viewing metrics. |
Links¶
Relation |
Description |
---|---|
self |
Me |
http://mms.mongodb.com/group |
The group that this alert was triggered for. |
http://mms.mongodb.com/alertConfig |
The alert configuration that triggered this alert. |
http://mms.mongodb.com/alertConfigs |
A list of alert configurations that triggered this alert. This list will
only contain a single element and is present for backward compatibility.
New code should use the alertConfig link instead. |
http://mms.mongodb.com/host |
The host that triggered this alert. Only present for alerts of type
HOST , REPLICA_SET , or CLUSTER . |
http://mms.mongodb.com/cluster |
The replica set or sharded cluster that triggered this alert. Only
present for alerts of type CLUSTER , REPLICA_SET , or BACKUP . |
Example Request¶
The following returns all OPEN
alerts: