Couchbase

La integración de Couchbase recopila métricas de buckets, como operaciones, uso de memoria y expulsiones. La integración recopila métricas del servidor de Prometheus que se exponen en un nodo. La integración también recopila registros generales de Couchbase, de acceso HTTP y de centros de datos cruzados (“goxdcr”).

Para obtener más información sobre Couchbase, consulta la documentación de Couchbase.

Requisitos

Para recopilar los datos de telemetría de Couchbase, debes instalar el Agente de operaciones:

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

Esta integración es compatible con las versiones 6.5, 6.6 y 7.0 de Couchbase.

Configura el Agente de operaciones para Couchbase

Sigue la guía para configurar el Agente de operaciones, agrega los elementos necesarios para recopilar los datos de telemetría de las instancias de Couchbase y reinicia el agente.

Configuración de ejemplo

Con los siguientes comandos, se crea la configuración para recopilar y transferir los datos de telemetría de Couchbase:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# 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:
    couchbase:
      type: couchbase
      username: admin 
      password: password 
      # To use the googlesecretmanager provider to replace plaintext passwords, refer to the example below.
      # password: ${googlesecretmanager:projects/<project-id>/secrets/<secret-id>/versions/<version-id>}
      collection_interval: 30s
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase

logging:
  receivers:
    couchbase_general:
      type: couchbase_general
    couchbase_http_access:
      type: couchbase_http_access
    couchbase_goxdcr:
      type: couchbase_goxdcr
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase_general
          - couchbase_http_access
          - couchbase_goxdcr

EOF

Para que estos cambios se apliquen, debes reiniciar el Agente de operaciones:

Linux

Para reiniciar el agente, ejecuta el siguiente comando en la instancia:
```
sudo systemctl restart google-cloud-ops-agent
```
Para confirmar que el agente se haya reiniciado, ejecuta el siguiente comando y verifica que los componentes “Agente de métricas” y “Agente de Logging” se hayan iniciado:
```
sudo systemctl status "google-cloud-ops-agent*"
```

Windows

Conéctate a la instancia a través de RDP o una herramienta similar y accede a Windows.
Haz clic con el botón derecho en el ícono de PowerShell y selecciona Ejecutar como administrador para abrir una terminal de PowerShell con privilegios de administrador.
Para reiniciar el agente, ejecuta el siguiente comando de PowerShell:
```
Restart-Service google-cloud-ops-agent -Force
```
Para confirmar que el agente se haya reiniciado, ejecuta el siguiente comando y verifica que los componentes “Agente de métricas” y “Agente de Logging” se hayan iniciado:
```
Get-Service google-cloud-ops-agent*
```

¿Qué se registra?

El logName se deriva de los IDs del receptor especificados en la configuración. Los campos detallados en LogEntry son los siguientes.

Los registros couchbase_general contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.level`	cadena	Gravedad de la entrada de registro para el registro de Couchbase
`jsonPayload.message`	cadena	Mensaje de registro
`jsonPayload.module_name`	cadena	El nombre del módulo que emite la entrada
`jsonPayload.node_name`	cadena	El nombre del nodo que emite el mensaje de registro
`jsonPayload.source`	cadena	Fuente en la que se originó el registro
`jsonPayload.type`	cadena	El tipo de registro
`severity`	cadena (`LogSeverity`)	Es el nivel de entrada de registro (traducido).

Los registros couchbase_http_access contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`httpRequest`	objeto	Consulta `HttpRequest`
`jsonPayload.host`	cadena	La dirección IP del cliente que invoca la solicitud HTTP
`jsonPayload.level`	cadena	Gravedad de la entrada de registro para el registro de Couchbase
`jsonPayload.message`	cadena	Mensaje de registro
`jsonPayload.user`	cadena	El nombre del usuario que realiza la solicitud HTTP si se usa la autenticación básica
`severity`	cadena (`LogSeverity`)	Es el nivel de entrada de registro (traducido).

Los registros couchbase_goxdcr contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.level`	cadena	Gravedad de la entrada de registro para el registro de Couchbase
`jsonPayload.log_type`	cadena	El nombre del componente que emite el registro de centros de datos cruzados
`jsonPayload.message`	cadena	Mensaje de registro
`severity`	cadena (`LogSeverity`)	Es el nivel de entrada de registro (traducido).

