Monitore o Elasticsearch auto-hospedado com o OpenTelemetry

Antes de você começar

Antes de configurar o OTel Collector Contrib, certifique-se de ter:

Privilégios de acesso necessários:

• Seu New Relicchave de licença

• Privilégios de root ou sudo na máquina host

• Privilégios de administrador de cluster do Elasticsearch com privilégio de cluster monitor ou manage (consulte a documentação de privilégios de segurança do Elasticsearch para obter detalhes)

  Requisitos do sistema:

• Elasticsearch versão 7.16 ou superior - Esta integração requer um cluster Elasticsearch moderno

• Conectividade de rede - HTTPS de saída (porta 443) para o endpoint de ingestão OTLPda New Relic

  Valores de configuração prontos:

• Endpoint do Elasticsearch - Sua URL do cluster Elasticsearch (por exemplo, http://localhost:9200)

• Nome do cluster - Um identificador exclusivo para seu cluster no New Relic

  Importante

  Você deve ter o OpenTelemetry Collector Contrib instalado em seu host antes de prosseguir. Recomendamos a instalação via pacotes oficiais (.deb ou .rpm) para garantir que a unidade de serviço systemd seja criada corretamente.

Configurar o monitoramento do Elasticsearch

Assim que o OTel Collector Contrib estiver instalado, substitua o arquivo de configuração padrão do coletor pela configuração de monitoramento do Elasticsearch. Isso habilitará a coleta de métricas do Elasticsearch. Métricas de host e logs são opcionais e podem ser adicionados separadamente.

O arquivo de configuração está localizado em: /etc/otelcol-contrib/config.yaml

$
sudo cp /etc/otelcol-contrib/config.yaml /etc/otelcol-contrib/config.yaml.backup

Para configurar o coletor:

1. Abra o arquivo de configuração com um editor de texto usando privilégios de root ou sudo:

   bash

   Copiar

   $
   sudo nano /etc/otelcol-contrib/config.yaml

2. Exclua todo o conteúdo existente e substitua-o pela seguinte configuração para monitoramento do Elasticsearch:

   Importante

   Substitua o valor endpoint pelo endpoint do seu cluster Elasticsearch e atualize elasticsearch.cluster.name no bloco do processador com um nome exclusivo para identificar seu cluster no New Relic.

   receivers:
     elasticsearch:
       endpoint: "http://localhost:9200"
       collection_interval: 15s
       metrics:
         elasticsearch.os.cpu.usage:
           enabled: true
         elasticsearch.cluster.data_nodes:
           enabled: true
         elasticsearch.cluster.health:
           enabled: true
         elasticsearch.cluster.in_flight_fetch:
           enabled: true
         elasticsearch.cluster.nodes:
           enabled: true
         elasticsearch.cluster.pending_tasks:
           enabled: true
         elasticsearch.cluster.shards:
           enabled: true
         elasticsearch.cluster.state_update.time:
           enabled: true
         elasticsearch.index.documents:
           enabled: true
         elasticsearch.index.operations.merge.current:
           enabled: true
         elasticsearch.index.operations.time:
           enabled: true
         elasticsearch.node.cache.count:
           enabled: true
         elasticsearch.node.cache.evictions:
           enabled: true
         elasticsearch.node.cache.memory.usage:
           enabled: true
         elasticsearch.node.shards.size:
           enabled: true
         elasticsearch.node.cluster.io:
           enabled: true
         elasticsearch.node.documents:
           enabled: true
         elasticsearch.node.disk.io.read:
           enabled: true
         elasticsearch.node.disk.io.write:
           enabled: true
         elasticsearch.node.fs.disk.available:
           enabled: true
         elasticsearch.node.fs.disk.total:
           enabled: true
         elasticsearch.node.http.connections:
           enabled: true
         elasticsearch.node.ingest.documents.current:
           enabled: true
         elasticsearch.node.ingest.operations.failed:
           enabled: true
         elasticsearch.node.open_files:
           enabled: true
         elasticsearch.node.operations.completed:
           enabled: true
         elasticsearch.node.operations.current:
           enabled: true
         elasticsearch.node.operations.get.completed:
           enabled: true
         elasticsearch.node.operations.time:
           enabled: true
         elasticsearch.node.shards.reserved.size:
           enabled: true
         elasticsearch.index.shards.size:
           enabled: true
         elasticsearch.os.cpu.load_avg.1m:
           enabled: true
         elasticsearch.os.cpu.load_avg.5m:
           enabled: true
         elasticsearch.os.cpu.load_avg.15m:
           enabled: true
         elasticsearch.os.memory:
           enabled: true
         jvm.gc.collections.count:
           enabled: true
         jvm.gc.collections.elapsed:
           enabled: true
         jvm.memory.heap.max:
           enabled: true
         jvm.memory.heap.used:
           enabled: true
         jvm.memory.heap.utilization:
           enabled: true
         jvm.threads.count:
           enabled: true
         elasticsearch.index.segments.count:
           enabled: true
         elasticsearch.index.operations.completed:
           enabled: true
         elasticsearch.node.script.cache_evictions:
           enabled: false
         elasticsearch.node.cluster.connections:
           enabled: false
         elasticsearch.node.pipeline.ingest.documents.preprocessed:
           enabled: false
         elasticsearch.node.thread_pool.tasks.queued:
           enabled: false
         elasticsearch.cluster.published_states.full:
           enabled: false
         jvm.memory.pool.max:
           enabled: false
         elasticsearch.node.script.compilation_limit_triggered:
           enabled: false
         elasticsearch.node.shards.data_set.size:
           enabled: false
         elasticsearch.node.pipeline.ingest.documents.current:
           enabled: false
         elasticsearch.cluster.state_update.count:
           enabled: false
         elasticsearch.node.fs.disk.free:
           enabled: false
         jvm.memory.nonheap.used:
           enabled: false
         jvm.memory.pool.used:
           enabled: false
         elasticsearch.node.translog.size:
           enabled: false
         elasticsearch.node.thread_pool.threads:
           enabled: false
         elasticsearch.cluster.state_queue:
           enabled: false
         elasticsearch.node.translog.operations:
           enabled: false
         elasticsearch.memory.indexing_pressure:
           enabled: false
         elasticsearch.node.ingest.documents:
           enabled: false
         jvm.classes.loaded:
           enabled: false
         jvm.memory.heap.committed:
           enabled: false
         elasticsearch.breaker.memory.limit:
           enabled: false
         elasticsearch.indexing_pressure.memory.total.replica_rejections:
           enabled: false
         elasticsearch.breaker.memory.estimated:
           enabled: false
         elasticsearch.cluster.published_states.differences:
           enabled: false
         jvm.memory.nonheap.committed:
           enabled: false
         elasticsearch.node.translog.uncommitted.size:
           enabled: false
         elasticsearch.node.script.compilations:
           enabled: false
         elasticsearch.node.pipeline.ingest.operations.failed:
           enabled: false
         elasticsearch.indexing_pressure.memory.limit:
           enabled: false
         elasticsearch.breaker.tripped:
           enabled: false
         elasticsearch.indexing_pressure.memory.total.primary_rejections:
           enabled: false
         elasticsearch.node.thread_pool.tasks.finished:
           enabled: false
   processors:
     memory_limiter:
       check_interval: 60s
       limit_mib: ${env:NEW_RELIC_MEMORY_LIMIT_MIB:-100}
     cumulativetodelta: {}
     resource/cluster_name_override:
       attributes:
         - key: elasticsearch.cluster.name
           value: "<elasticsearch-cluster-name>"
           action: upsert
     resourcedetection:
       detectors: [ system ]
       system:
         resource_attributes:
           host.name:
             enabled: true
           host.id:
             enabled: true
           os.type:
             enabled: true
     batch:
       timeout: 10s
       send_batch_size: 1024
     attributes/cardinality_reduction:
       actions:
         - key: process.pid
           action: delete
         - key: process.parent_pid
           action: delete
     transform/metadata_nullify:
       metric_statements:
         - context: metric
           statements:
             - set(description, "")
             - set(unit, "")
   exporters:
     otlphttp:
       endpoint: ${env:NEWRELIC_OTLP_ENDPOINT}
       headers:
         api-key: ${env:NEWRELIC_LICENSE_KEY}
   service:
     pipelines:
       metrics/elasticsearch:
         receivers: [elasticsearch]
         processors: [memory_limiter, resourcedetection, resource/cluster_name_override, attributes/cardinality_reduction, cumulativetodelta, transform/metadata_nullify, batch]
         exporters: [otlphttp]

   Copiar

3. (Opcional) Para Elasticsearch seguro com autenticação e SSL, modifique a configuração do receiver:

   receivers:
     elasticsearch:
       endpoint: "https://localhost:9200"
       username: "your_elasticsearch_username"
       password: "your_elasticsearch_password"
       tls:
         ca_file: "/etc/elasticsearch/certs/http_ca.crt"
         insecure_skip_verify: false
       collection_interval: 15s

   Copiar

4. (Opcional) Para coletar métricas do host, adicione o receptor hostmetrics:

   receivers:
     hostmetrics:
       collection_interval: 60s
       scrapers:
         cpu:
           metrics:
             system.cpu.utilization: {enabled: true}
             system.cpu.time: {enabled: true}
         load:
           metrics:
             system.cpu.load_average.1m: {enabled: true}
             system.cpu.load_average.5m: {enabled: true}
             system.cpu.load_average.15m: {enabled: true}
         memory:
           metrics:
             system.memory.usage: {enabled: true}
             system.memory.utilization: {enabled: true}
         disk:
           metrics:
             system.disk.io: {enabled: true}
             system.disk.operations: {enabled: true}
         filesystem:
           metrics:
             system.filesystem.usage: {enabled: true}
             system.filesystem.utilization: {enabled: true}
         network:
           metrics:
             system.network.io: {enabled: true}
             system.network.packets: {enabled: true}
         process:
           metrics:
             process.cpu.utilization:
               enabled: true

   Copiar

   E adicione aos pipelines de serviço:

   service:
     pipelines:
       metrics/host:
         receivers: [hostmetrics]
         processors: [memory_limiter, resourcedetection, batch]
         exporters: [otlphttp]

   Copiar

5. (Opcional) Para coletar logs do Elasticsearch, adicione o receiver filelog. Certifique-se de que o usuário que executa o serviço do coletor (otelcol-contrib) tenha acesso de leitura aos seus arquivos de log do Elasticsearch:

   Se estiver executando o Elasticsearch no Linux (Host):

   receivers:
     filelog:
       include:
         - /var/log/elasticsearch/elasticsearch.log
         - /var/log/elasticsearch/*.log

   Copiar

   Se estiver executando o Elasticsearch no Docker:

   receivers:
     filelog:
       include:
         - /var/lib/docker/containers/*/*.log
       operators:
         - type: move
           from: attributes.log
           to: body

   Copiar

   E adicione aos pipelines de serviço:

   service:
     pipelines:
       logs:
         receivers: [filelog]
         processors: [resource/cluster_name_override]
         exporters: [otlphttp]

   Copiar

6. (Opcional) Para adicionar tags de metadados personalizadas às suas métricas, use o processador resource/static_override:

   processors:
     resource/static_override:
       attributes:
         - key: env
           value: "production"
           action: upsert
   service:
     pipelines:
       metrics/elasticsearch:
         receivers: [elasticsearch]
         processors: [memory_limiter, resourcedetection, resource/cluster_name_override, resource/static_override, attributes/cardinality_reduction, cumulativetodelta, transform/metadata_nullify, batch]
         exporters: [otlphttp]

   Copiar

7. Salve o arquivo de configuração.

8. Defina as variáveis de ambiente:

   Crie um diretório de substituição do systemd:

   bash

   Copiar

   $
   sudo mkdir -p /etc/systemd/system/otelcol-contrib.service.d

   Crie o arquivo de configuração do ambiente:

   bash

   Copiar

   $
   cat <<EOF | sudo tee /etc/systemd/system/otelcol-contrib.service.d/environment.conf
   $
   [Service]
   $
   Environment="NEWRELIC_OTLP_ENDPOINT=https://otlp.nr-data.net:4318"
   $
   Environment="NEWRELIC_LICENSE_KEY=YOUR_LICENSE_KEY_HERE"
   $
   Environment="NEW_RELIC_MEMORY_LIMIT_MIB=100"
   $
   EOF

   Atualize a configuração com seus valores:

   • Substitua https://otlp.nr-data.net:4318 pelo endpoint da sua região
   • Substitua YOUR_LICENSE_KEY_HERE pela sua chave de licença da New Relic
   • Substitua 100 pelo limite de memória desejado em MiB para o coletor (padrão: 100 MiB). Ajuste com base nas necessidades do seu ambiente

9. Reinicie o OTel Collector Contrib para aplicar as alterações:

   bash

   Copiar

   $
   sudo systemctl daemon-reload
   $
   sudo systemctl restart otelcol-contrib.service

Verificar coleta de dados

Verifique se o OTel Collector Contrib está em execução e coletando dados sem erros:

1. Verifique o status do serviço do coletor:

   bash

   Copiar

   $
   sudo systemctl status otelcol-contrib.service

2. Monitore os logs do coletor em busca de erros:

   bash

   Copiar

   $
   sudo journalctl -u otelcol-contrib.service -f

   Procure por conexões bem-sucedidas com o Elasticsearch e o New Relic. Se você encontrar erros, consulte o guia de solução de problemas.