Couchbase monitoramento integração

Nossa integração Couchbase coleta e envia dados de inventário e métricas do seu cluster Couchbase para a plataforma New Relic, onde você pode ver rapidamente a saúde do seu ambiente Couchbase. Coletamos dados no nível do cluster, do nó, do mecanismo de consulta e do bucket para que você possa trace um problema até sua origem.

Continue lendo para instalar a integração e ver quais dados coletamos.

Compatibilidade e requisitos

Nossa integração é compatível com Couchbase versão 4.0 ou superior.

Começo rápido

Se você não estiver executando o Couchbase em ambientes Kubernetes ou ECS, recomendamos nossa instalação guiada. Nossa instalação guiada usa nosso agente de infraestrutura e nossa CLI para configurar a integração do Couchbase, e descobre outros aplicativos e fontes log em execução em seu ambiente e então recomenda quais você deve usar.

A instalação guiada funciona com a maioria das configurações. Mas se não atender às suas necessidades, existem outras opções de instalação abaixo.

Pronto para começar? Clique no botão relevante, dependendo da região do data center que você usa. Quando terminar a instalação, retorne a esta documentação para revisar as opções de configuração.

Instalação guiada, região dos EUA

Instalação guiada, região da UE

Instalar

Para instalar a integração do Couchbase, siga as instruções para o seu ambiente:

' '

Instale o agente de infraestrutura e substitua a variável INTEGRATION_FILE_NAME por nri-couchbase.
Mude o diretório para a pasta integração:
```
cd /etc/newrelic-infra/integrations.d
```

Cópia do arquivo de configuração de amostra:

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

Edite o arquivo couchbase-config.yml conforme descrito nas definições de configuração.

Baixe a imagem do instalador nri-couchbase .MSI em:
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-couchbase/nri-couchbase-amd64.msi
Para instalar a partir do prompt de comando do Windows, execute:
```
msiexec.exe /qn /i PATH\TO\nri-couchbase-amd64.msi
```
No diretório integração, C:\Program Files\New Relic\newrelic-infra\integrations.d\, crie uma cópia do arquivo de configuração de amostra executando:
```
cp couchbase-config.yml.sample couchbase-config.yml
```
Edite o arquivo couchbase-config.yml conforme descrito nas definições de configuração.

Atualize sua integração

Essa integração não é atualizada automaticamente. Para obter melhores resultados, atualize regularmente o pacote de integração e o agente de infraestrutura.

Tarefas pós-instalação

Quando terminar a instalação, você poderá definir opções de configuração. Algumas configurações são necessárias para que a integração funcione, enquanto outras são opcionais.

Configurar a integração

Se você habilitou essa integração por meio de nossa integração ECS ou Kubernetes, consulte estes documentos:

Para a instalação padrão no host, essa integração vem com um arquivo de configuração YAML, apache-config.yml. Esta configuração é onde você pode colocar as credenciais de login necessárias e configurar como os dados são coletados. Quais opções você altera dependem de sua configuração e preferências. Ele vem com um arquivo de configuração de amostra apache-config.yml.sample que você pode copiar e editar.

O arquivo de configuração possui configurações comuns aplicáveis a toda integração, como interval, timeout, inventory_source. Para ler tudo sobre essas configurações comuns, consulte nosso documento Formato de configuração .

Configurações específicas relacionadas ao Couchbase são definidas usando a seção env do arquivo de configuração. Essas configurações controlam a conexão com sua instância do Couchbase, bem como outras configurações e recursos de segurança. A lista de configurações válidas é descrita na próxima seção deste documento.

Opções de configuração do sofá

A integração Couchbase recolhe informação métrica e de inventário. Esta tabela mostra a que cada opção de configuração se aplica.

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

