Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/ /
Alertas
Página inicial do Docs
/ /
Medições e alertas
/
Alertas
Página inicial do Docs
/
Gestão
/
Cloud Manager
/
Recursos
/
Medições e alertas
/
Alertas

Obter todos os alertas

Observação

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

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

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 formato de impressão bonita.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query.

Para endpoints que retornam uma lista de resultados, o objeto content é um envelope. O Cloud 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 Cloud Manager aceita os seguintes valores:

  • TRACKING

    Para retornar alertas com status TRACKING . Se a configuração de um alert especificar um atraso de notificação, o Cloud Manager atribuirá ao alert o status TRACKING até que o período de atraso termine. Após o atraso, o Cloud Manager define o status como 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 Cloud 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

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

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

Registro de data/hora no formato de data e hora ISO 8601 até o momento em que o alerta foi confirmado.

O Cloud Manager retorna esse valor se o alerta tiver sido confirmado.

acknowledgement
Comment

string

Comentário deixado pelo usuário que reconheceu o alerta.

O Cloud 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 Cloud 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.

Cloud Manager retorna esse valor se "eventTypeName" : "SHARDED_CLUSTER"

clusterName

string

Nome do cluster ao qual este alerta se aplica.

Cloud Manager retorna esse valor se "eventTypeName" : "SHARDED_CLUSTER"

created

string

Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o alerta foi aberto.

currentValue

objeto

Valor atual da métrica que acionou o alerta.

O Cloud 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.

Por 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 Cloud 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.

Os valores aceitos são:

Agente

  • AUTOMATION_AGENT_DOWN

  • AUTOMATION_AGENT_UP

  • BACKUP_AGENT_CONF_CALL_FAILURE

  • BACKUP_AGENT_DOWN

  • BACKUP_AGENT_UP

  • BACKUP_AGENT_VERSION_BEHIND

  • BACKUP_AGENT_VERSION_CURRENT

  • MONITORING_AGENT_DOWN

  • MONITORING_AGENT_UP

  • MONITORING_AGENT_VERSION_BEHIND

  • MONITORING_AGENT_VERSION_CURRENT

  • NEW_AGENT

Configuração da automação

  • AUTOMATION_CONFIG_PUBLISHED_AUDIT

Backup.

  • BAD_CLUSTERSHOTS

  • CLUSTER_DENYLIST_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_DENYLIST_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

BI Connector

  • BI_CONNECTOR_DOWN

  • BI_CONNECTOR_UP

Cobrança

cluster

  • CLUSTER_MONGOS_IS_MISSING

  • CLUSTER_MONGOS_IS_PRESENT

  • SHARD_ADDED

  • SHARD_REMOVED

Data Explorer acessado

  • DATA_EXPLORER

  • DATA_EXPLORER_CRUD

Backup em disco

Anfitrião

Organização

Projeto

Conjunto de réplicas

Caso de suporte

team

  • TEAM_ADDED_TO_GROUP

  • TEAM_CREATED

  • TEAM_DELETED

  • TEAM_NAME_CHANGED

  • TEAM_REMOVED_FROM_GROUP

  • TEAM_ROLES_MODIFIED

  • TEAM_UPDATED

  • USER_ADDED_TO_TEAM

Usuário

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.

Cloud Manager retornará 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.

Cloud Manager retornará 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

Registro de data/hora no formato de data e hora ISO 8601 em UTC quando a última notificação foi enviada para este alerta. O Cloud 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.

Cloud Manager retornará esse valor se "eventTypeName" tiver sido definido como OUTSIDE_METRIC_THRESHOLD.

For possible values, see Measurement Types for Alerts.

replicaSetName

string

Nome do conjunto de réplicas.

Cloud Manager retornará este valor se "eventTypeName" foi definido para um dos seguintes:

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved

string

Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o alerta foi fechado.

O Cloud Manager retorna esse valor se "status" : "CLOSED".

status

string

Estado atual do alerta. O Cloud Manager pode retornar um dos seguintes:

  • TRACKING

    The alert condition exists but has not persisted beyond the defined notification delay. For details, see Request Query Parameters.

  • OPEN

  • CLOSED

  • CANCELLED

sourceTypeName

string

Tipo de host que está sendo copiado quando "eventTypeName" : "BACKUP". O Cloud 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

Registro de data/hora no formato de data e hora ISO 8601 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

Rate of asserts for a MongoDB process found in the asserts document that the serverStatus command generates.

  • 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

Amount of bytes in the WiredTiger storage engine cache and tickets found in the wiredTiger.cache and wiredTiger.concurrentTransactions documents that the serverStatus command generates.

  • CONNECTIONS

Number of connections to a MongoDB process found in the connections document that the serverStatus command generates.

  • CURSORS_TOTAL_OPEN

  • CURSORS_TOTAL_TIMED_OUT

Number of Cursors for a MongoDB process found in the metrics.cursor document that the serverStatus command generates.

  • 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 gera. O Cloud Manager calcula esses valores com base no tipo de mecanismo de serverStatus 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

Amount of memory for a MongoDB process found in the mem document that the serverStatus command collects.

  • NETWORK_BYTES_IN

  • NETWORK_BYTES_OUT

  • NETWORK_NUM_REQUESTS

Amount of throughput for MongoDB process found in the network document that the serverStatus command collects.

  • 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

Rate of database operations on a MongoDB process since the process last started found in the opcounters document that the serverStatus command collects.

  • OPCOUNTER_REPL_CMD

  • OPCOUNTER_REPL_UPDATE

  • OPCOUNTER_REPL_DELETE

  • OPCOUNTER_REPL_INSERT

Rate of database operations on MongoDB secondaries found in the opcountersRepl document that the serverStatus command collects.

  • 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

Average rate per second to scan index items during queries and query-plan evaluations found in the value of totalKeysExamined from the explain command.

  • QUERY_EXECUTOR_SCANNED_OBJECTS

Average rate of documents scanned per second during queries and query-plan evaluations found in the value of totalDocsExamined from the explain command.

  • 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://cloud.mongodb.com/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
Próximo
Obter um alerta
Avalie esta página

Nesta página