Integración de monitoreo de Couchbase

Nuestra integración Couchbase recopila y envía datos métricos y de inventario de su clúster Couchbase a la plataforma New Relic, donde puede ver rápidamente el estado de su entorno Couchbase. Recopilamos datos a nivel de clúster, nodo, motor de consulta y depósito para que pueda rastrear un problema hasta su origen.

Continúe leyendo para instalar la integración y ver qué datos recopilamos.

Compatibilidad y requisitos

Nuestra integración es compatible con Couchbase versión 4.0 o superior.

Inicio rápido

Si no está ejecutando Couchbase en entornos Kubernetes o ECS, le recomendamos nuestra instalación guiada. Nuestra instalación guiada utiliza nuestro agente de infraestructura y nuestra CLI para configurar la integración de Couchbase, descubre otras aplicaciones y fuentes log que se ejecutan en su entorno y luego recomienda cuáles debería utilizar.

La instalación guiada funciona con la mayoría de las configuraciones. Pero si no se adapta a sus necesidades, existen otras opciones de instalación a continuación.

¿Listo para comenzar? Haga clic en el botón correspondiente, según la región del centro de datos que utilice. Cuando haya terminado con la instalación, regrese a esta documentación para revisar las opciones de configuración.

Instalación guiada, región de EE. UU.

Instalación guiada, región de la UE

Instalar

Para instalar la integración de Couchbase, siga las instrucciones para su entorno:

' '

Instale el agente de infraestructura y reemplace la variable INTEGRATION_FILE_NAME con nri-couchbase.
Cambiar directorio a la carpeta de integración:
```
cd /etc/newrelic-infra/integrations.d
```

Copia del archivo de configuración de muestra:

sudo cp couchbase-config.yml.sample couchbase-config.yml

Edite el archivo couchbase-config.yml como se describe en los ajustes de configuración.

Descargue la imagen del instalador nri-couchbase .MSI desde:
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-couchbase/nri-couchbase-amd64.msi
Para instalar desde el símbolo del sistema de Windows, ejecute:
```
msiexec.exe /qn /i PATH\TO\nri-couchbase-amd64.msi
```
En el directorio de integración, C:\Program Files\New Relic\newrelic-infra\integrations.d\, cree una copia del archivo de configuración de muestra ejecutando:
```
cp couchbase-config.yml.sample couchbase-config.yml
```
Edite el archivo couchbase-config.yml como se describe en los ajustes de configuración.

Actualiza tu integración

Esta integración no se actualiza automáticamente. Para obtener mejores resultados, actualice periódicamente el paquete de integración y el agente de infraestructura.

Tareas posteriores a la instalación

Cuando haya terminado con la instalación, puede establecer las opciones de configuración. Se requieren algunas configuraciones para que la integración funcione, mientras que otras son opcionales.

Configurar la integración

Si habilitó esta integración a través de nuestra integración ECS o Kubernetes, consulte esos documentos:

Para la instalación estándar en el host, esta integración viene con un archivo de configuración YAML, apache-config.yml. Esta configuración es donde puede colocar las credenciales de inicio de sesión requeridas y configurar cómo se recopilan los datos. Las opciones que cambie dependen de su configuración y preferencias. Viene con un archivo de configuración de muestra apache-config.yml.sample que puedes copiar y editar.

El archivo de configuración tiene configuraciones comunes aplicables a todas las integraciones, como interval, timeout, inventory_source. Para leer todo sobre estas configuraciones comunes, consulte nuestro documento Formato de configuración .

Las configuraciones específicas relacionadas con Couchbase se definen usando la sección env del archivo de configuración. Estas configuraciones controlan la conexión a su instancia de Couchbase, así como otras configuraciones y características de seguridad. La lista de configuraciones válidas se describe en la siguiente sección de este documento.

Opciones de configuración de Couchbase

La integración Couchbase recopila información métrica y de inventario. Esta tabla muestra a qué se aplica cada opción de configuración.

' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '

