Navigation

mongocli ops-manager alerts settings list

On this page

The alerts settings list command retrieves all the alerts configured in the specified Ops Manager project. You can also retrieve all the alerts configured in a project through the Ops Manager API.

Syntax

mongocli ops-manager|om alerts settings|config list|ls
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <id-of-project> ]
     [ --page <page-number> ]
     [ --limit <items-per-page> ]

Options

Option Type Description Required?
--output, -o string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

no
--profile, -P string Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI. no
--projectId string

Unique identifier of the project containing the alert configurations you want to retrieve.

Note

You can retrieve the list of projects, including their IDs, using the mongocli iam project list command.

no
--page integer Page number (1-based). Defaults to 1 if not specified. no
--limit integer Number of items to return per page, up to a maximum of 500. Defaults to 100 if not specified. no

Output

If the command succeeds, it prints the subset of the following fields to the terminal in the specified format that describe each alert configuration. If the command returns an error, see Troubleshooting for recommended solutions.

Name Type Description
created string Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
enabled boolean Flag indicating this alert configuration enabled.
eventTypeName string

Type of event that triggers an alert.

For a complete list of alert events, see Alert Conditions.

groupId string Unique identifier of the Project that owns this alert configuration.
id string Unique identifier for this alert configuration.
matchers.fieldName string

Name of the field in the target object to match on.

Use the List alert configuration matcher fields to return the possible values.

matchers.operator string

Operator to test the field’s value. Accepted values are:

  • EQUALS
  • NOT_EQUALS
  • CONTAINS
  • NOT_CONTAINS
  • STARTS_WITH
  • ENDS_WITH
  • REGEX
matchers.value string

Value to test with the specified operator.

If matcherFieldName is set to TYPE_NAME, you can match on the following values:

  • PRIMARY
  • SECONDARY
  • STANDALONE
  • CONFIG
  • MONGOS
matchers object array

Rules to apply when matching an object against this alert configuration. Only entities that match all these rules are checked for an alert condition.

You can filter using the matchers array only when the eventTypeName specifies an event for a host, replica set, or sharded cluster.

metricThreshold.metricName string

The name of the metric whose value went outside the threshold. Only applicable if --event is OUTSIDE_METRIC_THRESHOLD. Possible values are:

  • ASSERT_MSG
  • ASSERT_REGULAR
  • ASSERT_USER
  • ASSERT_WARNING
  • BACKGROUND_FLUSH_AVG
  • CACHE_BYTES_READ_INTO
  • CACHE_BYTES_WRITTEN_FROM
  • CACHE_DIRTY_BYTES
  • CACHE_USED_BYTES
  • COMPUTED_MEMORY
  • CONNECTIONS
  • CURSORS_TOTAL_CLIENT_CURSORS_SIZE
  • CURSORS_TOTAL_OPEN
  • CURSORS_TOTAL_TIMED_OUT
  • DB_DATA_SIZE_TOTAL
  • DB_STORAGE_TOTAL
  • DISK_PARTITION_SPACE_USED_DATA
  • DISK_PARTITION_SPACE_USED_INDEX
  • DISK_PARTITION_SPACE_USED_JOURNAL
  • DISK_PARTITION_UTILIZATION_DATA
  • DISK_PARTITION_UTILIZATION_INDEX
  • DISK_PARTITION_UTILIZATION_JOURNAL
  • EXTRA_INFO_PAGE_FAULTS
  • GLOBAL_ACCESSES_NOT_IN_MEMORY
  • GLOBAL_LOCK_CURRENT_QUEUE_READERS
  • GLOBAL_LOCK_CURRENT_QUEUE_TOTAL
  • GLOBAL_LOCK_CURRENT_QUEUE_WRITERS
  • GLOBAL_LOCK_PERCENTAGE
  • GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN
  • INDEX_COUNTERS_BTREE_ACCESSES
  • INDEX_COUNTERS_BTREE_HITS
  • INDEX_COUNTERS_BTREE_MISS_RATIO
  • INDEX_COUNTERS_BTREE_MISSES
  • JOURNALING_COMMITS_IN_WRITE_LOCK
  • JOURNALING_MB
  • JOURNALING_WRITE_DATA_FILES_MB
  • LOGICAL_SIZE
  • MEMORY_RESIDENT
  • MEMORY_VIRTUAL
  • MEMORY_MAPPED
  • NETWORK_BYTES_IN
  • NETWORK_BYTES_OUT
  • NETWORK_NUM_REQUESTS
  • NORMALIZED_SYSTEM_CPU_USER
  • OPCOUNTER_CMD
  • OPCOUNTER_DELETE
  • OPCOUNTER_INSERT
  • OPCOUNTER_QUERY
  • OPCOUNTER_REPL_UPDATE
  • OPCOUNTER_REPL_DELETE
  • OPCOUNTER_REPL_INSERT
  • OPCOUNTER_UPDATE
  • OPLOG_MASTER_LAG_TIME_DIFF
  • OPLOG_MASTER_TIME
  • OPLOG_RATE_GB_PER_HOUR
  • OPLOG_SLAVE_LAG_MASTER_TIME
  • RESTARTS_IN_LAST_HOUR
  • TICKETS_AVAILABLE_READS
  • TICKETS_AVAILABLE_WRITES
metricThreshold.mode string Average value of this metric.
metricThreshold.operator string

