Esta página se ha traducido con Cloud Translation API.

Couchbase

La integración de Couchbase recoge métricas de los contenedores, como las operaciones, el uso de memoria y las expulsiones. La integración recoge métricas del servidor de Prometheus expuesto en un nodo. La integración también recoge registros generales de Couchbase, de acceso HTTP y entre centros de datos ("goxdcr").

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

Requisitos previos

Para recoger la telemetría de Couchbase, debes instalar el Agente de operaciones:

En el caso de 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.

Configurar el agente de operaciones para Couchbase

Sigue la guía para configurar el agente de operaciones, añade los elementos necesarios para recoger telemetría de las instancias de Couchbase y reinicia el agente.

Configuración de ejemplo

Los siguientes comandos crean la configuración para recoger e ingerir 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 Ops:

Linux

Para reiniciar el agente, ejecuta el siguiente comando en tu instancia:
```
sudo systemctl restart google-cloud-ops-agent
```
Para confirmar que el agente se ha reiniciado, ejecuta el siguiente comando y verifica que los componentes "Metrics Agent" y "Logging Agent" se han iniciado:
```
sudo systemctl status "google-cloud-ops-agent*"
```

Windows

Conéctate a tu instancia mediante RDP o una herramienta similar e inicia sesión en Windows.
Abre un terminal de PowerShell con privilegios de administrador haciendo clic con el botón derecho en el icono de PowerShell y seleccionando Ejecutar como administrador.
Para reiniciar el agente, ejecuta el siguiente comando de PowerShell:
```
Restart-Service google-cloud-ops-agent -Force
```
Para confirmar que el agente se ha reiniciado, ejecuta el siguiente comando y verifica que los componentes "Metrics Agent" y "Logging Agent" se han iniciado:
```
Get-Service google-cloud-ops-agent*
```

Qué se registra

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

Los registros de couchbase_general contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.level`	cadena	Gravedad de la entrada de registro del 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	Nombre del nodo que emite el mensaje de registro.
`jsonPayload.source`	cadena	Fuente de la que procede el registro.
`jsonPayload.type`	cadena	El tipo de registro
`severity`	cadena (`LogSeverity`)	Nivel de entrada de registro (traducido).

Los registros de couchbase_http_access contienen los siguientes campos en LogEntry:

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

Los registros de couchbase_goxdcr contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.level`	cadena	Gravedad de la entrada de registro del registro de Couchbase
`jsonPayload.log_type`	cadena	Nombre del componente que emite el registro entre centros de datos.
`jsonPayload.message`	cadena	Mensaje de registro
`severity`	cadena (`LogSeverity`)	Nivel de entrada de registro (traducido).

Configurar recogida de métricas

Para ingerir métricas de Couchbase, debe crear un receptor para las métricas que genera Couchbase y, a continuación, crear una canalización para el nuevo receptor.

Este receptor no admite el uso de varias instancias en la configuración, por ejemplo, para monitorizar varios endpoints. Todas estas instancias escriben en la misma serie temporal y Cloud Monitoring no tiene forma de distinguirlas.

Para configurar un receptor de sus métricas de couchbase, especifique 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 va a monitorizar.
`password`		La contraseña que se usa para conectarse al servidor de Couchbase.
`type`		Este valor debe ser `couchbase`.
`username`		Nombre de usuario usado para conectarse al servidor de Couchbase.

Qué se monitoriza

En la siguiente tabla se muestra la lista de métricas que recoge el agente de Ops de la instancia de Couchbase.

Tipo de métrica
Tipo Recursos monitorizados	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`

Verificar la configuración

En esta sección se describe cómo verificar que ha configurado correctamente el receptor de Couchbase. El agente de Ops puede tardar uno o dos minutos en empezar a recoger datos de telemetría.

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

En la Google Cloud consola, ve a la página Explorador de registros:
Ve al Explorador de registros.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Registro.

Introduce la siguiente consulta en el editor y 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ían a Cloud Monitoring, haz lo siguiente:

En la Google Cloud consola, ve a la página Explorador de métricas:
Ve al explorador de métricas.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
En la barra de herramientas del panel de creación de consultas, selecciona el botón cuyo nombre sea MQL o PromQL.
Verifica que PromQL esté seleccionado en el interruptor Idioma. El interruptor de idioma se encuentra en la misma barra de herramientas que te permite dar formato a tu consulta.

Introduce la siguiente consulta en el editor y haz clic en Ejecutar consulta:

{"workload.googleapis.com/couchbase.bucket.memory.usage", monitored_resource="gce_instance"}

Ver panel de control

Para ver las métricas de Couchbase, debe tener configurado un gráfico o un panel de control. La integración de Couchbase incluye uno o varios paneles de control. Los paneles de control se instalan automáticamente después de configurar la integración y cuando el agente de Ops ha empezado a recoger datos de métricas.

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

Para ver un panel de control instalado, siga estos pasos:

En la Google Cloud consola, ve a la página Paneles de control:
Ve a Paneles.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
Seleccione la pestaña Lista de paneles de control y, a continuación, elija la categoría Integraciones.
Haga clic en el nombre del panel de control que quiera ver.

Si has configurado una integración, pero el panel de control no se ha instalado, comprueba que el agente de operaciones se esté ejecutando. Si no hay datos de métricas para un gráfico del panel de control, no se podrá instalar el panel. Una vez que el agente de Ops empiece a recoger métricas, se instalará el panel de control.

Para ver una vista previa estática del panel de control, siga estos pasos:

En la Google Cloud consola, ve a la página Integraciones:
Ve a Integraciones.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
Haz clic en el filtro de plataforma de implementación Compute Engine.
Busca la entrada de Couchbase y haz clic en Ver detalles.
Seleccione la pestaña Paneles para ver una vista previa estática. Si el panel de control está instalado, puedes acceder a él haciendo clic en Ver panel de control.

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

Para obtener más información sobre cómo usar la página Integraciones, consulta el artículo Gestionar integraciones.

Instalar políticas de alertas

Las políticas de alertas indican a Cloud Monitoring que te envíe una notificación cuando se produzcan las condiciones especificadas. La integración de Couchbase incluye una o varias políticas de alertas que puedes usar. Puedes ver e instalar estas políticas de alertas desde la página Integraciones de Monitoring.

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

En la Google Cloud consola, ve a la página Integraciones:
Ve a Integraciones.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
Busca la entrada de Couchbase y haz clic en Ver detalles.
Selecciona la pestaña Alertas. En esta pestaña se ofrecen descripciones de las políticas de alertas disponibles y se proporciona una interfaz para instalarlas.
Instala las políticas de alertas. Las políticas de alertas necesitan saber dónde enviar las notificaciones de que se ha activado una alerta, por lo que requieren 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, selecciona las que quieras instalar.
2. En la sección Configurar notificaciones, selecciona uno o varios canales de notificación. Puedes inhabilitar el uso de canales de notificación, pero si lo haces, tus políticas de alertas se activarán de forma silenciosa. Puedes consultar su estado en Monitorización, pero no recibirás ninguna notificación.
  
  Para obtener más información sobre los canales de notificación, consulta el artículo Gestionar canales de notificación.
3. Haz clic en Crear políticas.

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