- API >
- Public API Resources >
- Measurements and Alerts >
- Global Alerts
Global Alerts¶
On this page
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.
The globalAlerts
resource allows you to retrieve and acknowledge alerts
that have been triggered by a global alert configuration. You must have the
Global Monitoring Admin to use this
resource.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Alert Status¶
When Ops Manager detects an alert condition, it opens an alert. If the global alert
configuration contains no notification delay, the alert status goes
immediately to OPEN
. If the configuration contains a delay, Ops Manager sets
the alert to TRACKING
until the delay period ends, after which Ops Manager
sets the alert to OPEN
if the condition persists.
If the global alert configuration has multiple notifications, each with its own
notification delay, Ops Manager uses the smallest delay value to determine when to
move an alert from TRACKING
to OPEN
.
Endpoints¶
Get All Global Alerts¶
To specify alert status, use the status
query parameter with one of the
following values:
TRACKING
OPEN
CLOSED
The status
parameter cannot retrieve CANCELLED
global alerts.
Get a Specific Global Alert¶
Acknowledge an Alert¶
To acknowledge a global alert, use PATCH
to update the alert’s acknowledgedUntil
field. You can optionally update the acknowledgementComment
field with a
comment. Do not include any other field in the PATCH
request.
To acknowledge an alert “forever”, set the field value to 100 years in the future. To unacknowledge a previously acknowledged alert, set the field value to the past.
If you add a comment in the acknowledgementComment
field, Ops Manager
displays the comment next to the message that the alert has been acknowledged.
Sample Entity¶
The following is an example return document. The fields in a return document depend on the alert type.
Entity Fields¶
Name | Type | Description |
---|---|---|
id | string | Unique identifier. |
groupId | string | Unique identifier of the group that this alert was opened for. |
alertConfigId | string | Unique identifier of the global alert configuration that triggered this alert. |
created | date | When the alert was opened. |
eventTypeName | string | The name of the event that triggered the alert. To review the types of events that generate alerts, see Alert Types |
lastNotified | date | When the last notification was sent for this alert. Only present if notifications have been sent. |
replicaSetName | string | Name of the replica set. Only present for global alerts of type
HOST , HOST_METRIC , BACKUP , and REPLICA_SET . |
resolved | date | When the alert was closed. Only present if the status is CLOSED . |
sourceTypeName | string | For global alerts of the type
|
status | string | The current state of the alert. Possible values are:
|
tags | array of strings | The tags associated with the alert. |
typeName | string | This field is deprecated and will be ignored. |
updated | date | When the alert was last updated. |
acknowledgedUntil | date | The date through which the alert has been acknowledged. Only present if the alert has been acknowledged. |
acknowledgementComment | string | The comment left by the user who acknowledged the alert. Only present if the alert has been acknowledged. |
acknowledgingUsername | string | The username of the user who acknowledged the alert. Only present if the alert has been acknowledged. |
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 | Unique identifier of the host to which the metric pertains. Only present for
alerts of type HOST , HOST_METRIC , and REPLICA_SET . |
metricName | string | The name of the measurement whose value went outside the threshold. Only
present if For possible values, see Measurement Types for Global Alerts on this page. |
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:
|
clusterId | string | The Unique identifier 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 . |
Measurement Types for Global Alerts¶
The globalAlerts
resource returns measurement types in the metricName
field.
The field is present only if eventTypeName
is set to
OUTSIDE_METRIC_THRESHOLD
.
Host Measurements¶
|
Rate of asserts for a MongoDB process found in the
asserts document that the
serverStatus
command generates. |
|
Amount of data flushed in the background. |
|
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. |
|
Number of connections to a MongoDB process found in the
connections document that the
serverStatus
command generates. |
|
Number of cursors for a MongoDB
process found in the metrics.cursor document
that the
serverStatus
command generates. |
|
Numbers of Memory Issues and Page Faults for a MongoDB
process. |
|
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. |
|
Number of index btree operations. |
|
Number of journaling operations. |
|
Amount of memory for a MongoDB process found in the
mem document that the
serverStatus command collects. |
|
Amount of throughput for MongoDB process found in the
network document that the
serverStatus command collects. |
|
Durations and throughput of the MongoDB process’ oplog. |
|
Number of database operations on a MongoDB process since the process last started. |
|
Rate of database operations on a MongoDB process since the
process last started found in the opcounters document that the
serverStatus command collects. |
|
Rate of database operations on MongoDB
secondaries found in the
opcountersRepl document that the
serverStatus
command collects. |
|
Average rate of documents returned, inserted, updated, or deleted per second during a selected time period. |
|
Average rate for operations per second during a selected time period that perform a sort but cannot perform the sort using an index. |
|
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. |
|
Number of times the host restarted within the previous hour. |
|
Average rate per second to scan index items during
queries and query-plan evaluations found in the value of
totalKeysExamined from the
explain command. |
|
Average rate of documents scanned per second during queries
and query-plan evaluations found in the value of
totalDocsExamined from the
explain command. |
|
Ratio of the number of index items scanned to the number of documents returned. |
|
Ratio of the number of documents scanned to the number of documents returned. |
Links¶
Relation | Description |
---|---|
self | Me |