Apache CouchDB

La integración de CouchDB de Apache recopila métricas relacionadas con el tráfico, como la cantidad de solicitudes a un nodo y las respuestas del nodo. También recopila métricas de la base de datos, como cuántas están abiertas y la cantidad de operaciones. La integración recopila registros de acceso y de CouchDB generales y los analiza en una carga útil de JSON. El resultado incluye campos para el usuario, el host, el nivel y el mensaje.

Si quieres obtener más información sobre CouchDB, consulta la documentación de Apache CouchDB.

Requisitos previos

Para recopilar la telemetría de CouchDB, debes instalar el agente de operaciones:

Para las métricas, instala la versión 2.10.0 o una posterior.
Para los registros, instala la versión 2.11.0 o una posterior.

Esta integración es compatible con las versiones 2.3.x, 3.1 y posteriores de CouchDB.

Configura el agente de operaciones para CouchDB

Usa la guía Configura el Agente de operaciones a fin de agregar los elementos necesarios para recopilar telemetría de las instancias de CouchDB y reinicia el agente.

Configuración de ejemplo

El siguiente comando crea la configuración para recopilar y transferir la telemetría de transferencia para CouchDB y reinicia el Agente de operaciones.

# 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

Configura la recopilación de registros

A fin de transferir registros desde CouchDB, debes crear receptores para los registros que CouchDB produce y, luego, crear una canalización para los receptores nuevos.

A fin de configurar un receptor para tus registros couchdb, especifica los siguientes campos:

Campo	Predeterminada	Descripción
`exclude_paths`		Una lista de patrones de ruta de acceso del sistema de archivos que se excluirán del conjunto que coincide con `include_paths`.
`include_paths`	`[/var/log/couchdb/couchdb.log]`	Una lista de rutas de acceso del sistema de archivos que se leerán mediante la visualización del final de cada archivo. Se puede usar un comodín (``) en las rutas. Por ejemplo, `/var/log/couchdb/*.log`.
`record_log_file_path`	`false`	Si se configura como `true`, la ruta al archivo específico desde el que se obtuvo el registro aparece en la entrada de registro de salida como el valor de la etiqueta `agent.googleapis.com/log_file_path`. Cuando se usa un comodín, solo se registra la ruta de acceso del archivo del que se obtuvo el registro.
`type`		El valor debe ser `couchdb`.
`wildcard_refresh_interval`	`60s`	El intervalo en el que se actualizan las rutas de acceso de archivos comodín en `include_paths`. Se proporciona como una duración, por ejemplo, `30s` o `2m`. Esta propiedad puede ser útil en el caso de una capacidad de procesamiento de registro alta en la que los archivos de registro se rotan más rápido que el intervalo predeterminado. Debe ser un múltiplo de 1 s.

¿Qué se registra?

logName se deriva de los ID de receptor especificados en la configuración. Los campos detallados dentro de LogEntry son los siguientes.

Los registros couchdb contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`httpRequest`	objeto	Consulta `HTTPRequest`
`jsonPayload.host`	string	Nombre de instancia del host
`jsonPayload.level`	string	Nivel de entrada de registro
`jsonPayload.message`	string	Mensaje del registro
`jsonPayload.node`	string	Nombre de la instancia de nodo
`jsonPayload.path`	string	Ruta de la solicitud
`jsonPayload.pid`	string	ID de proceso
`jsonPayload.remote_user`	string	Nombre de usuario autenticado para la solicitud
`jsonPayload.status_message`	string	Mensaje de código de estado
`severity`	string (`LogSeverity`)	Nivel de entrada de registro (traducido).

Las entradas de registro no contienen ningún campo en blanco o faltante.

Configura la recopilación de métricas

Para transferir métricas desde CouchDB, debes crear un receptor para las métricas que produce CouchDB y, luego, crear una canalización para el receptor nuevo.

Este receptor no admite el uso de varias instancias en la configuración, por ejemplo, para supervisar varios extremos. Todas estas instancias escriben en las mismas series temporales, y Cloud Monitoring no tiene forma de distinguirlas.

A fin de configurar un receptor para las métricas de couchdb, especifica los siguientes campos:

Campo	Predeterminada	Descripción
`collection_interval`	`60s`	Un valor time.Duration, como `30s` o `5m`.
`password`		La contraseña usada para conectarse al servidor.
`server_status_url`	`http://localhost:5984`	La URL que CouchDB expone.
`type`		El valor debe ser `couchdb`.
`username`		El nombre de usuario usado para conectarse al servidor.

