Apache CouchDB

A integração do Apache CouchDB coleta métricas relacionadas ao tráfego, como o número de solicitações para um nó e as respostas do nó. Ela também coleta métricas de banco de dados, como quantas estão abertas e o número de operações. A integração coleta registros gerais e de acesso do CouchDB e os analisa em um payload JSON. O resultado inclui campos para usuário, host, nível e mensagem.

Para mais informações sobre o CouchDB, consulte a documentação do Apache CouchDB (em inglês).

Pré-requisitos

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

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

Essa integração é compatível com as versões 2.3.x, 3.1 e mais recentes do CouchDB.

Configure o agente de operações para o CouchDB

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

Exemplo de configuração

O comando a seguir cria a configuração para coletar e ingerir a telemetria para o CouchDB 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:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

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

Configurar a coleta de registros

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

couchdbPara 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/couchdb/couchdb.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/couchdb/*.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`		O valor precisa ser `couchdb`.
`wildcard_refresh_interval`	`60s`	O intervalo em que os caminhos de arquivos curinga no `include_paths` são atualizados. Dado como uma duração de tempo, por exemplo, `30s` ou `2m`. 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. Precisa ser múltiplo de 1s.

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 couchdb contêm os seguintes campos no LogEntry:

Campo	Tipo	Descrição
`httpRequest`	objeto	Consulte `HTTPRequest`
`jsonPayload.host`	string	Nome da instância de host
`jsonPayload.level`	string	Nível de entrada de registro
`jsonPayload.message`	string	Mensagem de registro
`jsonPayload.node`	string	Nome da instância do nó
`jsonPayload.path`	string	Caminho da solicitação
`jsonPayload.pid`	string	ID do processo
`jsonPayload.remote_user`	string	Nome de usuário autenticado da solicitação
`jsonPayload.status_message`	string	Mensagem de código de status
`severity`	string (`LogSeverity`)	Nível de entrada de registro (traduzido).

As entradas de registro não contêm campos em branco ou ausentes.

Configurar a coleta de métricas

Para ingerir métricas do CouchDB, crie um receptor para as métricas que o CouchDB produz e 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 couchdb, especifique os campos a seguir:

Campo	Padrão	Descrição
`collection_interval`	`60s`	Um valor de time.Duration, como `30s` ou `5m`.
`password`		A senha usada para se conectar ao servidor.
`server_status_url`	`http://localhost:5984`	O URL exposto pelo CouchDB.
`type`		O valor precisa ser `couchdb`.
`username`		O nome de usuário usado para se conectar ao servidor.

O que é monitorado?

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

Tipo de métrica
Tipo, tipo Recursos monitorados	Rótulos
`workload.googleapis.com/couchdb.average_request_time`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/couchdb.database.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.database.operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/couchdb.file_descriptor.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.bulk_requests`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.requests`
`CUMULATIVE`, `INT64` gce_instance	`http_method`
`workload.googleapis.com/couchdb.httpd.responses`
`CUMULATIVE`, `INT64` gce_instance	`http_status_code`
`workload.googleapis.com/couchdb.httpd.views`
`CUMULATIVE`, `INT64` gce_instance	`view`

Verificar a configuração

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

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

No painel de navegação do console do Google Cloud, selecione Logging e, depois, Explorador de registros:
Acessar o Explorador de registros
Insira a seguinte consulta no editor e clique em Executar consulta:
```
resource.type="gce_instance"
log_id("couchdb")
```

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

No painel de navegação do console do Google Cloud, selecione Monitoramento e Metrics Explorer:
Acesse o Metrics explorer
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.

Insira a seguinte consulta no editor e clique em Executar consulta:

fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m

Ver painel

Para visualizar as métricas do CouchDB, é necessário ter um gráfico ou painel configurado. A integração do CouchDB 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 painel de navegação do console do Google Cloud, selecione Monitoramento e Painéis:
Acessar Painéis
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 painel de navegação do console do Google Cloud, selecione Monitoramento e Integrações:
Acessar Integrações
Clique no filtro de plataforma de implantação do Compute Engine.
Localize a entrada do CouchDB e clique em View Details.
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 CouchDB 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 painel de navegação do console do Google Cloud, selecione Monitoramento e Integrações:
Acessar Integrações
Localize a entrada do CouchDB e clique em View Details.
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.