Configuración	Descripción	Por defecto	Se aplica a
HOSTNAME	Nombre de host o IP donde se está ejecutando Couchbase.	host local	M/I
PORT	Puerto en el que escucha la API de Couchbase.	8091	M/I
QUERY_PORT	Puerto en el que escucha el servicio Couchbase N1QL.	8093	M/I
USERNAME	Nombre de usuario para acceder a la API de Couchbase.	N/A	M/I
PASSWORD	Contraseña para el usuario dado.	N/A	M/I
USE_SSL	Utilice SSL cuando se comunique con Couchbase.	false	M/I
CA_BUNDLE_FILE	Ubicación del certificado SSL en el host. Solo es necesario si `USE_SSL` es verdadero.	N/A	M/I
CA_BUNDLE_DIR	Directorio de paquete de autoridad de certificación alternativa.	N/A	M/I
TIMEOUT	Tiempo de espera para solicitudes de API, en segundos.	30	M/I
ENABLE_BUCKETS	Si es verdadero, recopila recursos del depósito.	verdadero	M
ENABLE_BUCKET_STATS	Si es verdadero, recopila estadísticas de depósitos adicionales.	verdadero	M
ENABLE_CLUSTER_AND_NODES	Si es verdadero, recopila recursos de clúster y nodo.	verdadero	M
METRICS	Establezca en `true` para habilitar la recopilación solo métrica.	false
INVENTORY	Configúrelo en `true` para habilitar la recopilación solo de inventario.	false

Los valores para estas configuraciones se pueden definir de varias maneras:

Agregar el valor directamente en el archivo de configuración (la forma más común).
Reemplazar los valores de las variables de entorno usando la notación {{}} . Esto requiere la versión 1.14.0 o superior del agente de infraestructura. Para obtener más información, consulte Configuración de infraestructura o consulte el ejemplo de variable de entorno.
Utilizando la gestión de secretos. Utilícelo para proteger información confidencial, como contraseñas que quedarían expuestas en texto sin formato en el archivo de configuración. Para obtener más información, consulte Gestión de secretos.

Etiquetas

Puedes decorar aún más tu métrica usando etiquetas. Las etiquetas le permiten agregar atributos (pares de valores principales) a su métrica, que luego puede usar para consultar, filtrar o agrupar su métrica.

Nuestro archivo de configuración de muestra predeterminado incluye ejemplos de etiquetas pero, como no son obligatorias, puede eliminar, modificar o agregar nuevas de su elección.

labels:
   env: production
   role: load_balancer

Configuración de ejemplo

Esta es la configuración básica utilizada para recopilar métricas e inventario de su localhost:

integrations:
  - name: nri-couchbase
    env:
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production
    inventory_source: config/couchbase

Esta configuración recolecta métrica cada 15 segundos e inventario cada 60 segundos:

integrations:
  - name: nri-couchbase
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production

  - name: nri-couchbase
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      environment: production
    inventory_source: config/couchbase

En esta configuración estamos usando la variable de entorno COUCHBASE_HOST para completar la configuración del nombre de host de la integración:

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: {{COUCHBASE_HOST}}
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

En esta configuración estamos monitoreando múltiples servidores Couchbase desde la misma integración. Para la primera instancia (HOSTNAME: 1st_couchbase_host) estamos recolectando métrica e inventario mientras que para la segunda instancia (HOSTNAME: 2nd_couchbase_host) solo recolectaremos métrica.

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-couchbase
    env:
      INVENTORY: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/couchbase

  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 2nd_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

Buscar y utilizar datos

Los datos de integración se informan al panel de integración.

Los datos de Couchbase se adjuntan a los siguientes tipos de eventos:

CouchbaseBucketSample
CouchbaseClusterSample
CouchbaseNodeSample
CouchbaseQueryEngineSample

Puede consultar estos datos para fines de resolución de problemas o para crear gráficos y paneles personalizados.

Para obtener más información sobre cómo encontrar y utilizar sus datos, consulte Comprender los datos de integración.

Datos métricos

La integración Couchbase recopila los siguientes atributos de datos métricos. Algunos nombres de métricas tienen como prefijo un indicador de categoría y un punto, como cluster. o node..

Balde base canapé muestra métrica

Estos atributos están adjuntos al tipo de evento CouchbaseBucketSample .

