Obter todos os alertas

Nesta página

Recurso

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
documento de resposta
results documento incorporado
Tipos de medição para alertas
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

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

Recurso

GET /groups/{PROJECT-ID}/alerts

Parâmetros do caminho da solicitação

Parâmetro	Tipo	Descrição
ID do projeto	string	(Obrigatório.) Identificador do projeto.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição	default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `results` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como `false` para incluir configurações de daemon com o sinalizador `backupJobsEnabled` definido como `false`.	`true`

Nome	Tipo	necessidade	Descrição
`status`	string	Opcional	Especifique um status para retornar apenas os alertas com o status especificado. Omitir para retornar todos os alertas. O Ops Manager aceita os seguintes valores: `TRACKING` Para retornar alertas com status `TRACKING` . Se aconfiguração de um alerta especificar um atraso de notificação, o Ops Manager atribuirá ao alerta o status `TRACKING` até que o período de atraso termine. Após o atraso, o Ops Manager define o status para `OPEN`, se a condição persistir. Se a configuração de um alerta tiver várias notificações, cada uma com seu próprio atraso de notificação, o Ops Manager usará o menor valor de atraso para determinar quando mover o alerta de `TRACKING` para `OPEN`. `OPEN` Para retornar todos os alertas abertos. `CLOSED` Para retornar todos os alertas fechados.

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção Documento incorporado`results` .
`links`	array	A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
`totalCount`	número	Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

`results` documento incorporado

Cada resultado é um alerta.

Nome	Tipo	Descrição
`acknowledged` `Until`	string	Carimbo de data/hora na ISO 8601 formato de data e hora no UTC até o qual o alerta foi confirmado. O Ops Manager retorna esse valor se o alerta tiver sido confirmado.
`acknowledgement` `Comment`	string	Comentário deixado pelo usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado.
`acknowledging` `Username`	string	Nome de usuário do usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado.
`alertConfigId`	string	Identificador exclusivo para a configuração de alerta que acionou este alerta.
`clusterId`	string	Identificador único do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nome do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi aberto.
`currentValue`	objeto	Valor atual da métrica que acionou o alerta. O Ops Manager retorna esse valor se `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
`currentValue` `.number`	número	Valor da métrica.
`currentValue` `.units`	string	Unidades para o valor. O valor depende do tipo de métrica. Exemplo Uma métrica que mede o consumo de memória teria uma medida de bytes, enquanto uma métrica que mede o tempo teria uma unidade de tempo. O Ops Manager pode retornar: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	string	Nome do evento que acionou o alerta. Para revisar os tipos de eventos que geram alertas, consulte Tipos de Alerta. Para obter uma lista completa de eventos incluídos no registro de auditoria do Ops Manager, consulte Eventos de auditoria.
`groupId`	string	Identificador único do grupo para o qual este alerta foi aberto.
`hostId`	string	identificador exclusivo do host ao qual a métrica pertence. O Ops Manager retorna este valor se `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	Nome do host e porta de cada host ao qual o alerta se aplica. Pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . O Ops Manager retorna este valor se `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	Identificador único para o alerta.
`lastNotified`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a última notificação foi enviada para este alerta. MongoDB Ops Manager retorna esse valor se notificações tiverem sido enviadas.
`links`	Array de objetos	Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
`metricName`	string	Nome da medição cujo valor ficou fora do limite. O Ops Manager retorna esse valor se `"eventTypeName"` tiver sido definido como `OUTSIDE_METRIC_THRESHOLD`. Para obter os valores possíveis, consulte Tipos de medição para alertas.
`replicaSetName`	string	Nome do conjunto de réplicas. O Ops Manager retorna este valor se `"eventTypeName"` foi definido para um dos seguintes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. O Ops Manager retorna esse valor se `"status" : "CLOSED"`.
`status`	string	Estado atual do alerta. O Ops Manager pode retornar um dos seguintes: `TRACKING` A condição de alerta existe, mas não persiste além do atraso de notificação definido. Para obter detalhes, consulte Solicitar parâmetros de query. `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	Tipo de host que está sendo copiado quando `"eventTypeName" : "BACKUP"`. O Ops Manager pode retornar um dos seguintes: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	array de strings	Identificar rótulos definidos para este alerta.
`typeName`	string	Campo obsoleto. \|mms\| ignora.
`updated`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi atualizado pela última vez.

Tipos de medição para alertas

O recurso alerts retorna tipos de medição no campo metricName . O campo está presente somente se eventTypeName estiver definido como OUTSIDE_METRIC_THRESHOLD.

