Monitore o NGINX Plus auto-hospedado com OpenTelemetry

Monitore seus servidores NGINX Plus em execução em um host usando o OpenTelemetry Collector para enviar métricas e dados de telemetria para o New Relic.

Esta integração utiliza o prometheusreceiver do OpenTelemetry e o nginx-prometheus-exporter para monitorar as métricas de desempenho, estatísticas de conexão e integridade do servidor do NGINX Plus. A rica API HTTP no NGINX Plus fornece métricas significativamente mais detalhadas em comparação com o módulo de status stub básico no NGINX padrão.

Dashboard disponível através do quickstart New Relic NGINX OpenTelemetry Monitor.

Antes de você começar

Antes de começar, certifique-se de ter:

Uma conta New Relic com uma
Versão NGINX Plus R13 ou superior
NGINX Plus com o módulo HTTP API habilitado
Exportador NGINX Prometheus instalado e em execução junto com sua instância NGINX Plus para expor métricas da API HTTP no formato Prometheus
OpenTelemetry Collector Contrib instalado e em execução em um host Linux
Acesso à rede do host Linux para:
- Endpoint da API HTTP do NGINX Plus
- Qualquer um dos endpoints New Relic OTLP

Verifique sua configuração

Verifique a versão do NGINX Plus:

bash

$nginx -V 2>&1 | grep -o "nginx/[0-9.]*"

Saída esperada: nginx/1.25.0 ou superior (R13+)

Verifique o OpenTelemetry Collector:

bash

$otelcol-contrib --version

Saída esperada: Informações da versão (mínimo v0.88.0 requerido)

Teste a conectividade de rede:

bash

$# For US region
$curl -I https://otlp.nr-data.net:4318/v1/metrics
$# For EU region
$curl -I https://otlp.eu01.nr-data.net:4318/v1/metrics

Saída esperada: HTTP/2 405 (método não permitido é esperado)

Etapa 1: Configurar o NGINX Plus

Configure e habilite o módulo HTTP API para expor métricas do seu servidor NGINX Plus.

Adicione a configuração da API HTTP ao seu arquivo nginx.conf. Normalmente, adicione isso dentro do bloco http:

server {
    listen 8080;
    server_name localhost;

    location /api {
        api write=on;
        # Restrict access as needed
        allow 127.0.0.1;
        deny all;
    }
}

Confirme o caminho do endpoint da API (incluindo a versão) exposto em sua configuração. Registre o caminho completo do endpoint da API (sem a barra inicial) e a porta que o serve. Os padrões comuns são api/9 na porta 8080.

Use curl para confirmar se seu endpoint de API está acessível:

bash

$curl -I http://127.0.0.1:8080/api/9 2>/dev/null | head -n 1 | cut -d$' ' -f1,2

Resultado esperado:

HTTP/1.1 200

Se você vir uma resposta diferente, verifique sua configuração do NGINX Plus e certifique-se de que o módulo API esteja devidamente habilitado.

Etapa 2: Configurar o OpenTelemetry Collector

Configure o OpenTelemetry Collector para coletar métricas do seu exportador Prometheus do NGINX Plus e enviá-las para o New Relic.

Instale e configure o exportador NGINX Prometheus para expor métricas da API NGINX Plus no formato Prometheus:

bash

$# Download and install the exporter
$wget https://github.com/nginx/nginx-prometheus-exporter/releases/latest/download/nginx-prometheus-exporter_linux_amd64.tar.gz
$tar -xzf nginx-prometheus-exporter_linux_amd64.tar.gz
$sudo mv nginx-prometheus-exporter /usr/local/bin/
$
$# Run the exporter (customize the -nginx.scrape-uri as needed)
$nginx-prometheus-exporter -nginx.scrape-uri=http://127.0.0.1:8080/api

Por padrão, o exportador é executado na porta 9113 e expõe métricas em /metrics.

Atualize sua configuração do OpenTelemetry Collector (normalmente localizada em /etc/otelcol-contrib/config.yaml). No trecho de configuração abaixo:

Atualize o valor nginx.deployment.name com um nome exclusivo para identificar este servidor NGINX Plus em sua conta New Relic
Atualize o valor targets para corresponder ao host e à porta do seu exportador Prometheus (o padrão é 127.0.0.1:9113)
Atualize o valor nginx.server.endpoint para corresponder ao seu caminho e porta de status da API

Atualize o filter/nginx_metrics de acordo com sua necessidade para ingerir métricas adicionais

Mescle os receivers, processors, exporters e pipelines de serviço do trecho abaixo em sua configuração atual:

receivers:
  prometheus:
    config:
      scrape_configs:
        - job_name: 'nginx-plus'
          scrape_interval: 30s
          static_configs:
            - targets: ['127.0.0.1:9113']
processors:
  batch:
    send_batch_size: 1024
    timeout: 30s
  filter/nginx_metrics:
    metrics:
      include:
        match_type: regexp
        metric_names:
          - "nginxplus_connections_.*"
          - "nginxplus_http_requests_.*"
          - "nginxplus_ssl_.*"
      exclude:
        match_type: regexp
        metric_names:
          - "nginxplus_server_.*"
          - "nginxplus_location_zone_.*"
          - "nginxplus_cache_.*"
          - "nginxplus_stream_server_.*"
          - "nginxplus_upstream_.*"
          - "nginxplus_stream_upstream_.*"
          - "nginxplus_stream_zone_sync_zone_.*"
          - "nginxplus_resolver_.*"
          - "nginxplus_limit_request_.*"
          - "nginxplus_limit_connection_.*"
          - "nginxplus_stream_limit_connection_.*"
          - "nginxplus_worker_.*"
  resource/nginx:
    attributes:
      - key: nginx.server.endpoint
        value: <API_ENDPOINT>
        action: insert
      - key: nginx.deployment.name
        value: <DEPLOYMENT_NAME>
        action: insert
  resourcedetection:
    detectors: [system]
    system:
      resource_attributes:
        host.name:
          enabled: true
        host.id:
          enabled: true
  transform/nginx:
    metric_statements:
      - context: resource
        statements:
          - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
      - context: resource
        statements:
          - delete_key(attributes, "service.name")
  transform/metadata_nullify:
    metric_statements:
      - context: metric
        statements:
          - set(description, "")
          - set(unit, "")
exporters:
  otlp_http/newrelic:
    endpoint: ${env:NEWRELIC_OTLP_ENDPOINT}
    headers:
      api-key: ${env:NEWRELIC_LICENSE_KEY}
service:
  pipelines:
    metrics/nginx:
      receivers: [prometheus]
      processors: [batch, filter/nginx_metrics, resourcedetection, resource/nginx, transform/nginx, transform/metadata_nullify]
      exporters: [otlp_http/newrelic]

Salve o arquivo e certifique-se de que o usuário do sistema otelcol-contrib possa lê-lo.

Por padrão, a configuração coleta apenas métricas principais (conexões, requisições HTTP e SSL). Para habilitar categorias de métricas adicionais, como zonas de servidor, zonas de localização ou métricas de cache:

Identifique as métricas que você deseja habilitar na lista de métricas abaixo. Observe a qual categoria eles pertencem (por exemplo, Zonas de Servidor HTTP, Zonas de Localização, Cache).

Mova o prefixo de métrica correspondente de exclude para include no processador filter/nginx_metrics.

Exemplo: Habilitar métricas de zonas do servidor HTTP

Localize esta linha na seção exclude:

filter/nginx_metrics:
  metrics:
    include:
    # existing include metrics
    exclude:
      match_type: regexp
      metric_names:
        - "nginxplus_server_.*"

Mova para a seção include:

filter/nginx_metrics:
  metrics:
    include:
      match_type: regexp
      metric_names:
        - "nginxplus_connections_.*"
        - "nginxplus_http_requests_.*"
        - "nginxplus_ssl_.*"
        - "nginxplus_server_.*"  # Added to enable server zone metrics
    exclude:
      match_type: regexp
      metric_names:
        # Remove "nginxplus_server_.*" from here
        - "nginxplus_location_zone_.*"
        - "nginxplus_cache_.*"
        # ... rest of exclude list

Reinicie o coletor após fazer alterações:
bash
```
$sudo systemctl restart otelcol-contri.service
```

Etapa 3: Defina as variáveis de ambiente para o coletor

Injete seu endpoint New Relic e OTLP no serviço do coletor para que o exportador possa autenticar.

Escreva environment.conf com seu endpoint OTLP. Substitua YOUR_LICENSE_KEY pela chave de licença New Relic e YOUR_OTLP_ENDPOINT pelo endpoint apropriado para sua região. Consulte a documentação do endpoint OTLP para selecionar o endpoint correto.

bash

$cat <<EOF | sudo tee /etc/systemd/system/otelcol-contrib.service.d/environment.conf
$[Service]
$Environment="NEWRELIC_OTLP_ENDPOINT=YOUR_OTLP_ENDPOINT"
$Environment="NEWRELIC_LICENSE_KEY=YOUR_LICENSE_KEY"
$EOF