Contexto	Descrição	Padrão	Aplica-se a
HOSTNAME	Nome do host ou IP onde o Couchbase está rodando.	host local	MI
PORT	Porta na qual a API Couchbase está escutando.	8091	MI
QUERY_PORT	Porta na qual o serviço Couchbase N1QL está escutando.	8093	MI
USERNAME	Nome de usuário para acessar a API Couchbase.	N/A	MI
PASSWORD	Senha do usuário fornecido.	N/A	MI
USE_SSL	Use SSL ao se comunicar com o Couchbase.	false	MI
CA_BUNDLE_FILE	Localização do certificado SSL no host. Obrigatório apenas se `USE_SSL` for verdadeiro.	N/A	MI
CA_BUNDLE_DIR	Diretório de pacote da Autoridade de Certificação Alternativa.	N/A	MI
TIMEOUT	Tempo limite para solicitações de API, em segundos.	30	MI
ENABLE_BUCKETS	Se for verdade, coleta recursos do bucket.	verdadeiro	M
ENABLE_BUCKET_STATS	Se verdadeiro, coleta estatísticas adicionais do bucket.	verdadeiro	M
ENABLE_CLUSTER_AND_NODES	Se for verdade, coleta recursos de cluster e nó.	verdadeiro	M
METRICS	Defina como `true` para ativar a coleta somente de métricas.	false
INVENTORY	Defina como `true` para ativar a coleta somente de inventário.	false

Os valores para estas configurações podem ser definidos de diversas maneiras:

Adicionando o valor diretamente no arquivo de configuração (a forma mais comum).
Substituindo os valores das variáveis de ambiente usando a notação {{}} . Isto requer o agente de infraestrutura versão 1.14.0 ou superior. Para obter mais informações, consulte Configuração de infraestrutura ou consulte o exemplo de variável de ambiente.
Usando gerenciamento de segredos. Use isto para proteger informações confidenciais, como senhas que seriam expostas em texto simples no arquivo de configuração. Para obter mais informações, consulte Gerenciamento de segredos.

Etiquetas

Você pode decorar ainda mais sua métrica usando etiquetas. Os rótulos permitem adicionar atributo (pares de valores principais) à sua métrica, que você pode usar para consultar, filtrar ou agrupar sua métrica.

Nosso arquivo de configuração de amostra padrão inclui exemplos de rótulos, mas, como não são obrigatórios, você pode remover, modificar ou adicionar novos de sua escolha.

labels:
   env: production
   role: load_balancer

Exemplo de configuração

Esta é a configuração básica usada para coletar métricas e inventário do seu 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 configuração coleta métricas a cada 15 segundos e inventário a 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

Nesta configuração estamos utilizando a variável de ambiente COUCHBASE_HOST para preencher a configuração nome do host da integração:

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

Nesta configuração estamos monitorando múltiplos servidores Couchbase a partir da mesma integração. Para a primeira instância (HOSTNAME: 1st_couchbase_host) estamos coletando métrica e inventário enquanto para a segunda instância (HOSTNAME: 2nd_couchbase_host) coletaremos apenas 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

Encontre e use dados

os dados de integração são reportados ao painel de integração.

Os dados do Couchbase são anexados aos seguintes tipos de eventos:

CouchbaseBucketSample
CouchbaseClusterSample
CouchbaseNodeSample
CouchbaseQueryEngineSample

Você pode consultar esses dados para fins de resolução de problemas ou para criar gráficos e dashboards personalizados.

Para saber mais sobre como encontrar e usar seus dados, consulte Compreender os dados de integração.

Dados métricos

A Couchbase integração recolhe os seguintes dados métricos atributo. Alguns nomes de métricas são prefixados com um indicador de categoria e um ponto, como cluster. ou node..

Métrica de amostra de balde Couchbase

Esses atributos estão anexados ao tipo de evento CouchbaseBucketSample .