Medições do host

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	Taxa de afirmações de um processo MongoDB encontrado no documento `asserts` que o comando serverStatus gera.
`BACKGROUND_FLUSH_AVG`	Quantidade de dados liberados em segundo plano.
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_DIRTY_BYTES` `CACHE_USED_BYTES` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITE`	Quantidade de bytes no WiredTiger storage engine cache do `wiredTiger.cache` e tickets encontrados nos documentos do e `wiredTiger.concurrentTransactions` que o comando serverStatus gera.
`CONNECTIONS`	Número de conexões a um processo MongoDB encontradas no documento `connections` que o comando serverStatus gera.
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	Número de cursores para um processo MongoDB encontrado no documento `metrics.cursor` que o comando serverStatus gera.
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	Números de `Memory Issues` e `Page Faults` para um processo MongoDB.
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	Número de operações aguardando travas para o processo MongoDB que o comando serverStatus gera. O Ops Manager calcula esses valores com base no tipo de mecanismo de armazenamento.
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	Número de operações do índice b.
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	Número de operações de registro no diário.
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	Quantidade de memória para um processo MongoDB localizado no documento `mem` que o comando serverStatus coleta.
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	Quantidade de rendimento para o processo MongoDB encontrada no documento `network` que o comando serverStatus coleta.
`OPLOG_RATE_GB_PER_HOUR` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_SLAVE_LAG_MASTER_TIME`	Durações e taxa de transferência do oplog do processo MongoDB.
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	Espaço de armazenamento no disco conforme coletado do comando MongoDB `dbStats` .
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	Taxa de operações de banco de dados em um processo MongoDB desde a última vez que o processo foi iniciado, encontrado no documento `opcounters` que o comando serverStatus coleta.
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	Taxa de operações de banco de dados em secundários MongoDB encontrados no documento `opcountersRepl` que o comando serverStatus coleta.
`DOCUMENT_METRICS_RETURNED` `DOCUMENT_METRICS_INSERTED` `DOCUMENT_METRICS_UPDATED` `DOCUMENT_METRICS_DELETED`	Taxa média de documentos devolvidos, inseridos, atualizados ou excluídos por segundo durante um período selecionado.
`OPERATIONS_SCAN_AND_ORDER`	Taxa média de operações por segundo durante um período de tempo selecionado que executa uma classificação, mas não pode executá-la usando um índice.
`OP_EXECUTION_TIME_READS` `OP_EXECUTION_TIME_WRITES` `OP_EXECUTION_TIME_COMMANDS`	Tempo médio de execução em milissegundos por operação de leitura, gravação ou comando durante um período de tempo selecionado. Disponível para hosts que executam o MongoDB 3.4 ou posterior.
`RESTARTS_IN_LAST_HOUR`	Número de vezes que o host reiniciou na hora anterior.
`SYSTEM_MEMORY_USED` `SYSTEM_MEMORY_FREE` `SYSTEM_MEMORY_AVAILABLE`	Uso de memória física, em bytes.
`SYSTEM_NETWORK_BYTES_IN` `SYSTEM_NETWORK_BYTES_OUT`	Taxa de transferência da rede em bytes por segundo.
`SWAP_USAGE_USED` `SWAP_USAGE_FREE`	Quantidade total de espaço de troca em uso.

`QUERY_EXECUTOR_SCANNED`	Taxa média por segundo para verificar itens de índice durante queries e avaliações do plano de query encontradas no valor de `totalKeysExamined` do comando explain .
`QUERY_EXECUTOR_SCANNED_OBJECTS`	Taxa média de documentos digitalizados por segundo durante queries e avaliações do plano de query encontradas no valor de `totalDocsExamined` do comando de explicação .
`QUERY_TARGETING_SCANNED_PER_RETURNED`	Proporção do número de itens de índice digitalizados para o número de documentos devolvidos.
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	Proporção do número de documentos digitalizados para o número de documentos devolvidos.

Exemplo de solicitação

O seguinte retorna todos os alertas OPEN :

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

1 {
2   "links" : [ {
3     "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "alertConfigId" : "5953c5f380eef53887615fd4",
8     "created" : "2019-07-18T23:43:50Z",
9     "eventTypeName" : "MONITORING_AGENT_DOWN",
10     "groupId" : "{PROJECT-ID}",
11     "id" : "5d31043680eef5280d3664e0",
12     "lastNotified" : "2019-09-25T11:50:08Z",
13     "links" : [ {
14       "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0",
15       "rel" : "self"
16     } ],
17     "status" : "OPEN",
18     "tags" : [ ],
19     "typeName" : "AGENT",
20     "updated" : "2019-07-18T23:43:50Z"
21   } ],
22   "totalCount" : 1
23 }

Voltar

Alertas

Obter um alerta

1	{
2	"links" : [ {
3	"href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"alertConfigId" : "5953c5f380eef53887615fd4",
8	"created" : "2019-07-18T23:43:50Z",
9	"eventTypeName" : "MONITORING_AGENT_DOWN",
10	"groupId" : "{PROJECT-ID}",
11	"id" : "5d31043680eef5280d3664e0",
12	"lastNotified" : "2019-09-25T11:50:08Z",
13	"links" : [ {
14	"href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0",
15	"rel" : "self"
16	} ],
17	"status" : "OPEN",
18	"tags" : [ ],
19	"typeName" : "AGENT",
20	"updated" : "2019-07-18T23:43:50Z"
21	} ],
22	"totalCount" : 1
23	}

Obter todos os alertas.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-fmznk8{margin-top:-85px;position:absolute;padding-bottom:2px;}