Operator to apply when checking the current metric value against the threshold value. Accepted values are:

  • GREATER_THAN
  • LESS_THAN
metricThreshold.threshold number Threshold value outside of which an alert is triggered.
metricThreshold.units string

Units for the threshold value. Depends on the type of metric.

Example

A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.

Accepted values are:

  • RAW
  • BITS
  • BYTES
  • KILOBITS
  • KILOBYTES
  • MEGABITS
  • MEGABYTES
  • GIGABITS
  • GIGABYTES
  • TERABYTES
  • PETABYTES
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
metricThreshold object Threshold that will cause an alert to be triggered. Populated if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".
notifications.apiToken string Slack API token or Bot token. Populated for SLACK notifications. If the token later becomes invalid, Ops Manager sends an email to the Project owner and eventually removes the token.
notifications.channelName string Slack channel name. Populated for SLACK notifications.
notifications.datadogApiKey string DataDog API Key. Found in the DataDog dashboard. Populated for DATADOG notifications.
notifications.delayMin number Number of minutes to wait after an alert condition is detected before sending out the first notification.
notifications.emailAddress string Email address to which to send notification. Populated for EMAIL notifications.
notifications.emailEnabled boolean Flag indicating email notifications must be sent. Populated for ORG, GROUP, and USER notifications.
notifications.flowdockApiToken string Flowdock “personal API token.” Populated for FLOWDOCK notifications. If the token later becomes invalid, Ops Manager sends an email to the Project owner and eventually removes the token.
notifications.flowName string Flow name, in lower-case letters. Populated for FLOWDOCK notifications. The flow name appears after the organization name in the URL string: www.flowdock.com/app/<organization-name>/<flow-name>.
notifications.intervalMin number Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved.
notifications.notificationToken string HipChat API token. Populated for HIP_CHAT notifications. If the token later becomes invalid, Ops Manager sends an email to the Project owner and eventually removes the token.
notifications.orgName string Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Populated for FLOWDOCK notifications.
notifications.role string Ops Manager role in current Project. Populated for GROUP notifications.
notifications.roomName string HipChat room name. Populated for HIP_CHAT notifications.
notifications.serviceKey string PagerDuty service key. Populated for PAGER_DUTY notifications. If the key later becomes invalid, Ops Manager sends an email to the Project owner and eventually removes the key.
notifications.smsEnabled boolean Flag indicating SMS notifications must be sent. Populated for ORG, GROUP, and USER notifications.
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). Populated for SNMP notifications. Ops Manager uses SNMP v2c.
notifications.typeName string

Type of alert notification. Accepted values are:

  • DATADOG
  • EMAIL
  • FLOWDOCK
  • GROUP (Project)
  • HIPCHAT
  • OPS_GENIE
  • ORG
  • PAGER_DUTY
  • SLACK
  • SMS
  • SNMP
  • USER
  • VICTOR_OPS
  • WEBHOOK
notifications.username string Name of an Ops Manager user to which to send notifications. Only a user in the Project that owns the alert configuration is allowed here. Populated for USER notifications.
notifications object array Notifications to send when an alert condition is detected.
threshold.operator string

Operator to apply when checking the current metric value against the threshold value.

  • GREATER_THAN
  • LESS_THAN
threshold.threshold number Threshold value outside of which an alert is triggered.
threshold object

Threshold that will cause an alert to be triggered. Populated if

  • "eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"
  • "eventTypeName" : "TOO_MANY_UNHEALTHY_MEMBERS"
typeName string This field is deprecated and are ignored.
updated string Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

Example

The following example uses the mongocli om alerts settings list command to retrieve the list of alerts configured in the specified project. It uses the default profile to access the Ops Manager project.

mongocli om alerts settings list --projectId 5e4434626e68f6755b594125 --output json

The previous command prints the following fields in the specified format to the terminal. To learn more about these fields, see Output.

[
 {
  "id": "5e549e057e63a2007ac74680",
  "groupId": "5e4434626e68f6755b594125",
  "eventTypeName": "MONITORING_AGENT_DOWN",
  "created": "2020-02-25T04:09:41Z",
  "updated": "2020-02-25T04:09:41Z",
  "enabled": true,
  "notifications": [
   {
    "delayMin": 0,
    "emailEnabled": true,
    "intervalMin": 60,
    "smsEnabled": false,
    "typeName": "GROUP"
   }
  ]
 },
 {
  "id": "5e549e057e63a2007ac74681",
  "groupId": "5e4434626e68f6755b594125",
  "eventTypeName": "HOST_SSL_CERTIFICATE_STALE",
  "created": "2020-02-25T04:09:41Z",
  "updated": "2020-02-25T04:09:41Z",
  "enabled": true,
  "notifications": [
   {
    "delayMin": 0,
    "emailEnabled": true,
    "intervalMin": 1440,
    "smsEnabled": false,
    "typeName": "GROUP"
   }
  ]
 },
 {
  "id": "5e549e057e63a2007ac74682",
  "groupId": "5e4434626e68f6755b594125",
  "eventTypeName": "JOINED_GROUP",
  "created": "2020-02-25T04:09:41Z",
  "updated": "2020-02-25T04:09:41Z",
  "enabled": true,
  "notifications": [
   {
    "delayMin": 0,
    "emailEnabled": true,
    "intervalMin": 60,
    "smsEnabled": false,
    "typeName": "GROUP"
   }
  ]
 }
]