Etapa 4: Verifique a coleta de dados

Confirme se o OpenTelemetry Collector está coletando com sucesso as métricas do NGINX Plus e enviando-as para o New Relic.

Monitore os logs do coletor para garantir que ele esteja sendo executado sem erros:

bash

$sudo journalctl -u otelcol-contrib.service -n 20

Procure estes indicadores de sucesso:

✅ "Everything is ready. Begin running and processing data."
✅ "Scraping metrics" - Coleta bem-sucedida do exportador Prometheus
✅ "Exporting metrics" - Enviando com sucesso para New Relic

Etapa 5: (Opcional) Encaminhar logs do NGINX

Estenda a configuração do seu coletor para incluir logs de acesso e erros se você quiser eventos de log junto com as métricas.

Configurar o formato de log do NGINX Plus

Antes de encaminhar os logs, configure o NGINX Plus para usar um formato de log estruturado. Consulte a documentação de logging do NGINX para obter orientação sobre como configurar logs de acesso e erro.

Configure o OpenTelemetry Collector para encaminhamento de logs

Observe os caminhos completos para seus arquivos de log de acesso e erro do NGINX. Os padrões são geralmente /var/log/nginx/access.log e /var/log/nginx/error.log.

Atualize /etc/otelcol-contrib/config.yaml para adicionar um receptor filelog e pipeline de log:

receivers:
  prometheus:
    # existing Prometheus receiver configuration
  filelog/nginx_access_logs:
    include:
      - /var/log/nginx/access.log
  filelog/nginx_error_logs:
    include:
      - /var/log/nginx/error.log

processors:
  batch:
    # existing settings
  filter/nginx_metrics:
    # existing settings
  resourcedetection:
    # existing settings
  resource/nginx:
    # existing settings
  transform/nginx_metrics:
    # existing settings
  transform/nginx_access_logs:
    log_statements:
      - context: resource
        statements:
          - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
          - set(attributes["logtype"], "nginx")
  transform/nginx_error_logs:
    log_statements:
      - context: resource
        statements:
          - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
          - set(attributes["logtype"], "nginx-error")

exporters:
  # existing exporter setup

service:
  pipelines:
    metrics/nginx:
      receivers: [prometheus]
      processors: [batch, filter/nginx_metrics, resourcedetection, resource/nginx, transform/nginx_metrics, transform/metadata_nullify]
      exporters: [otlp_http/newrelic]
    logs/nginx-access:
      receivers: [filelog/nginx_access_logs]
      processors: [batch, resource/nginx, transform/nginx_access_logs]
      exporters: [otlp_http/newrelic]
    logs/nginx-error:
      receivers: [filelog/nginx_error_logs]
      processors: [batch, resource/nginx, transform/nginx_error_logs]
      exporters: [otlp_http/newrelic]

Conceda ao usuário otelcol-contrib acesso de leitura aos arquivos de log:

bash

$sudo usermod -a -G adm otelcol-contrib
$sudo chmod 644 /var/log/nginx/access.log
$sudo chmod 644 /var/log/nginx/error.log

Reinicie o coletor para aplicar as alterações:
bash
```
$sudo systemctl restart otelcol-contrib
```

Encontre e use dados

Acesse one.newrelic.com > Integrations & Agents.
Selecione Dashboards e clique no dashboard NGINX OTel overview.
Na janela pop-up, selecione sua conta.
Clique em [View dashboard] e veja seus dados do NGINX Plus no New Relic.

As métricas do NGINX Plus são anexadas ao Metric tipo de evento. Você pode consultar esses dados para fins de solução de problemas ou para criar gráficos e dashboards personalizados.

Métricas coletadas

O OpenTelemetry Collector coleta métricas do NGINX Prometheus exporter, que expõe métricas da API HTTP do NGINX Plus no formato Prometheus.

Abaixo estão as métricas do NGINX Plus disponíveis:

Métrica	Descrição	Tipo
`nginxplus_connections_accepted`	Conexões de cliente aceitas	Soma
`nginxplus_connections_active`	Conexões de cliente ativas	Medidor
`nginxplus_connections_dropped`	Conexões de cliente descartadas	Soma
`nginxplus_connections_idle`	Conexões de cliente ociosas	Medidor

Métrica	Descrição	Tipo
`nginxplus_http_requests_total`	Total de solicitações http	Soma
`nginxplus_http_requests_current`	Solicitações http atuais	Medidor

