Docs Menu
Docs Home
/ /

Recibe una alerta

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/alerts/{ALERT-ID}
Parameter
Tipo
Descripción

PROJECT-ID

string

(Obligatorio.) Identificador del proyecto.

ALERT-ID

string

(Obligatorio.) Identificador de alerta.

Los siguientes parámetros de consulta son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuestaHTTP

content

Cuerpo de respuesta esperado

false

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Los campos del documento de devolución dependen del tipo de alerta:

Nombre
Tipo
Descripción
acknowledged
Until

string

Marca de tiempo en formato ISO 8601 fecha y hora en UTC hasta la cual se ha reconocido la alerta.

Ops Manager devuelve este valor si se ha reconocido la alerta.

acknowledgement
Comment

string

Comentario dejado por el usuario que reconoció la alerta.

Ops Manager devuelve este valor si se ha reconocido la alerta.

acknowledging
Username

string

Nombre de usuario del usuario que reconoció la alerta.

Ops Manager devuelve este valor si se ha reconocido la alerta.

alertConfigId

string

Identificador único para la configuración de alerta que activó esta alerta.

clusterId

string

Identificador único del clúster al que se aplica esta alerta.

Ops Manager devuelve este valor si "eventTypeName" : "SHARDED_CLUSTER"

clusterName

string

Nombre del clúster al que se aplica esta alerta.

Ops Manager devuelve este valor si "eventTypeName" : "SHARDED_CLUSTER"

created

string

Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se abrió la alerta.

currentValue

Objeto

Valor actual de la métrica que activó la alerta.

Ops Manager devuelve este valor si "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

currentValue
.number

Número

Valor de la métrica.

currentValue
.units

string

Unidades para el valor. El valor depende del tipo de métrica.

Por ejemplo, una métrica que mide el consumo de memoria tendría una medida de byte, mientras que una métrica que mide el tiempo tendría una unidad de tiempo.

El administrador de operaciones puede devolver:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName

string

Nombre del evento que activó la alerta.

Los valores aceptados son:

Agente

Configuración de automatización

Backup - BAD_CLUSTERSHOTS - CLUSTER_BLACKLIST_UPDATED_AUDIT - CLUSTER_CHECKKPOINT_UPDATED_AUDIT - CLUSTER_CREDENTIAL_UPDATED_AUDIT - CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT - CLUSTER_STATE_CHANGED_AUDIT - CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT - CLUSTERSHOT_DELETED_AUDIT - CLUSTERSHOT_EXPIRY_UPDATED_AUDIT - CONSISTENT_BACKUP_CONFIGURATION - GOOD_CLUSTERSHOT - INCONSISTENT_BACKUP_CONFIGURATION - INITIAL_SYNC_FINISHED_AUDIT - INITIAL_SYNC_STARTED_AUDIT - OPLOG_BEHIND - OPLOG_CURRENT - RESTORE_REQUESTED_AUDIT - RESYNC_PERFORMED - RESYNC_REQUIRED - RS_BLACKLIST_UPDATED_AUDIT - RS_CREDENTIAL_UPDATED_AUDIT - RS_ROTATE_MASTER_KEY_AUDIT - RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT - RS_STATE_CHANGED_AUDIT - RS_STORAGE_ENGINE_UPDATED_AUDIT - SNAPSHOT_DELETED_AUDIT - SNAPSHOT_EXPIRY_UPDATED_AUDIT - SYNC_PENDING_AUDIT - SYNC_REQUIRED_AUDIT

Conector de BI

Clúster

Explorador de datos accedido

Host

Organización

Proyecto

Set de réplicas

Equipo

Usuario

Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulte Eventos de auditoría.

groupId

string

Identificador único del grupo para el que se abrió esta alerta.

hostId

string

Identificador único del host al que pertenece la métrica.

Ops Manager devuelve este valor si "eventTypeName" se configuró en uno de los siguientes:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

hostnameAndPort

string

Nombre de host y puerto de cada host al que se aplica la alerta. Puede ser un nombre de host, un FQDN, una dirección IPv o4 una dirección IPv.6

Ops Manager devuelve este valor si "eventTypeName" se configuró en uno de los siguientes:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

id

string

Identificador único para la alerta.

lastNotified

string

Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último envío de notificaciones para esta alerta. Ops Manager devuelve este valor si se enviaron notificaciones.

links