Configura la recopilación de métricas

Para transferir métricas desde Couchbase, debes crear un receptor destinado a las métricas que este produce y, luego, crear una canalización destinada al 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.

Para configurar un receptor destinado a las métricas de couchbase, especifica los siguientes campos:

Campo	Predeterminado	Descripción
`collection_interval`	`60s`	Es un valor time.Duration, como `30s` o `5m`.
`endpoint`	`localhost:8091`	Es la URL del nodo que se va a supervisar.
`password`		Es la contraseña que se usa para conectarse al servidor de Couchbase.
`type`		Este valor debe ser `couchbase`.
`username`		Es el nombre de usuario que se usa para conectarse al servidor de Couchbase.

¿Qué se supervisa?

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

Tipo de métrica
Categoría, tipo Recursos supervisados	Etiquetas
`workload.googleapis.com/couchbase.bucket.error.oom.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name` `error_type`
`workload.googleapis.com/couchbase.bucket.item.count`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name` `state`
`workload.googleapis.com/couchbase.bucket.item.ejection.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.memory.usage`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name`
`workload.googleapis.com/couchbase.bucket.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`bucket_name` `op`
`workload.googleapis.com/couchbase.bucket.vbucket.count`
`GAUGE`, `DOUBLE` gce_instance	`bucket_name` `state`

Verifica la configuración

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

Para verificar que los registros de Couchbase se envíen a Cloud Logging, haz lo siguiente:

En la consola de Google Cloud , accede a la página Explorador de registros:
Acceder al Explorador de registros

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.

Ingresa la siguiente consulta en el editor y, luego, haz clic en Ejecutar consulta:

resource.type="gce_instance"
(log_id("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))

Para verificar que las métricas de Couchbase se envíen a Cloud Monitoring, haz lo siguiente:

En la consola de Google Cloud , accede a la página Explorador de métricas:
Acceder al Explorador de métricas

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre es MQL o PromQL.
Verifica que MQL esté seleccionado en el botón de activación Lenguaje. El botón de activación de lenguaje se encuentra en la misma barra de herramientas que permite dar formato a la consulta.

Ingresa la siguiente consulta en el editor y, luego, haz clic en Ejecutar consulta:

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

Visualiza el panel

Para ver tus métricas de Couchbase, debes tener configurado un gráfico o un panel. La integración de Couchbase incluye uno o más paneles. Todos los paneles se instalan automáticamente después de que configuras la integración y de que el Agente de operaciones empieza a recopilar datos de métricas.

También puedes obtener 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 , accede a la página Paneles :
Acceder a Paneles

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Selecciona la pestaña Lista de paneles y, luego, la categoría Integraciones.
Haz clic en el nombre del panel que quieras ver.

Si configuraste una integración, pero el panel no se instaló, comprueba 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 empieza 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 , accede a la página Integraciones :
Acceder a Integraciones

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Haz clic en el filtro de la plataforma de implementación Compute Engine.
Ubica la entrada para Couchbase y haz clic en Ver detalles.
Selecciona la pestaña Paneles para obtener una vista previa estática. Si el panel está instalado, haz clic en Ver panel para acceder a este.

Para obtener más información sobre los paneles de 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 se den condiciones que hayas especificado. La integración de Couchbase incluye una o más políticas de alertas para que uses. Puedes ver e instalar estas políticas de alertas en 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 , accede a la página Integraciones :
Acceder a Integraciones

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Ubica la entrada para Couchbase 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 deben enviar notificaciones acerca de la activación de la alerta, por lo que requieren que proporciones información para la instalación. Para instalar políticas de alertas, haz lo siguiente:
1. En la lista de políticas de alertas disponibles, elige las que quieras instalar.
2. En la sección Configurar notificaciones, elige uno o más canales de notificaciones. Tienes la opción de inhabilitar el uso de los canales de notificaciones, pero si lo haces, las políticas de alertas se activarán de forma silenciosa. Puedes comprobar 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.