Métrica	Descripción
`bucket.activeResidentItemsRatio`	Porcentaje de elementos activos almacenados en caché en la RAM en este depósito.
`bucket.averageDiskCommitTimeInMilliseconds`	El tiempo promedio de confirmación del disco del depósito, en milisegundos.
`bucket.averageDiskUpdateTimeInMilliseconds`	El tiempo promedio de actualización del disco del depósito, en milisegundos.
`bucket.cacheMissRatio`	Porcentaje de lecturas por segundo de este depósito desde el disco en comparación con la RAM.
`bucket.currentConnections`	Número de conexiones a este servidor, incluidas conexiones desde SDK de clientes externos, servidores proxy, solicitudes TAP y recopilación de estadísticas internas.
`bucket.dataUsedInBytes`	Cantidad de datos utilizados por este depósito, en bytes.
`bucket.decrementHitsPerSecond`	El número de visitas de disminución por segundo del depósito.
`bucket.decrementMissesPerSecond`	El número de errores de decremento por segundo del depósito.
`bucket.deleteHitsPerSecond`	El número de aciertos de eliminación por segundo para este depósito.
`bucket.deleteMissesPerSecond`	El número de errores de eliminación por segundo para este depósito.
`bucket.diskCreateOperationsPerSecond`	Número de elementos nuevos creados en el disco por segundo para este depósito.
`bucket.diskFetchesPerSecond`	La cantidad de operaciones necesarias por segundo para recuperar elementos del disco en el depósito.
`bucket.diskUpdateOperationsPerSecond`	Número de elementos actualizados en el disco por segundo para este depósito.
`bucket.diskUsedInBytes`	La cantidad de espacio en disco utilizado para el depósito, en bytes.
`bucket.diskWriteQueue`	Número de elementos en espera de ser escritos en el disco del depósito.
`bucket.ejectionsPerSecond`	Número total de elementos por segundo que se expulsan al disco en este depósito
`bucket.evictionPolicy`	La política de desalojo del cubo.
`bucket.evictionsPerSecond`	La cantidad de elementos por segundo desalojados del depósito.
`bucket.getHitsPerSecond`	Número de operaciones de obtención por segundo para los datos que contiene este depósito.
`bucket.getMissesPerSecond`	Número de operaciones de obtención por segundo para datos que este depósito no contiene.
`bucket.hitRatio`	Porcentaje de solicitud GET atendida con datos de este depósito.
`bucket.incrementHitsPerSecond`	El número de visitas incrementales por segundo del depósito.
`bucket.incrementMissesPerSecond`	El número de incrementos perdidos por segundo del depósito.
`bucket.itemCount`	La cantidad de objetos almacenados en el depósito.
`bucket.memoryHighWaterMarkInBytes`	Marca de límite superior para los desalojos automáticos en el depósito, en bytes.
`bucket.memoryLowWaterMarkInBytes`	Marca de límite inferior para desalojos automáticos en el depósito, en bytes.
`bucket.memoryUsedInBytes`	La cantidad de RAM utilizada para el depósito, en bytes.
`bucket.metadataInRAMInBytes`	Cantidad de RAM utilizada para los metadatos en este depósito, en bytes.
`bucket.missesPerSecond`	El número de fallos por segundo del depósito.
`bucket.nodeLocator`	Tipo de localizador de nodos.
`bucket.outOfMemoryErrorsPerSecond`	Número de errores de falta de memoria para este depósito.
`bucket.OverheadInBytes`	La memoria adicional utilizada por los datos transitorios (colas de persistencia, colas de replicación, puntos de control, etc.) en el depósito, en bytes.
`bucket.pendingResidentItemsRatio`	Porcentaje de elementos pendientes almacenados en caché en la RAM de este depósito.
`bucket.quotaUtilization`	El porcentaje de la cuota de RAM actualmente en uso en el depósito.
`bucket.readOperationsPerSecond`	El número de lecturas (operaciones de obtención) por segundo de este depósito.
`bucket.readRatePerSecond`	Los bytes leídos por segundo del depósito.
`bucket.replicaIndex`	Define si el depósito tiene índices de réplica habilitados.
`bucket.replicaNumber`	Número de réplicas de este depósito.
`bucket.replicaResidentItemsRatio`	Porcentaje de elementos de réplica almacenados en caché en la RAM en este depósito.
`bucket.residentItemsRatio`	Porcentaje de todos los elementos almacenados en caché en la RAM en este depósito.
`bucket.temporaryOutOfMemoryErrorsPerSecond`	Número de interrupciones enviadas por segundo a los SDK del cliente debido a situaciones de falta de memoria de este depósito.
`bucket.threadsNumber`	El número de lectores y escritores simultáneos para el depósito de datos.
`bucket.totalOperationsPerSecond`	El total de operaciones por segundo del depósito.
`bucket.writeOperationsPerSecond`	El número de escrituras (operaciones establecidas) por segundo en este depósito.
`bucket.writeRatePerSecond`	Los bytes escritos del depósito.

Couchbase clúster muestra métrica

Estos atributos están adjuntos al tipo de evento CouchbaseClusterSample .