Métrica	Descrição
`bucket.activeResidentItemsRatio`	Porcentagem de itens ativos armazenados em cache na RAM deste bucket.
`bucket.averageDiskCommitTimeInMilliseconds`	O tempo médio de confirmação do disco do bucket, em milissegundos.
`bucket.averageDiskUpdateTimeInMilliseconds`	O tempo médio de atualização do disco do bucket, em milissegundos.
`bucket.cacheMissRatio`	Porcentagem de leituras por segundo neste bucket do disco, em oposição à RAM.
`bucket.currentConnections`	Número de conexões com esse servidor, incluindo conexões de SDKs de clientes externos, proxies, solicitações TAP e coleta de estatísticas internas.
`bucket.dataUsedInBytes`	Quantidade de dados usados por este bucket, em bytes.
`bucket.decrementHitsPerSecond`	O número de ocorrências de decréscimo por segundo do bucket.
`bucket.decrementMissesPerSecond`	O número de perdas de decremento por segundo do bucket.
`bucket.deleteHitsPerSecond`	O número de ocorrências de exclusão por segundo para esse bucket.
`bucket.deleteMissesPerSecond`	O número de falhas de exclusão por segundo para esse bucket.
`bucket.diskCreateOperationsPerSecond`	Número de novos itens criados no disco por segundo para este bucket.
`bucket.diskFetchesPerSecond`	O número de operações necessárias por segundo para buscar itens do disco no bucket.
`bucket.diskUpdateOperationsPerSecond`	Número de itens atualizados no disco por segundo para este bucket.
`bucket.diskUsedInBytes`	A quantidade de espaço em disco em uso para o bucket, em bytes.
`bucket.diskWriteQueue`	Número de itens aguardando para serem gravados no disco do bucket.
`bucket.ejectionsPerSecond`	Número total de itens por segundo sendo ejetados para o disco neste bucket
`bucket.evictionPolicy`	A política de despejo do balde.
`bucket.evictionsPerSecond`	O número de itens por segundo despejados do bucket.
`bucket.getHitsPerSecond`	Número de operações get por segundo para dados contidos neste bucket.
`bucket.getMissesPerSecond`	Número de operações get por segundo para dados que este bucket não contém.
`bucket.hitRatio`	Porcentagem de solicitações GET atendidas com dados deste bucket.
`bucket.incrementHitsPerSecond`	O número de ocorrências de incremento por segundo do bucket.
`bucket.incrementMissesPerSecond`	O número de falhas de incremento por segundo do bucket.
`bucket.itemCount`	O número de objetos armazenados no bucket.
`bucket.memoryHighWaterMarkInBytes`	Limite máximo para remoções automáticas no bucket, em bytes.
`bucket.memoryLowWaterMarkInBytes`	Marca d'água baixa para despejos automáticos no bucket, em bytes.
`bucket.memoryUsedInBytes`	A quantidade de RAM usada para o bucket, em bytes.
`bucket.metadataInRAMInBytes`	Quantidade de RAM usada para metadados neste bucket, em bytes.
`bucket.missesPerSecond`	O número de falhas por segundo do bucket.
`bucket.nodeLocator`	Tipo de localizador de nó.
`bucket.outOfMemoryErrorsPerSecond`	Número de erros graves de falta de memória para este bucket.
`bucket.OverheadInBytes`	A memória extra usada por dados transitórios (filas de persistência, filas de replicação, pontos de verificação etc.) no bucket, em bytes.
`bucket.pendingResidentItemsRatio`	Porcentagem de itens pendentes armazenados em cache na RAM deste bucket.
`bucket.quotaUtilization`	A porcentagem da cota de RAM atualmente em uso no bucket.
`bucket.readOperationsPerSecond`	O número de leituras (operações get) por segundo deste bucket.
`bucket.readRatePerSecond`	Os bytes lidos por segundo do bucket.
`bucket.replicaIndex`	Define se o bucket tem índices de réplica habilitados.
`bucket.replicaNumber`	Número de réplicas deste bucket.
`bucket.replicaResidentItemsRatio`	Porcentagem de itens de réplica armazenados em cache na RAM deste bucket.
`bucket.residentItemsRatio`	Porcentagem de todos os itens armazenados em cache na RAM neste bucket.
`bucket.temporaryOutOfMemoryErrorsPerSecond`	Número de retiradas enviadas por segundo aos SDKs do cliente devido a situações de falta de memória deste bucket.
`bucket.threadsNumber`	O número de leitores e gravadores simultâneos para o bucket de dados.
`bucket.totalOperationsPerSecond`	O total de operações por segundo do bucket.
`bucket.writeOperationsPerSecond`	O número de gravações (operações definidas) por segundo neste bucket.
`bucket.writeRatePerSecond`	Os bytes gravados no bucket.

Métrica de amostra cluster Couchbase

Esses atributos estão anexados ao tipo de evento CouchbaseClusterSample .