Qué se supervisa

En la siguiente tabla, se proporciona una lista de métricas que el agente de operaciones recopila de la instancia de CouchDB.

Tipo de métrica
Categoría, tipo Recursos supervisados	Etiquetas
`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`

Verifica la configuración

En esta sección, se describe cómo verificar que hayas configurado correctamente el receptor de CouchDB. El agente de operaciones puede tardar uno o dos minutos en comenzar a recopilar telemetría.

Para verificar que se transfieran los registros, ve a Explorador de registros y ejecuta la siguiente consulta a fin de ver los registros de CouchDB:

resource.type="gce_instance"
log_id("couchdb")

Para verificar que las métricas se transfieran, ve a Explorador de métricas y ejecuta la siguiente consulta en la pestaña MQL:

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

Ver panel

Para ver tus métricas de CouchDB, debes tener configurado un gráfico o un panel. La integración de CouchDB incluye uno o más paneles. Cualquier panel se instala de forma automática después de que configuras la integración y de que el agente de operaciones comienza a recopilar datos de métricas.

También puedes ver vistas previas estáticas de los paneles sin instalar la integración.

Para ver un panel instalado, haz lo siguiente:

En la consola de Google Cloud, selecciona Monitoring o haz clic en el siguiente botón:
Ir a Monitoring
En el panel de navegación, selecciona Paneles.
Selecciona la pestaña Lista de paneles.
Elige la categoría Integraciones.
Haz clic en el nombre del panel que quiera ver.

Si configuraste una integración, pero el panel no se instaló, verifica que el agente de operaciones se esté ejecutando. Cuando no hay datos de métricas para un gráfico en el panel, la instalación del panel falla. Una vez que el agente de operaciones comienza a recopilar métricas, el panel se instalará por ti.

Para obtener una vista previa estática del panel, haz lo siguiente:

En la consola de Google Cloud, selecciona Monitoring o haz clic en el siguiente botón:
Ir a Monitoring
En el panel de navegación, selecciona Integraciones.
Haz clic en el filtro de la plataforma de implementación Compute Engine.
Ubica la entrada de CouchDB y haz clic en Ver detalles.
Selecciona la pestaña Paneles para ver una vista previa estática. Si el panel está instalado, haz clic en Ver panel para navegar a él.

Para obtener más información sobre los paneles en Cloud Monitoring, consulta Paneles y gráficos.

Para obtener más información sobre el uso de la página Integraciones, consulta Administra integraciones.

Instala políticas de alertas

Las políticas de alertas le indican a Cloud Monitoring que te notifique cuando ocurren condiciones especificadas. La integración de CouchDB incluye una o más políticas de alertas para que uses. Puedes ver e instalar estas políticas de alertas desde la página Integraciones en Monitoring.

Para ver las descripciones de las políticas de alertas disponibles y, luego, instalarlas, haz lo siguiente:

En la consola de Google Cloud, selecciona Monitoring o haz clic en el siguiente botón:
Ir a Monitoring
En el panel de navegación, selecciona Integraciones.
Ubica la entrada de CouchDB y haz clic en Ver detalles.
Selecciona la pestaña Alertas. En esta pestaña, se proporcionan descripciones de las políticas de alertas disponibles y una interfaz para instalarlas.
Instala las políticas de alertas. Las políticas de alertas deben saber a dónde enviar notificaciones que la alerta se activó, por lo que requieren información de tu instalación. Para instalar las políticas de alertas, haz lo siguiente:
1. En la lista de políticas de alertas disponibles, selecciona las que deseas instalar.
2. En la sección Configura notificaciones, selecciona uno o más canales de notificaciones. Tienes la opción de inhabilitar el uso de los canales de notificación, pero si lo haces, las políticas de alertas se activarán de forma silenciosa. Puedes verificar su estado en Monitoring, pero no recibirás notificaciones.
  
  Para obtener más información sobre los canales de notificaciones, consulta Administra canales de notificaciones.
3. Haz clic en Crear políticas.

Para obtener más información sobre las políticas de alertas en Cloud Monitoring, consulta Introducción a las alertas.

Para obtener más información sobre el uso de la página Integraciones, consulta Administra integraciones.

¿Qué sigue?

Para obtener una explicación sobre cómo usar Ansible a fin de instalar el agente de operaciones, configurar una aplicación de terceros y, luego, instalar un panel de muestra, consulta el video Instala el agente de operaciones para solucionar problemas de apps de terceros.