Navigation

mongocli atlas alerts describe

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

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

Use -h or --help to view the command-line help for this command.

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

yes

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

Name
Type
Description
acknowledgedUntil
date
Timestamp in ISO 8601 date and time format in UTC through which the alert has been acknowledged. mongocli returns this value after the alert has been acknowledged.
acknowledgementComment
string
Comment left by the user who acknowledged the alert. mongocli returns this value after the alert has been acknowledged.
acknowledgingUsername
string
Username of the user who acknowledged the alert. mongocli returns this value after the alert has been acknowledged.
alertConfigId
string
Unique identifier of the alert configuration that triggered this alert.
clusterName
string
Name the cluster to which this alert applies.
created
date
Timestamp in ISO 8601 date and time format in UTC when this alert was created.
currentValue
object
Current value of the metric that triggered the alert. mongocli returns this value if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".
currentValue.number
float
Value.
currentValue.units
string

Units for the value. Possible units are:

  • RAW
  • BITS
  • BYTES
  • KILOBITS
  • KILOBYTES
  • MEGABITS
  • MEGABYTES
  • GIGABITS
  • GIGABYTES
  • TERABYTES
  • PETABYTES
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
eventTypeName
string
Name of the event that triggered the alert. The possible values depend on the alert type.
groupId
string
Unique identifier of the project for which this alert was opened.
hostnameAndPort
string
Hostname and port of the host to which the alert applies.
id
string
Unique identifier for the alert.
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.
metricName
string

Name of the metric whose value went outside the threshold. mongocli returns this value if "eventTypeName" : "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
replicaSetName
string
Name of the replica set, if applicable.
resolved
date
Timestamp in ISO 8601 date and time format in UTC when the alert was closed. mongocli returns this value if "status" : "CLOSED".
status
string

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.
updated
date
Timestamp in ISO 8601 date and time format in UTC when this alert was last updated.

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

mongocli atlas alerts describe 5df914cf105eef21d36f8d01 -o json \
--projectId 5df90590f10fab5e33de2305

The previous command prints the following fields in the specified 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"
}
Give Feedback