Navigation

Alpha Release of MongoDB CLI

This is a pre-release early version of MongoDB CLI. Do not use MongoDB CLI to manage production environments.

mongocli atlas alerts describe

On this page

The alerts describe command retrieves one alert for the specified Atlas project.

Syntax

mongocli atlas alert|alerts describe <alertID>
     [ --profile|-P <profile-name> ]
     [ --projectId <id-of-project> ]

Options

Option Type Description Required?
<alertID> string Unique identifier of the alert you want to describe. yes
--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 that contains the alert to describe. If omitted, uses the project ID in the profile or environment variable. yes

Output

The command prints the following fields in JSON format to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.

Name Type Description
id string Unique identifier for the alert.
groupId string ID of the project for which this alert was opened.
alertConfigId string ID of the alert configuration that triggered this alert.
eventTypeName string The name of the event that triggered the alert. The possible values depend on the alert type.
status string

The current state of the alert. Possible values are:

TRACKING Alert conditions exist, but the condition hasn’t persisted for long enough to trigger an alert.
OPEN Alert is open.
CLOSED Alert is closed.
CANCELLED Alert is cancelled.
created date Timestamp in ISO 8601 date and time format in UTC when this alert was created.
updated date Timestamp in ISO 8601 date and time format in UTC when this alert was last updated.
lastNotified date Timestamp in ISO 8601 date and time format in UTC when the last notification was sent for this alert. Only present if notifications have been sent.
resolved date Timestamp in ISO 8601 date and time format in UTC when the alert was closed. Only present if the status is CLOSED.
acknowledgedUntil date Timestamp in ISO 8601 date and time format in UTC through which the alert has been acknowledged. This is not present if the alert has never been acknowledged.
acknowledgementComment string The comment left by the user who acknowledged the alert. This is not present if the alert has never been acknowledged.
acknowledgingUsername string The username of the user who acknowledged the alert. This is not present if the alert has never been acknowledged.
hostnameAndPort string The hostname and port of the host to which the alert applies.
metricName string

The name of the metric whose value went outside the threshold. Only present if eventTypeName 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
currentValue object The current value of the metric that triggered the alert. Only present if eventTypeName is OUTSIDE_METRIC_THRESHOLD.
currentValue.number float The value.
currentValue.units string

The units for the value. Possible units are:

  • RAW
  • BITS
  • BYTES
  • KILOBITS
  • KILOBYTES
  • MEGABITS
  • MEGABYTES
  • GIGABITS
  • GIGABYTES
  • TERABYTES
  • PETABYTES
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
replicaSetName string Name of the replica set, if applicable.
clusterName string The name the cluster to which this alert applies.

Example

The following example uses the mongocli atlas describe command to describe one alert that occurred for the specified project. It uses the profile named myprofile for accessing Atlas.

mongocli atlas alerts describe 5df914cf105eef21d36f8d01 \
--projectId 5df90590f10fab5e33de2305 --profile myprofile

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

{
     "id": "5df914cf105eef21d36f8d01",
     "groupId": "5df90590f10fab5e33de2305",
     "alertConfigId": "5df90590f10fab5e33de2306",
     "eventTypeName": "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
     "created": "2019-12-17T17:47:59Z",
     "updated": "2020-05-01T20:24:15Z",
     "resolved": "2019-12-17T17:48:30Z",
     "status": "CLOSED",
     "lastNotified": "2020-05-01T20:24:15Z",
     "acknowledgedUntil": "2120-06-02T21:23:15Z",
     "acknowledgingUsername": "mfnrwcia",
     "replicaSetName": "Cluster0-shard-0"
}