Métrica	Descripción
`cluster.autoFailoverCount`	El número de conmutaciones por error automáticas en el clúster.
`cluster.autoFailoverEnabled`	Indica si la conmutación por error está habilitada en el clúster.
`cluster.databaseFragmentationThreshold`	El nivel de porcentaje dentro de la base de datos en el que se produce la compactación.
`cluster.diskFreeInBytes`	El espacio libre en disco en este clúster, en bytes.
`cluster.diskQuotaTotalInBytes`	Espacio total en disco disponible para Couchbase, en bytes.
`cluster.diskTotalInBytes`	Espacio total en disco disponible, en bytes.
`cluster.diskUsedbyDataInBytes`	Disco utilizado por los datos del depósito en este clúster, en bytes.
`cluster.diskUsedInBytes`	El espacio en disco utilizado en este clúster, en bytes.
`cluster.indexFragmentationThreshold`	El nivel porcentual dentro de los índices en el que se produce la compactación.
`cluster.maximumBucketCount`	Número máximo de depósitos que admite este clúster.
`cluster.memoryQuotaTotalInBytes`	RAM total disponible para Couchbase, en bytes.
`cluster.memoryQuotaTotalPerNodeInBytes`	RAM total disponible para Couchbase, por nodo, en bytes.
`cluster.memoryQuotaUsedInBytes`	RAM total utilizada por Couchbase, en bytes.
`cluster.memoryQuotaUsedPerNodeInBytes`	RAM total utilizada por Couchbase, por nodo, en bytes.
`cluster.memoryTotalInBytes`	La RAM total de este clúster, en bytes.
`cluster.memoryUsedByDataInBytes`	RAM total utilizada por los datos del depósito en este clúster, en bytes.
`cluster.memoryUsedInBytes`	La RAM total utilizada en este clúster, en bytes.
`cluster.viewFragmentationThreshold`	El porcentaje de fragmentación dentro de todos los archivos de índice de vista en el que se activa la compactación.

Muestra de nodo de base de sofá métrica

Estos atributos están adjuntos al tipo de evento CouchbaseNodeSample .

Métrica	Descripción
`node.cpuUtilization`	La utilización de CPU del nodo.
`node.memoryFreeInBytes`	La memoria libre del nodo, en bytes.
`node.memoryTotalInBytes`	La memoria total asignada al nodo, en bytes.
`node.recoveryType`	El tipo de recuperación del nodo.
`node.services`	Los servicios del nodo.
`node.status`	El estado del nodo. (`0` = no saludable, `1` = saludable)
`node.swapTotalInBytes`	El espacio de intercambio total del nodo, en bytes.
`node.swapUsedInBytes`	El espacio de intercambio utilizado del nodo, en bytes.
`node.uptimeInMilliseconds`	El tiempo de actividad del nodo, en milisegundos.

Couchbase consulta motor muestra métrica

Estos atributos están adjuntos al tipo de evento CouchbaseQueryEngineSample .

Métrica	Descripción
`queryengine.activeRequests`	Número actual de solicitudes activas.
`queryengine.averageRequestTimeInMilliseconds`	Tiempo promedio de solicitud de este motor de consulta, en milisegundos.
`queryengine.completedLimit`	Número de consultas que Couchbase mantendrá en el log de consultas.
`queryengine.completedRequests`	Número actual de solicitudes completadas.
`queryengine.completedThresholdInMilliseconds`	Tiempo mínimo que debe tomar la consulta para iniciar sesión en el log de consultas de Couchbase, en milisegundos.
`queryengine.cores`	Número de núcleos disponibles para este motor de consulta.
`queryengine.garbageCollectionNumber`	Número de la última recogida de basura.
`queryengine.garbageCollectionPaused`	Porcentaje de tiempo que se pausa la recolección de basura.
`queryengine.garbageCollectionTimePausedInMilliseconds`	Número de milisegundos que se pausa la recolección de basura, en milisegundos.
`queryengine.medianRequestTimeInMilliseconds`	Tiempo medio de solicitud de este motor de consulta, en milisegundos.
`queryengine.preparedStatementUtilization`	Porcentaje de solicitudes que son declaraciones preparadas.
`queryengine.requestsLast15MinutesPerSecond`	Promedio de solicitudes por segundo durante los últimos 15 minutos.
`queryengine.requestsLast1MinutesPerSecond`	Promedio de solicitudes por segundo durante el último minuto.
`queryengine.requestsLast5MinutesPerSecond`	Promedio de solicitudes por segundo durante los últimos 5 minutos.
`queryengine.requestTime80thPercentileInMilliseconds`	Percentil 80 del tiempo de solicitud de este motor de consulta, en milisegundos.
`queryengine.requestTime95thPercentileInMilliseconds`	Percentil 95 del tiempo de solicitud de este motor de consulta, en milisegundos.
`queryengine.requestTime99thPercentileInMilliseconds`	Percentil 99 del tiempo de solicitud de este motor de consulta, en milisegundos.
`queryengine.systemCPUUtilization`	Utilización de CPU de este motor de consulta
`queryengine.systemMemoryInBytes`	El espacio de direcciones virtuales reservado por este motor de consulta, en bytes.
`queryengine.totalMemoryInBytes`	Cantidad acumulada de memoria asignada para objetos de montón por este motor de consulta, en bytes.
`queryengine.totalThreads`	Total de hilos utilizados por este motor de consulta.
`queryengine.uptimeInMilliseconds`	Tiempo de actividad de este motor de consulta, en milisegundos
`queryengine.usedMemoryInBytes`	Cantidad de memoria asignada para objetos de montón para este motor de consulta, en bytes.
`queryengine.userCPUUtilization`	Usuario CPU utilización de este motor de consulta.

