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.
Requisitos previos
Para recopilar la 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 la telemetría de las instancias de Couchbase y reinicia el agente.
Configuración de ejemplo
Los siguientes comandos crean la configuración para recopilar y transferir la telemetría de Couchbase, y reinician el Agente de operaciones.
¿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.level |
string | Gravedad de las entradas del registro de la base de sofá |
jsonPayload.message |
string | Mensaje del registro |
jsonPayload.module_name |
string | El nombre del módulo que emite la entrada |
jsonPayload.node_name |
string | El nombre del nodo que emite el mensaje de registro |
jsonPayload.source |
string | Fuente donde se originó el registro |
jsonPayload.type |
string | El tipo de registro |
severity |
string (LogSeverity ) |
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 |
string | La dirección IP del cliente que invoca la solicitud HTTP |
jsonPayload.level |
string | Gravedad de las entradas del registro de la base de sofá |
jsonPayload.message |
string | Mensaje del registro |
jsonPayload.user |
string | El nombre del usuario que realiza la solicitud HTTP si se usa la autenticación básica. |
severity |
string (LogSeverity ) |
Nivel de entrada de registro (traducido). |
Los registros couchbase_goxdcr
contienen los siguientes campos en LogEntry
:
Campo | Tipo | Descripción |
---|---|---|
jsonPayload.level |
string | Gravedad de las entradas del registro de la base de sofá |
jsonPayload.log_type |
string | El nombre del componente que emite el registro entre centros de datos |
jsonPayload.message |
string | Mensaje del registro |
severity |
string (LogSeverity ) |
Nivel de entrada de registro (traducido). |
Configura la recopilación de métricas
Para transferir métricas desde Couchbase, debes crear un receptor para las métricas que produce Couchbase 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 para las métricas de couchbase
, especifica los siguientes campos:
Campo | Predeterminado | 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
|
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 los registros de Couchbase se envíen a Cloud Logging, haz lo siguiente:
-
En la consola de Google Cloud, ve a la página 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, ve a la página leaderboard 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 sea codeMQL o codePromQL.
- 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 te permite dar formato a tu 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
Ver 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. 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, ve a la página 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 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, ve a la página 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 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 de los paneles en Cloud Monitoring, consulta Paneles y gráficos.
Para obtener más información del 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 Couchbase 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, ve a la página 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 enviar notificaciones que la alerta se activó, por lo que requieren información de ti para la instalación.
Para instalar las políticas de alertas, haz lo siguiente:
- En la lista de políticas de alertas disponibles, elige las que deseas instalar.
En la sección Configura notificaciones, elige 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 de los canales de notificaciones, consulta Administra canales de notificaciones.
- Haz clic en Crear políticas.
Para obtener más información de las políticas de alertas en Cloud Monitoring, consulta Introducción a las alertas.
Para obtener más información del uso de la página Integraciones, consulta Administra integraciones.
¿Qué sigue?
Para obtener una explicación sobre cómo usar Ansible para 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.