MongoDB

A integração do MongoDB coleta principalmente métricas de banco de dados, como o número de operações e objetos, bem como o uso de recursos. A integração também coleta registros do MongoDB e os analisa em um payload JSON. O resultado inclui campos de contexto, componente, nível e mensagem.

Para mais informações sobre o MongoDB, consulte a documentação do MongoDB.

Pré-requisitos

Para coletar a telemetria do MongoDB, instale o Agente de operações:

Para métricas, instale a versão 2.19.0 ou mais recente.
Para registros, instale a versão 2.10.0 ou mais recente.

Essa integração oferece suporte às versões 2.6, 3.x, 4.x e 5.0 do MongoDB.

Configure o agente de operações para o MongoDB

Seguindo o guia para Configurar o Agente de operações, adicione os elementos necessários para coletar registros das instâncias do MongoDB e reinicie o agente.

Exemplo de configuração

O comando a seguir cria a configuração para coletar e ingerir a telemetria para o MongoDB e reinicia o Agente de operações.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Configurar a coleta de registros

Para ingerir registros do MongoDB, é preciso criar receptores para os registros que o MongoDB produz e criar um pipeline para os novos receptores.

mongodbPara configurar um receptor para os registros , especifique os seguintes campos:

Campo	Padrão	Descrição
`exclude_paths`		Uma lista de padrões de caminho do sistema de arquivos a serem excluídos do conjunto correspondente a `include_paths`.
`include_paths`	`[/var/log/mongodb/mongod.log*]`	Uma lista de caminhos do sistema de arquivos a serem lidos acompanhando cada arquivo. Um caractere curinga (``) pode ser usado nos caminhos. por exemplo, `/var/log/mongodb/.log`.
`record_log_file_path`	`false`	Se definido como `true`, o caminho para o arquivo específico de que a gravação de registro foi recebida aparecerá na entrada de registro de saída como o valor do rótulo `agent.googleapis.com/log_file_path`. Ao usar um caractere curinga, apenas o caminho do arquivo de que o registro foi recebido é gravado.
`type`		Este valor precisa ser `mongodb`.
`wildcard_refresh_interval`	`60s`	O intervalo em que os caminhos de arquivos curinga em include_paths são atualizados. Dado como `time.ParseDuration`, por exemplo, `30s` ou `2m`. Precisa ser um múltiplo de `1s`. Essa propriedade pode ser útil com capacidades de registro altas em que os arquivos de registro são alternados mais rapidamente do que o intervalo padrão.

O que é registrado

O logName é derivado dos IDs do receptor especificados na configuração. Os campos detalhados dentro de LogEntry são os seguintes.

Os registros mongodb contêm os seguintes campos no LogEntry:

Campo	Tipo	Descrição
`jsonPayload.attributes`	objeto (opcional)	Objeto contendo um ou mais pares de chave-valor para qualquer atributo adicional
`jsonPayload.component`	string	Categorização da mensagem de registro. A lista completa pode ser encontrada na documentação do MongoDB.
`jsonPayload.context`	string
`jsonPayload.ctx`	string	O nome da linha de execução emitindo o log statement.
`jsonPayload.id`	número	ID do registro.
`jsonPayload.message`	string	Mensagem de registro.
`jsonPayload.severity`	string	Nível de entrada de registro.
`severity`	string (`LogSeverity`)	Nível de entrada de registro (traduzido).

Configurar a coleta de métricas

Para ingerir métricas do MongoDB, é preciso criar um receptor para as métricas produzidas pelo MongoDB e, em seguida, criar um pipeline para o novo receptor.

Esse receptor não aceita o uso de várias instâncias na configuração, por exemplo, para monitorar vários endpoints. Todas essas instâncias gravam na mesma série temporal, e o Cloud Monitoring não tem como diferenciá-las.

Para configurar um receptor para suas métricas do mongodb, especifique os campos a seguir:

Campo	Padrão	Descrição
`ca_file`		Caminho para o certificado de CA. Como cliente, isso verifica o certificado do servidor. Se estiver vazio, o receptor usará a CA raiz do sistema.
`cert_file`		Caminho para o certificado TLS a ser usado para conexões exigidas por mTLS.
`collection_interval`	`60s`	Um valor de `time.Duration`, como `30s` ou `5m`.
`endpoint`	`localhost:27017`	O nome do host, o endereço IP ou o soquete de domínio do UNIX. Uma porta pode ser especificada, como :. Se nenhuma porta for especificada, o padrão 27017 vai ser usado.
`insecure`	`true`	Define se uma conexão TLS segura será ou não usada. Se definido como `false`, o TLS será ativado.
`insecure_skip_verify`	`false`	Define se é necessário pular a verificação do certificado. Se "não seguro" for definido como `true`, o valor `insecure_skip_verify` não vai ser usado.
`key_file`		O caminho para a chave TLS a ser usada para conexões exigidas por mTLS, por exemplo, a chave usada no arquivo `tlsCertificateKeyFile`.
`password`		Senha para autenticação com a instância do MongoDB. Obrigatória se o nome de usuário estiver definido.
`type`		Este valor precisa ser `mongodb`.
`username`		Nome de usuário para autenticação na instância do MongoDB. Obrigatório se a senha estiver definida.