Métrica	Descrição
`cluster.autoFailoverCount`	O número de failovers automáticos no cluster.
`cluster.autoFailoverEnabled`	Indica se o failover está habilitado no cluster.
`cluster.databaseFragmentationThreshold`	O nível percentual no banco de dados em que ocorre a compactação.
`cluster.diskFreeInBytes`	O espaço livre em disco neste cluster, em bytes.
`cluster.diskQuotaTotalInBytes`	Espaço total em disco disponível para o Couchbase, em bytes.
`cluster.diskTotalInBytes`	Espaço total em disco disponível, em bytes.
`cluster.diskUsedbyDataInBytes`	Disco usado pelos dados do bucket neste cluster, em bytes.
`cluster.diskUsedInBytes`	O espaço em disco usado neste cluster, em bytes.
`cluster.indexFragmentationThreshold`	O nível percentual dentro dos índices em que ocorre a compactação.
`cluster.maximumBucketCount`	Número máximo de buckets compatíveis com este cluster.
`cluster.memoryQuotaTotalInBytes`	Total de RAM disponível para o Couchbase, em bytes.
`cluster.memoryQuotaTotalPerNodeInBytes`	Total de RAM disponível para o Couchbase, por nó, em bytes.
`cluster.memoryQuotaUsedInBytes`	Total de RAM usada pelo Couchbase, em bytes.
`cluster.memoryQuotaUsedPerNodeInBytes`	Total de RAM usada pelo Couchbase, por nó, em bytes.
`cluster.memoryTotalInBytes`	O total de RAM neste cluster, em bytes.
`cluster.memoryUsedByDataInBytes`	Total de RAM usada pelos dados do bucket neste cluster, em bytes.
`cluster.memoryUsedInBytes`	O total de RAM usada neste cluster, em bytes.
`cluster.viewFragmentationThreshold`	A porcentagem de fragmentação em todos os arquivos de índice de visualização em que a compactação é acionada.

Métrica de amostra do nó Couchbase

Esses atributos estão anexados ao tipo de evento CouchbaseNodeSample .

Métrica	Descrição
`node.cpuUtilization`	A utilização da CPU do nó.
`node.memoryFreeInBytes`	A memória livre do nó, em bytes.
`node.memoryTotalInBytes`	A memória total alocada para o nó, em bytes.
`node.recoveryType`	O tipo de recuperação do nó.
`node.services`	Os serviços do nó.
`node.status`	O status do nó. (`0` = não saudável, `1` = saudável)
`node.swapTotalInBytes`	O espaço de troca total do nó, em bytes.
`node.swapUsedInBytes`	O espaço de troca usado do nó, em bytes.
`node.uptimeInMilliseconds`	O tempo de operação do nó, em milissegundos.

Couchbase consulta motor amostra métrica

Esses atributos estão anexados ao tipo de evento CouchbaseQueryEngineSample .

Métrica	Descrição
`queryengine.activeRequests`	Número atual de solicitações ativas.
`queryengine.averageRequestTimeInMilliseconds`	Tempo médio de solicitação deste mecanismo de consulta, em milissegundos.
`queryengine.completedLimit`	Número de consultas que o Couchbase manterá no log de consultas.
`queryengine.completedRequests`	Número atual de solicitações concluídas.
`queryengine.completedThresholdInMilliseconds`	Tempo mínimo que a consulta deve levar para ser registrada no log de consulta do Couchbase, em milissegundos.
`queryengine.cores`	Número de núcleos disponíveis para este mecanismo de consulta.
`queryengine.garbageCollectionNumber`	Número da última coleta de lixo.
`queryengine.garbageCollectionPaused`	Porcentagem de tempo em que a coleta de lixo fica pausada.
`queryengine.garbageCollectionTimePausedInMilliseconds`	Número de milissegundos em que a coleta de lixo fica pausada, em milissegundos.
`queryengine.medianRequestTimeInMilliseconds`	Tempo médio de solicitação desse mecanismo de consulta, em milissegundos.
`queryengine.preparedStatementUtilization`	Porcentagem de solicitações que são declarações preparadas.
`queryengine.requestsLast15MinutesPerSecond`	Média de solicitações por segundo nos últimos 15 minutos.
`queryengine.requestsLast1MinutesPerSecond`	Média de solicitações por segundo no último minuto.
`queryengine.requestsLast5MinutesPerSecond`	Média de solicitações por segundo nos últimos 5 minutos.
`queryengine.requestTime80thPercentileInMilliseconds`	80º percentil do tempo de solicitação deste mecanismo de consulta, em milissegundos.
`queryengine.requestTime95thPercentileInMilliseconds`	95º percentil do tempo de solicitação deste mecanismo de consulta, em milissegundos.
`queryengine.requestTime99thPercentileInMilliseconds`	99º percentil do tempo de solicitação deste mecanismo de consulta, em milissegundos.
`queryengine.systemCPUUtilization`	Utilização da CPU deste mecanismo de consulta
`queryengine.systemMemoryInBytes`	O espaço de endereço virtual reservado por esse mecanismo de consulta, em bytes.
`queryengine.totalMemoryInBytes`	Quantidade cumulativa de memória alocada para objetos heap por esse mecanismo de consulta, em bytes.
`queryengine.totalThreads`	Total de threads usados por este mecanismo de consulta.
`queryengine.uptimeInMilliseconds`	Tempo de operação deste motor de consulta, em milissegundos
`queryengine.usedMemoryInBytes`	Quantidade de memória alocada para objetos heap para esse mecanismo de consulta, em bytes.
`queryengine.userCPUUtilization`	Utilização da CPU do usuário deste mecanismo de consulta.