matriz de objetos

Uno o más enlaces a subrecursos o recursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace self llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

metricName

string

Nombre de la medida cuyo valor salió del umbral.

Ops Manager devuelve este valor si "eventTypeName" se configuró en OUTSIDE_METRIC_THRESHOLD.

Para conocer los valores posibles, consulte Tipos de medición para alertas.

replicaSetName

string

Nombre del conjunto de réplicas.

Ops Manager devuelve este valor si "eventTypeName" se configuró en uno de los siguientes:

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved

string

Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se cerró la alerta.

Ops Manager devuelve este valor si "status" : "CLOSED".

status

string

Estado actual de la alerta. Ops Manager puede devolver uno de los siguientes:

  • TRACKING

    La condición de alerta existe, pero no ha persistido más allá del plazo de notificación definido. Para más detalles, consulte Parámetros de consulta de solicitud.

  • OPEN

  • CLOSED

  • CANCELLED

sourceTypeName

string

Tipo de host del que se realiza la copia de seguridad cuando "eventTypeName" : "BACKUP". Ops Manager puede devolver uno de los siguientes valores:

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

tags

matriz de cadenas

Etiquetas de identificación establecidas para esta alerta.

updated

string

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó la alerta por última vez.

El recurso alerts devuelve los tipos de medición en el campo metricName. Este campo solo está presente si eventTypeName se establece en OUTSIDE_METRIC_THRESHOLD.

  • ASSERT_REGULAR

  • ASSERT_WARNING

  • ASSERT_MSG

  • ASSERT_USER

Tasa de afirmaciones para un proceso MongoDB que se encuentra en el asserts documento que genera el comando serverStatus.

  • BACKGROUND_FLUSH_AVG

Cantidad de datos descargados en segundo plano.

  • CACHE_BYTES_READ_INTO

  • CACHE_BYTES_WRITTEN_FROM

  • CACHE_DIRTY_BYTES

  • CACHE_USED_BYTES

  • TICKETS_AVAILABLE_READS

  • TICKETS_AVAILABLE_WRITE

Cantidad de bytes en la memoria caché del motor de almacenamiento WiredTiger y los tickets encontrados en wiredTiger.cache wiredTiger.concurrentTransactions los documentos y que genera el comando serverStatus.

  • CONNECTIONS

Número de conexiones a un proceso MongoDB encontradas en el connections documento que genera el comando serverStatus.

  • CURSORS_TOTAL_OPEN

  • CURSORS_TOTAL_TIMED_OUT

Número de cursores para un proceso MongoDB encontrado en el metrics.cursor documento que genera el comando serverStatus.

  • EXTRA_INFO_PAGE_FAULTS

  • GLOBAL_ACCESSES_NOT_IN_MEMORY

  • GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN

Números de Memory Issues y Page Faults para un proceso MongoDB.

  • GLOBAL_LOCK_CURRENT_QUEUE_TOTAL

  • GLOBAL_LOCK_CURRENT_QUEUE_READERS

  • GLOBAL_LOCK_CURRENT_QUEUE_WRITERS

Número de operaciones en espera de bloqueos para el proceso de MongoDB que genera el comando serverStatus. Ops Manager calcula estos valores en función del tipo de motor de almacenamiento.

  • INDEX_COUNTERS_BTREE_ACCESSES

  • INDEX_COUNTERS_BTREE_HITS

  • INDEX_COUNTERS_BTREE_MISSES

  • INDEX_COUNTERS_BTREE_MISS_RATIO

Número de operaciones de índice btree.

  • JOURNALING_COMMITS_IN_WRITE_LOCK

  • JOURNALING_MB

  • JOURNALING_WRITE_DATA_FILES_MB

Número de operaciones de registro en diario.

  • MEMORY_RESIDENT

  • MEMORY_VIRTUAL

  • MEMORY_MAPPED

  • COMPUTED_MEMORY

Cantidad de memoria para un proceso MongoDB que se encuentra en el mem documento que recopila el comando serverStatus.

  • NETWORK_BYTES_IN

  • NETWORK_BYTES_OUT

  • NETWORK_NUM_REQUESTS

Cantidad de rendimiento del proceso MongoDB que se encuentra en el network documento que recopila el comando serverStatus.

  • OPLOG_RATE_GB_PER_HOUR

  • OPLOG_MASTER_TIME

  • OPLOG_MASTER_LAG_TIME_DIFF

  • OPLOG_SLAVE_LAG_MASTER_TIME