Datos de inventario

La integración de Couchbase captura el parámetro de configuración de la base de datos de Couchbase. Los datos están disponibles en la página Inventario en la UI de infraestructura, en la fuente config/couchbase. Para obtener más información sobre los datos de inventario, consulte Comprender los datos.

La integración captura datos para el siguiente parámetro de configuración de Couchbase:

Nombre	Descripción
`Node locator`	Tipo de localizador de nodos.
`Proxy port`	Puerto proxy en el que se comunica el depósito.
`Type`	El tipo de cubo.
`UUID`	El UUID del depósito.

Nombre	Descripción
`Collection node`	El nodo sirve para recoger métrica.
`Couchbase version`	La versión de Couchbase que se ejecuta en este clúster.
`UUID`	El UUID del clúster.

Nombre	Descripción
`Cluster membership`	La membresía del clúster del nodo.
`Hostname`	El nombre de host del nodo.
`Operating system`	El sistema operativo del nodo.
`Port`	El puerto del nodo.
`Recovery type`	El tipo de recuperación del nodo.
`Services`	Una lista de servicios del nodo separados por comas.
`Version`	La versión de Couchbase que se ejecuta en este nodo.

Nombre	Descripción
`Node hostname`	El nombre de host del nodo en el que se ejecuta este motor de consulta.
`Node port`	El puerto del nodo en el que se ejecuta este motor de consulta.
`Version`	La versión de este motor de consulta.

Comprueba el código fuente

Esta integración es software de código abierto. Eso significa que puedes explorar su código fuente y enviar mejoras, o crear tu propia bifurcación y compilarla.

Te ofrecemos esta traducción automática para facilitar la lectura.

Compatibilidad y requisitos

Inicio rápido

Instalar

ECS

Kubernetes

Linux

Windows

Actualiza tu integración

Tareas posteriores a la instalación

Configurar la integración

Opciones de configuración de Couchbase

Etiquetas

Configuración de ejemplo

Configuración básica

Configuración básica con diferentes intervalos métricos/de inventario.

Reemplazo de variables de entorno

Monitoreo multiinstancia

Buscar y utilizar datos

Datos métricos

Balde base canapé muestra métrica

Couchbase clúster muestra métrica

Muestra de nodo de base de sofá métrica

Couchbase consulta motor muestra métrica

Datos de inventario

Parámetro del cubo

Parámetro cluster

Parámetro de nodo

Consultar parámetros del motor

Comprueba el código fuente

Te ofrecemos esta traducción automática para facilitar la lectura.

Integración de monitoreo de Couchbase

Compatibilidad y requisitos .css-21sua1{background:none;border:none;width:0;padding:0;}

Inicio rápido

Instalar

Kubernetes

Linux

Windows

Actualiza tu integración

Tareas posteriores a la instalación

Configurar la integración

Opciones de configuración de Couchbase

Etiquetas

Configuración de ejemplo

Configuración básica

Configuración básica con diferentes intervalos métricos/de inventario.

Reemplazo de variables de entorno

Monitoreo multiinstancia

Buscar y utilizar datos

Datos métricos

Balde base canapé muestra métrica

Couchbase clúster muestra métrica

Muestra de nodo de base de sofá métrica

Couchbase consulta motor muestra métrica

Datos de inventario

Parámetro del cubo

Parámetro cluster

Parámetro de nodo

Consultar parámetros del motor

Comprueba el código fuente

Compatibilidad y requisitos