Dados de inventário

A integração do Couchbase captura o parâmetro de configuração do banco de dados do Couchbase. Os dados estão disponíveis na página Inventário na interface da infraestrutura, na fonte config/couchbase . Para obter mais informações sobre dados de inventário, consulte Compreender os dados.

A integração captura dados para o seguinte parâmetro de configuração do Couchbase:

Nome	Descrição
`Node locator`	Tipo de localizador de nó.
`Proxy port`	Porta proxy na qual o bucket se comunica.
`Type`	O tipo de balde.
`UUID`	O UUID do intervalo.

Nome	Descrição
`Collection node`	O nó usado para coletar métricas.
`Couchbase version`	A versão do Couchbase em execução neste cluster.
`UUID`	O UUID do cluster.

Nome	Descrição
`Cluster membership`	A associação de cluster do nó.
`Hostname`	O nome do host do nó.
`Operating system`	O sistema operacional do nó.
`Port`	A porta do nó.
`Recovery type`	O tipo de recuperação do nó.
`Services`	Uma lista separada por vírgulas de serviços do nó.
`Version`	A versão do Couchbase em execução neste nó.

Nome	Descrição
`Node hostname`	O nome do host do nó em que esse mecanismo de consulta é executado.
`Node port`	A porta do nó em que esse mecanismo de consulta é executado.
`Version`	A versão deste mecanismo de consulta.

Verifique o código-fonte

Esta integração é um software de código aberto. Isso significa que você pode navegar pelo código-fonte e enviar melhorias, ou criar seu próprio fork e construí-lo.

Esta tradução de máquina é fornecida para sua comodidade.

Compatibilidade e requisitos

Começo rápido

Instalar

SEC

Kubernetes

Linux

Windows

Atualize sua integração

Tarefas pós-instalação

Configurar a integração

Opções de configuração do sofá

Etiquetas

Exemplo de configuração

Configuração básica

Configuração básica com diferentes intervalos métricos/inventário

Substituição de variáveis de ambiente

Monitoramento Multi-instância

Encontre e use dados

Dados métricos

Métrica de amostra de balde Couchbase

Métrica de amostra cluster Couchbase

Métrica de amostra do nó Couchbase

Couchbase consulta motor amostra métrica

Dados de inventário

Parâmetro de intervalo

Parâmetro cluster

Parâmetro do nó

Parâmetro do mecanismo de consulta

Verifique o código-fonte

Esta tradução de máquina é fornecida para sua comodidade.

Couchbase monitoramento integração

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

Começo rápido

Instalar

Kubernetes

Linux

Windows

Atualize sua integração

Tarefas pós-instalação

Configurar a integração

Opções de configuração do sofá

Etiquetas

Exemplo de configuração

Configuração básica

Configuração básica com diferentes intervalos métricos/inventário

Substituição de variáveis de ambiente

Monitoramento Multi-instância

Encontre e use dados

Dados métricos

Métrica de amostra de balde Couchbase

Métrica de amostra cluster Couchbase

Métrica de amostra do nó Couchbase

Couchbase consulta motor amostra métrica

Dados de inventário

Parâmetro de intervalo

Parâmetro cluster

Parâmetro do nó

Parâmetro do mecanismo de consulta

Verifique o código-fonte

Compatibilidade e requisitos