Métrica	Descrição	Tipo
`nginxplus_ssl_handshakes`	Handshakes SSL bem-sucedidos	Soma
`nginxplus_ssl_handshakes_failed`	Handshakes SSL com falha	Soma
`nginxplus_ssl_session_reuses`	Reutilização de sessão durante o handshake SSL	Soma

Importante

Nota: Estas métricas estão desativadas por padrão. Para habilitá-las, consulte (Opcional) Habilitar métricas adicionais para o OpenTelemetry Collector Contrib.

Métrica	Descrição	Tipo
`nginxplus_server_zone_processing`	Solicitações de cliente que estão sendo processadas no momento	Medidor
`nginxplus_server_zone_requests`	Total de requisições do cliente	Soma
`nginxplus_server_zone_responses`	Total de respostas enviadas aos clientes	Soma
`nginxplus_server_zone_responses_codes`	Total de respostas enviadas aos clientes por código	Soma
`nginxplus_server_zone_discarded`	Requisições concluídas sem enviar uma resposta	Soma
`nginxplus_server_zone_received`	Bytes recebidos de clientes	Soma
`nginxplus_server_zone_sent`	Bytes enviados aos clientes	Soma
`nginxplus_server_ssl_handshakes`	Handshakes SSL bem-sucedidos	Soma
`nginxplus_server_ssl_handshakes_failed`	Handshakes SSL com falha	Soma
`nginxplus_server_ssl_session_reuses`	Reutilização de sessão durante o handshake SSL	Soma

Importante

Nota: Estas métricas estão desativadas por padrão. Para habilitá-las, consulte (Opcional) Habilitar métricas adicionais para o OpenTelemetry Collector Contrib.

Métrica	Descrição	Tipo
`nginxplus_location_zone_requests`	Total de requisições do cliente	Soma
`nginxplus_location_zone_responses`	Total de respostas enviadas aos clientes	Soma
`nginxplus_location_zone_responses_codes`	Total de respostas enviadas aos clientes por código	Soma
`nginxplus_location_zone_discarded`	Requisições concluídas sem enviar uma resposta	Soma
`nginxplus_location_zone_received`	Bytes recebidos de clientes	Soma
`nginxplus_location_zone_sent`	Bytes enviados aos clientes	Soma

Importante

Nota: Estas métricas estão desativadas por padrão. Para habilitá-las, consulte (Opcional) Habilitar métricas adicionais para o OpenTelemetry Collector Contrib.

Métrica	Descrição	Tipo
`nginxplus_cache_size`	Tamanho total do cache	Medidor
`nginxplus_cache_max_size`	Tamanho máximo do cache	Medidor
`nginxplus_cache_cold`	O cache é considerado frio?	Medidor
`nginxplus_cache_hit_responses`	Número total de acertos no cache	Soma
`nginxplus_cache_hit_bytes`	Número total de bytes retornados de acertos de cache	Soma
`nginxplus_cache_stale_responses`	Número total de acertos de cache desatualizados	Soma
`nginxplus_cache_stale_bytes`	Número total de bytes retornados de acertos de cache desatualizados	Soma
`nginxplus_cache_updating_responses`	Número total de acertos no cache enquanto o cache está sendo atualizado	Soma
`nginxplus_cache_updating_bytes`	Número total de bytes retornados do cache enquanto o cache está sendo atualizado	Soma
`nginxplus_cache_revalidated_responses`	Número total de revalidações de cache	Soma
`nginxplus_cache_revalidated_bytes`	Número total de bytes retornados de revalidações de cache	Soma
`nginxplus_cache_miss_responses`	Número total de falhas de cache	Soma
`nginxplus_cache_miss_bytes`	Número total de bytes retornados de falhas de cache	Soma
`nginxplus_cache_expired_responses`	Número total de acertos de cache com TTL expirado	Soma
`nginxplus_cache_expired_bytes`	Número total de bytes retornados de acertos de cache com TTL expirado	Soma
`nginxplus_cache_expired_responses_written`	Número total de acertos de cache com TTL expirado gravados no cache	Soma
`nginxplus_cache_expired_bytes_written`	Número total de bytes gravados no cache de acertos de cache com TTL expirado	Soma
`nginxplus_cache_bypass_responses`	Número total de desvios do cache	Soma
`nginxplus_cache_bypass_bytes`	Número total de bytes retornados de desvios de cache	Soma
`nginxplus_cache_bypass_responses_written`	Número total de desvios de cache gravados no cache	Soma
`nginxplus_cache_bypass_bytes_written`	Número total de bytes gravados no cache de desvios de cache	Soma

