Couchbase

La integración de Couchbase recopila métricas de bucket, 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, acceso HTTP y centros de datos cruzados (“goxdcr”).

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

Prerequisites

Para recopilar la telemetría de base de bases, debes instalar el agente de operaciones versión 2.18.2 o 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

Mediante la guía Configura el Agente de operaciones, agrega los elementos necesarios para recopilar la telemetría de las instancias de couchbase 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 couchbase y reinicia el Agente de operaciones.

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

set -e

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchbase:
      type: couchbase
      username: admin
      password: password
      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

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

¿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 couchbase_general contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.message`	string	Mensaje del registro
`jsonPayload.node_name`	string	El nombre del nodo que emite el mensaje de registro
`jsonPayload.module_name`	string	El nombre del módulo que emite la entrada

Los registros couchbase_http_access contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.message`	string	Mensaje del registro
`jsonPayload.client_ip`	string	La dirección IP del cliente que invoca la solicitud HTTP
`jsonPayload.user`	string	El nombre del usuario que realiza la solicitud HTTP si se usa la autenticación básica.
`jsonPayload.method`	string	El método HTTP de la solicitud
`jsonPayload.status_code`	integer	El código de estado de la respuesta de la solicitud HTTP

Los registros couchbase_goxdcr contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.message`	string	Mensaje del registro
`log_type`	string	El nombre del componente que emite el registro entre centros de datos

Configura la recopilación de métricas

A fin de transferir métricas desde couchbase, debes crear receptores para las métricas que produce couchbase y, luego, una canalización para los receptores nuevos.

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

Campo	Predeterminada	Descripción
`collection_interval`	`60s`	Un valor time.Duration, como `30s` o `5m`.
`endpoint`	`localhost:8091`	La URL del nodo que se debe supervisar.
`password`		La contraseña usada para conectarse al servidor de couchbase.
`type`		Este valor debe ser `couchbase`.
`username`		El nombre de usuario usado 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`

Panel de muestra

Para ver tus métricas de couchbase, debes tener configurado un gráfico o un panel. Cloud Monitoring proporciona una biblioteca de paneles de muestra para integraciones, que contienen gráficos preconfigurados. Para obtener información sobre la instalación de estos paneles, consulta Instala paneles de muestra.

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 comenzar a recopilar telemetría.

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

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 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/couchbase.bucket.memory.usage'
| every 1m

¿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.