Duración y rendimiento del registro de operaciones del proceso MongoDB.

  • DB_STORAGE_TOTAL

  • DB_DATA_SIZE_TOTAL

Espacio de almacenamiento en disco según lo recopilado por el comando MongoDB dbStats.

  • OPCOUNTER_CMD

  • OPCOUNTER_QUERY

  • OPCOUNTER_UPDATE

  • OPCOUNTER_DELETE

  • OPCOUNTER_GETMORE

  • OPCOUNTER_INSERT

Tasa de operaciones de base de datos en un proceso MongoDB desde el último inicio del proceso encontrado en el opcounters documento que recopila el comando serverStatus.

  • OPCOUNTER_REPL_CMD

  • OPCOUNTER_REPL_UPDATE

  • OPCOUNTER_REPL_DELETE

  • OPCOUNTER_REPL_INSERT

Tasa de operaciones de base de datos en los secundarios de MongoDB opcountersRepl que se encuentran en el documento que recopila el comando serverStatus.

  • DOCUMENT_METRICS_RETURNED

  • DOCUMENT_METRICS_INSERTED

  • DOCUMENT_METRICS_UPDATED

  • DOCUMENT_METRICS_DELETED

Tasa promedio de documentos devueltos, insertados, actualizados o eliminados por segundo durante un período de tiempo seleccionado.

  • OPERATIONS_SCAN_AND_ORDER

Tasa promedio de operaciones por segundo durante un período de tiempo seleccionado que realiza una ordenación, pero no puede realizar la ordenación utilizando un índice.

  • OP_EXECUTION_TIME_READS

  • OP_EXECUTION_TIME_WRITES

  • OP_EXECUTION_TIME_COMMANDS

Tiempo promedio de ejecución en milisegundos por operación de lectura, escritura o comando durante un período de tiempo seleccionado.

Disponible para hosts que ejecutan MongoDB 3.4 o posterior.

  • RESTARTS_IN_LAST_HOUR

Número de veces que el host se reinició durante la hora anterior.

  • SYSTEM_MEMORY_USED

  • SYSTEM_MEMORY_FREE

  • SYSTEM_MEMORY_AVAILABLE

Uso de memoria física, en bytes.

  • SYSTEM_NETWORK_BYTES_IN

  • SYSTEM_NETWORK_BYTES_OUT

Rendimiento de la red en bytes por segundo.

  • SWAP_USAGE_USED

  • SWAP_USAGE_FREE

Cantidad total de espacio swap en uso.

  • QUERY_EXECUTOR_SCANNED

Tasa promedio por segundo para escanear elementos del índice durante queries y evaluaciones del plan del query encontrada en el valor de totalKeysExamined del comando explain.

  • QUERY_EXECUTOR_SCANNED_OBJECTS

La velocidad promedio de documentos escaneados por segundo durante las consultas y evaluaciones del plan de consulta se encontró en el valor totalDocsExamined del comando explain.

  • QUERY_TARGETING_SCANNED_PER_RETURNED

Proporción entre el número de elementos de índices escaneados y el número de documentos devueltos.

  • QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED

Relación entre el número de documentos escaneados y el número de documentos devueltos.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-ID}"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{
"alertConfigId" : "5b43d04087d9d6357de591aa",
"created" : "2019-07-26T21:12:19Z",
"currentValue" : {
"number" : 100,
"units" : "RAW"
},
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"humanReadable" : "Project: testProj
Organization: testOrg
Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT.
Comment: N/A
Connections has gone below 1000
mycluster.example.com:27017
Created: 2019/10/17 15:26 GMT
Replica Set: cluster0-shard-0
Type: Primary
Current Value: 100"
"groupId" : "535683b3794d371327b",
"hostnameAndPort" : "mycluster.example.com:27017",
"id" : "533cb4b8e4b0f1820cdabc7f",
"lastNotified" : "2019-07-26T21:13:48Z",
"metricName" : "CONNECTIONS",
"replicaSetName" : "mycluster",
"resolved" : "2019-07-26T21:13:42Z",
"status" : "CLOSED",
"typeName" : "HOST_METRIC",
"updated" : "2019-07-26T21:13:42Z",
"links" : [ ... ]
}

Volver

Obtener todo

En esta página