Atributo	Descrição	Valores de exemplo
`server_zone`	O nome da zona do servidor (aplica-se às métricas de Zonas do Servidor HTTP)	`example.com`, `api.example.com`
`code`	Código de status da resposta HTTP (aplica-se a métricas de resposta)	`1xx`, `2xx`, `3xx`, `4xx`, `5xx`, `200`, `404`, `500`
`location_zone`	O nome da zona de localização	`/api`, `/images`, `/static`
`cache`	O nome do cache	`my_cache`, `static_cache`
`nginx.server.endpoint`	A URL do endpoint da API NGINX Plus	`http://localhost:8080/api`
`nginx.deployment.name`	Um nome exclusivo para identificar esta implantação do NGINX Plus	`production-web-01`, `staging-api`
`nginx.display.name`	Um nome amigável para exibição que combina o prefixo "servidor" com o nome da implantação	`server:production-web-01`
`host.name`	O nome do host do sistema em que o NGINX Plus está em execução	`web-server-01.example.com`
`host.id`	O identificador exclusivo do sistema host	`i-1234567890abcdef0`
`logtype`	O tipo de log que está sendo coletado (aplicável apenas a logs). Usado pelas regras de análise integradas do New Relic. Este atributo está disponível somente quando o encaminhamento de log está ativado.	`nginx` (para logs de acesso), `nginx-error` (para logs de erro)

Próximos passos

Saiba mais sobre seus dados:

Encontre e consulte seus dados do NGINX - Acesse dashboards, crie consultas personalizadas e configure alertas
Introdução ao NRQL - Aprenda a linguagem de consulta do New Relic para análise avançada de dados
Crie condições de alerta NRQL - Configure alertas personalizados com base em suas métricas do NGINX Plus

Explore o monitoramento relacionado:

Monitore o NGINX auto-hospedado com OpenTelemetry - Para implantações padrão do NGINX
Monitore o NGINX no Kubernetes com OpenTelemetry - Para ambientes conteinerizados
Visão geral do NGINX OpenTelemetry - Entenda as métricas coletadas, atributos e casos de uso
Melhores práticas do OpenTelemetry - Otimize sua configuração do OpenTelemetry

Recursos do NGINX Plus:

Documentação do exportador NGINX Prometheus - Detalhes técnicos e configuração avançada
Documentação da API do NGINX Plus - Referência completa da API e recursos

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

Monitore o NGINX Plus auto-hospedado com OpenTelemetry

Antes de você começar

Verifique sua configuração

Etapa 1: Configurar o NGINX Plus

Habilitar o módulo de API HTTP

Teste e recarregue a configuração

Verifique o endpoint da API

Etapa 2: Configurar o OpenTelemetry Collector

Instale o exportador NGINX Prometheus

Configurar a configuração do coletor

(Opcional) Habilitar métricas adicionais

Etapa 3: Defina as variáveis de ambiente para o coletor

Criar diretório de substituição do systemd

Defina as credenciais do New Relic

Reinicie o coletor

Etapa 4: Verifique a coleta de dados

Verifique os logs do coletor

Gerar tráfego de teste

Verifique os dados no New Relic

Etapa 5: (Opcional) Encaminhar logs do NGINX

Configurar o formato de log do NGINX Plus

Configure o OpenTelemetry Collector para encaminhamento de logs

Encontre e use dados

Métricas coletadas

Conexões

HTTP

SSL

Zonas do servidor HTTP

Importante

Zonas de localização

Importante

Cache

Importante

Atributo

Próximos passos

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

Monitore o NGINX Plus auto-hospedado com OpenTelemetry

Antes de você começar .css-21sua1{background:none;border:none;width:0;padding:0;}

Verifique sua configuração

Etapa 1: Configurar o NGINX Plus

Teste e recarregue a configuração

Verifique o endpoint da API

Etapa 2: Configurar o OpenTelemetry Collector

Instale o exportador NGINX Prometheus

Configurar a configuração do coletor

(Opcional) Habilitar métricas adicionais

Etapa 3: Defina as variáveis de ambiente para o coletor

Criar diretório de substituição do systemd

Defina as credenciais do New Relic

Reinicie o coletor

Etapa 4: Verifique a coleta de dados

Verifique os logs do coletor

Gerar tráfego de teste

Verifique os dados no New Relic

Etapa 5: (Opcional) Encaminhar logs do NGINX

Configurar o formato de log do NGINX Plus

Configure o OpenTelemetry Collector para encaminhamento de logs

Encontre e use dados

Métricas coletadas

Conexões

HTTP

SSL

Zonas do servidor HTTP

Zonas de localização

Cache

Atributo

Próximos passos

Antes de você começar