O que é monitorado?

A tabela a seguir fornece a lista de métricas que o agente de operações coleta da instância do MongoDB.

Tipo de métrica
Tipo, tipo Recursos monitorados	Rótulos
`workload.googleapis.com/mongodb.cache.operations`
`CUMULATIVE`, `INT64` gce_instance	`type`
`workload.googleapis.com/mongodb.collection.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.connection.count`
`GAUGE`, `INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.cursor.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.cursor.timeout.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.data.size`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.database.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.document.operation.count`
`GAUGE`, `INT64` gce_instance	`database` `operation`
`workload.googleapis.com/mongodb.global_lock.time`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.index.access.count`
`GAUGE`, `INT64` gce_instance	`collection` `database`
`workload.googleapis.com/mongodb.index.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.index.size`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.memory.usage`
`GAUGE`, `INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.network.io.receive`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.network.io.transmit`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.network.request.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.object.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.operation.time`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.session.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.storage.size`
`CUMULATIVE`, `INT64` gce_instance	`database`

Verificar a configuração

Nesta seção, descrevemos como verificar se você configurou corretamente o receptor do MongoDB. Pode levar um ou dois minutos para que o agente de operações comece a coletar telemetria.

Para verificar se os registros do MongoDB estão sendo enviados para o Cloud Logging, faça o seguinte:

No console do Google Cloud, acesse a página do Análise de registros.
Acessar a Análise de registros

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
Digite a consulta a seguir no Editor e clique em Executar consulta:
```
resource.type="gce_instance"
log_id("mongodb")
```

Para verificar se as métricas do MongoDB estão sendo enviadas para o Cloud Monitoring, faça o seguinte:

No Console do Google Cloud, acesse a página do Metrics Explorer:
Acesse o Metrics explorer

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
Na barra de ferramentas do painel do criador de consultas, selecione o botão MQL ou PromQL.
Verifique se MQL está selecionado na opção de ativar/desativar Idioma. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.

Digite a consulta a seguir no Editor e clique em Executar consulta:

fetch gce_instance
| metric 'workload.googleapis.com/mongodb.memory.usage'
| every 1m

Ver painel

Para visualizar as métricas do MongoDB, é necessário ter um gráfico ou um painel configurado. A integração do MongoDB inclui um ou mais painéis para você. Todos os painéis são instalados automaticamente depois que você configura a integração e o Agente de operações começa a coletar dados de métricas.

Também é possível ver visualizações estáticas de painéis sem instalar a integração.

Para ver um painel instalado, faça o seguinte:

No console do Google Cloud, acesse a página Painéis:
Ir para Painéis

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
Selecione a guia Lista de painéis e escolha a categoria Integrações.
Clique no nome do painel que você quer visualizar.

Se você configurou uma integração, mas o painel não foi instalado, verifique se o agente de operações está em execução. Quando não há dados de métricas para um gráfico no painel, a instalação do painel falha. Depois que o Agente de operações começar a coletar métricas, o painel será instalado para você.

Para acessar uma visualização estática do painel, faça o seguinte:

No console do Google Cloud, acesse a página Integrações:
Acessar Integrações

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
Clique no filtro de plataforma de implantação do Compute Engine.
Localize a entrada do MongoDB e clique em Ver detalhes.
Selecione a guia Painéis para uma visualização estática. Se o painel estiver instalado, navegue até ele clicando em Ver painel.

Para mais informações sobre painéis no Cloud Monitoring, consulte Painéis e gráficos.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

Instalar políticas de alertas

As políticas de alertas orientam o Cloud Monitoring a notificar você quando ocorrerem condições especificadas. A integração do MongoDB inclui uma ou mais políticas de alertas para você usar. É possível ver e instalar essas políticas de alertas na página Integrações no Monitoring.

Para visualizar e descrever as descrições de políticas de alertas disponíveis, faça o seguinte:

No console do Google Cloud, acesse a página Integrações:
Acessar Integrações

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize a entrada do MongoDB e clique em Ver detalhes.
Selecione a guia Alertas. Essa guia apresenta descrições das políticas de alertas disponíveis e mostra uma interface para instalá-las.
Instalar políticas de alertas. As políticas de alertas precisam saber para onde enviar as notificações de que o alerta foi acionado. Portanto, elas exigem informações para instalação. Para instalar políticas de alertas, faça o seguinte:
1. Na lista de políticas de alertas disponíveis, selecione aquelas que você quer instalar.
2. Na seção Configurar notificações, selecione um ou mais canais de notificação. Você pode desativar o uso dos canais de notificação, mas, se isso acontecer, as políticas de alertas vão ser disparadas silenciosamente. É possível verificar o status no Monitoring, mas não receber notificações.
  
  Para saber mais sobre canais de notificação, consulte Gerenciar canais de notificação.
3. Clique em Criar políticas.

Para mais informações sobre políticas de alertas no Cloud Monitoring, consulte Introdução a alertas.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

A seguir

Para ver um tutorial sobre como usar o Ansible para instalar o agente de operações, configurar um aplicativo de terceiros e instalar um painel de amostra, consulte o vídeo Instalação do agente de operações para resolver problemas de aplicativos de terceiros.