Instalar & configurar o NRDOT Collector para monitoramento de PostgreSQL auto-hospedado

Visualização

Ainda estamos trabalhando nesse recurso, mas adoraríamos que você experimentasse!

Atualmente, esse recurso é fornecido como parte de uma prévia, de acordo com nossas políticas de pré-lançamento.

Configure o monitoramento do PostgreSQL usando o NRDOT Collector em ambientes auto-hospedados, incluindo servidores físicos, máquinas virtuais e instalações autônomas.

Pré-requisitos

Antes de instalar, certifique-se de ter:

PostgreSQL 14 e superior
Uma chave de licença da New Relic.
Acesso administrativo à instância do PostgreSQL.
Conectividade de rede entre o host onde o NRDOT Collector é instalado e o banco de dados PostgreSQL.
Conectividade de rede para a documentação dos endpoints OTLP da New Relic
Esta integração está disponível como parte do programa de pré-visualização pública da New Relic. Verifique com seu gerente da organização para fazer a adesão na página Previews & Trials.
Para obter as versões compatíveis do PostgreSQL, as concessões necessárias e os parâmetros de servidor recomendados, consulte Compatibilidade e pré-requisitos.

Configurar o NRDOT Collector

Instale o NRDOT Collector no sistema:

Para sistemas Debian/Ubuntu, execute:
bash
```
$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_amd64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb
```

Para sistemas RHEL/CentOS/OEL, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_x86_64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Para sistemas Debian/Ubuntu, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_arm64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb

Para sistemas RHEL/CentOS/OEL, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_aarch64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Configurar usuário do banco de dados e concessões

Crie um usuário de monitoramento com os privilégios necessários para a sua instância PostgreSQL.

Para criar o usuário de monitoramento e as concessões:

Conecte-se à sua instância do PostgreSQL como um superusuário ou outro usuário com as permissões necessárias:
bash
```
$sudo -u postgres psql --dbname=postgres --port=5432
```
Crie o usuário de monitoramento:
```
CREATE USER <YOUR_DB_USERNAME> WITH LOGIN PASSWORD '<YOUR_DB_PASSWORD>';
```
Conceda a associação ao perfil do usuário de monitoramento conforme necessário:

Para o PostgreSQL 15 e superior, atribua a função para herdar privilégios:
```
ALTER ROLE <YOUR_DB_USERNAME> INHERIT;
```
Dica
No PostgreSQL 14, o usuário de monitoramento herda os privilégios por padrão, portanto, esta etapa pode ser ignorada.

Crie o seguinte esquema e as seguintes concessões em todos os bancos de dados a serem monitorados:

CREATE SCHEMA IF NOT EXISTS otel;
GRANT USAGE ON SCHEMA otel TO <YOUR_DB_USERNAME>;
GRANT USAGE ON SCHEMA public TO <YOUR_DB_USERNAME>;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO <YOUR_DB_USERNAME>;
GRANT pg_monitor TO <YOUR_DB_USERNAME>;
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;

(Opcional) Para coletar métricas de vetor, crie a extensão pgvector em cada banco de dados:
```
CREATE EXTENSION IF NOT EXISTS vector;
```
As funções de distância l1, hamming e jaccard exigem a versão 0.7.0 ou superior do pgvector.

(Opcional) Para verificar a conexão e as permissões, é necessário executar:

bash

$psql --username=<YOUR_DB_USERNAME> --host=localhost --port=5432 --dbname=<YOUR_DATABASE_NAME> --command '\conninfo'
$psql --username=<YOUR_DB_USERNAME> --host=localhost --port=5432 --dbname=<YOUR_DATABASE_NAME> \
>  -c "SELECT * FROM pg_stat_database LIMIT 1;" && echo "pg_stat_database OK"
>psql --username=<YOUR_DB_USERNAME> --host=localhost --port=5432 --dbname=<YOUR_DATABASE_NAME> \
>  -c "SELECT * FROM pg_stat_activity LIMIT 1;" && echo "pg_stat_activity OK"
>psql --username=<YOUR_DB_USERNAME> --host=localhost --port=5432 --dbname=<YOUR_DATABASE_NAME> \
>  -c "SELECT * FROM pg_stat_statements LIMIT 1;" && echo "pg_stat_statements OK"

Se cada comando for concluído sem erro, o usuário de monitoramento, o host e a porta estarão todos corretos.

Configurar o NRDOT Collector

Configure o NRDOT Collector com as suas configurações específicas do PostgreSQL. Selecione o seu tipo de configuração com base nas suas necessidades de monitoramento:

Esta configuração concentra-se no monitoramento essencial do PostgreSQL apenas com o receptor nrpostgresql.

Crie um arquivo de configuração chamado postgresql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/postgresql-config.yaml
```

Adicione a seguinte configuração ao arquivo postgresql-config.yaml criado na etapa anterior.

receivers:
  nrpostgresql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    databases:
      - <YOUR_DATABASE_NAME>
    collection_interval: 15s
    events:
      db.server.top_query:
        enabled: true
      db.server.query_sample:
        enabled: true
    top_query_collection:
      max_rows_per_query: 1000
      top_n_query: 200
      collection_interval: 60s
      allowed_comment_keys: [nr_service_guid]
    query_sample_collection:
      max_rows_per_query: 1000
      allowed_comment_keys: [nr_service_guid]
    # Metrics needed for the out-of-the-box dashboard but disabled by default —
    # see "Available metrics" below for the full default-on/default-off breakdown.
    metrics:
      postgresql.database.locks:
        enabled: true
      postgresql.deadlocks:
        enabled: true
      postgresql.function.calls:
        enabled: true
      postgresql.query.conflicts:
        enabled: true
      postgresql.sequential_scans:
        enabled: true
      postgresql.temp.io:
        enabled: true
      postgresql.temp_files:
        enabled: true

processors:
  batch:
  # Static server.address/server.port instead of deriving them from
  # service.instance.id — with receiver.nrpostgresql.useOTelSemconv enabled,
  # service.instance.id becomes a UUID v5 hash, not a "host:port" string, so
  # a Split(...)-based transform breaks. Applies uniformly to both metrics
  # and logs pipelines since neither depends on that internal format.
  resource/postgresql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

exporters:
  otlp/newrelic:
    endpoint: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
    headers:
      api-key: "<YOUR_NEWRELIC_LICENSE_KEY>"
    compression: gzip
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s

service:
  pipelines:
    metrics:
      receivers: [nrpostgresql]
      processors: [resource/postgresql, batch]
      exporters: [otlp/newrelic]
    logs:
      receivers: [nrpostgresql]
      processors: [resource/postgresql, batch]
      exporters: [otlp/newrelic]

Esta configuração adiciona métricas de nível de host, como CPU, memória, disco, rede e muito mais, juntamente com o monitoramento do banco de dados PostgreSQL.

Crie um arquivo de configuração chamado postgresql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/postgresql-config.yaml
```

Adicione a seguinte configuração ao arquivo postgresql-config.yaml criado na etapa anterior.

extensions:
  health_check:

receivers:
  otlp:
    protocols:
      grpc:
      http:

  host_metrics:
    collection_interval: 30s
    scrapers:
      cpu:
        metrics:
          system.cpu.time:
            enabled: false
          system.cpu.utilization:
            enabled: true
      load:
      memory:
        metrics:
          system.memory.utilization:
            enabled: true
      paging:
        metrics:
          system.paging.utilization:
            enabled: false
          system.paging.faults:
            enabled: false
      filesystem:
        metrics:
          system.filesystem.utilization:
            enabled: true
      disk:
        metrics:
          system.disk.merged:
            enabled: false
          system.disk.pending_operations:
            enabled: false
          system.disk.weighted_io_time:
            enabled: false
      network:
        metrics:
          system.network.connections:
            enabled: false
      # Uncomment to enable process metrics
      # processes:
      # process:
      #  metrics:
      #    process.cpu.utilization:
      #      enabled: true
      #    process.cpu.time:
      #      enabled: false

  nrpostgresql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    databases:
      - <YOUR_DATABASE_NAME>
    collection_interval: 15s
    events:
      db.server.top_query:
        enabled: true
      db.server.query_sample:
        enabled: true
    query_sample_collection:
      max_rows_per_query: 1000
      allowed_comment_keys: [nr_service_guid]
    top_query_collection:
      max_rows_per_query: 1000
      top_n_query: 200
      collection_interval: 60s
      allowed_comment_keys: [nr_service_guid]
    # Metrics needed for the out-of-the-box dashboard but disabled by default —
    # see "Available metrics" in the docs for the full default-on/default-off breakdown.
    metrics:
      postgresql.database.locks:
        enabled: true
      postgresql.deadlocks:
        enabled: true
      postgresql.function.calls:
        enabled: true
      postgresql.query.conflicts:
        enabled: true
      postgresql.sequential_scans:
        enabled: true
      postgresql.temp.io:
        enabled: true
      postgresql.temp_files:
        enabled: true

processors:
  metrics_transform:
    transforms:
      - include: system.cpu.utilization
        action: update
        operations:
          - action: aggregate_labels
            label_set: [state]
            aggregation_type: mean
      - include: system.paging.operations
        action: update
        operations:
          - action: aggregate_labels
            label_set: [direction]
            aggregation_type: sum

  filter/exclude_cpu_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'

  filter/exclude_memory_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'

  filter/exclude_memory_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'

  filter/exclude_filesystem_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'

  filter/exclude_filesystem_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'

  filter/exclude_filesystem_inodes_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'

  filter/exclude_system_disk:
    metrics:
      datapoint:
        - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'

  filter/exclude_network:
    metrics:
      datapoint:
        - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'

  attributes/exclude_system_paging:
    include:
      match_type: strict
      metric_names:
        - system.paging.operations
    actions:
      - key: type
        action: delete

  cumulative_to_delta:

  transform:
    trace_statements:
      - context: span
        statements:
          - truncate_all(span.attributes, 4095)
          - truncate_all(resource.attributes, 4095)
          
  transform/host:
    metric_statements:
      - context: metric
        statements:
          - set(metric.description, "")
          - set(metric.unit, "")

  # Static server.address/server.port instead of deriving them from
  # service.instance.id — with receiver.nrpostgresql.useOTelSemconv enabled,
  # service.instance.id becomes a UUID v5 hash, not a "host:port" string, so
  # a Split(...)-based transform breaks. Applies uniformly to both metrics
  # and logs pipelines since neither depends on that internal format.
  resource/postgresql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

  batch:

  resource_detection:
    detectors: ["system"]
    system:
      hostname_sources: ["os"]
      resource_attributes:
        host.id:
          enabled: true

  resource_detection/cloud:
    detectors: ["gcp", "ec2", "azure"]
    timeout: 2s
    override: true

  resource_detection/env:
    detectors: ["env"]
    timeout: 2s
    override: true

exporters:
  otlp/newrelic:
    endpoint: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
    headers:
      api-key: "<YOUR_NEWRELIC_LICENSE_KEY>"
    compression: gzip
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s

service:
  telemetry:
    metrics:
      level: none

  extensions: [health_check]

  pipelines:
    metrics/host:
      receivers: [host_metrics]
      processors:
        - metrics_transform
        - filter/exclude_cpu_utilization
        - filter/exclude_memory_utilization
        - filter/exclude_memory_usage
        - filter/exclude_filesystem_utilization
        - filter/exclude_filesystem_usage
        - filter/exclude_filesystem_inodes_usage
        - filter/exclude_system_disk
        - filter/exclude_network
        - attributes/exclude_system_paging
        - transform/host
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - cumulative_to_delta
        - batch
      exporters: [otlp/newrelic]

    metrics/postgresql:
      receivers: [nrpostgresql]
      processors:
        - resource/postgresql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    logs/postgresql:
      receivers: [nrpostgresql]
      processors:
        - resource/postgresql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    traces:
      receivers: [otlp]
      processors: [transform, resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    metrics:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    logs:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

Importante

A integração do PostgreSQL por meio do NRDOT Collector segue a precificação de ingestão de dados padrão. Observe que a configuração completa do recurso ingere mais dados do que uma configuração padrão, o que pode aumentar a fatura geral.

Parâmetro de configuração

A tabela a seguir descreve os principais parâmetros de configuração para o receptor nrpostgresql:

Parâmetro	Descrição
`<YOUR_DB_HOST>`	Insira o nome do host do banco de dados PostgreSQL.
`<YOUR_DB_PORT>`	Insira a porta do banco de dados PostgreSQL.
`<YOUR_DB_USERNAME>`	Insira seu nome de usuário do banco de dados.
`<YOUR_DB_PASSWORD>`	Insira a senha do seu banco de dados.
`<YOUR_DATABASE_NAME>`	Insira o nome do banco de dados a ser monitorado.
`<YOUR_NEWRELIC_OTLP_ENDPOINT>`	Insira o endpoint OTLP da New Relic. Para mais informações, consulte os endpoints OTLP da New Relic.
`<YOUR_NEWRELIC_LICENSE_KEY>`	Insira sua chave de licença do New Relic.
`collection_interval`	Insira o intervalo entre as coletas de métrica. Padrão: `15s`.

Dica

Você também pode:

Configurar múltiplos receptores: para monitorar várias instâncias do PostgreSQL a partir de um coletor.
Vincular o banco de dados PostgreSQL ao APM: para correlacionar o desempenho do aplicativo com as operações do banco de dados. Isso permite visualizar exatamente quais aplicativos estão gerando workloads específicas de banco de dados.
Permissões do plano EXPLAIN: para coletar planos de consulta para instruções de bloqueio ou gravação sem conceder acesso de gravação ao usuário de monitoramento.
Configure o receptor de consulta SQL: para coletar métricas personalizadas do banco de dados PostgreSQL.
Configurar o gerenciamento de segredos: para gerenciar com segurança informações confidenciais, como credenciais de banco de dados. Isso ajuda a aprimorar a segurança do ambiente de monitoramento ao evitar a inserção direta de dados sensíveis nos arquivos de configuração.

Validar a configuração do NRDOT Collector

Atualize o caminho da configuração para apontar para seu novo arquivo postgresql-config.yaml:
bash
```
$OTELCOL_OPTIONS="/etc/nrdot-collector/postgresql-config.yaml"
```
Valide a configuração do Collector NRDOT para garantir que esteja formatada corretamente e funcione adequadamente:
bash
```
$sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/postgresql-config.yaml
```

Reiniciar o NRDOT Collector

Após configurar o coletor, reinicie o serviço NRDOT Collector para aplicar as alterações:

bash

$sudo systemctl restart nrdot-collector

Para verificar se o coletor está funcionando corretamente, verifique o status do serviço:

bash

$sudo systemctl status nrdot-collector

Dica

Sempre reinicie o Collector NRDOT após fazer alterações de configuração para garantir que as novas configurações entrem em vigor.

Encontre e use seus dados

As amostras de consulta e as principais consultas chegam como eventos de log (event.name = 'db.server.query_sample' / 'db.server.top_query', db.system.name = 'postgresql'). As métricas chegam no namespace postgresql.*.

Para encontrar a entidade de banco de dados PostgreSQL no New Relic:

Vá para https://one.newrelic.com > All Capabilities > Databases.
Na dropdown Entity type, selecione PostgreSQL instance e clique em Apply.
Selecione seu banco de dados PostgreSQL na lista de entidades.

Vincular seu banco de dados PostgreSQL ao APM

Saiba como correlacionar o desempenho do aplicativo com as operações do banco de dados.

Guia de solução de problemas

Saiba como solucionar problemas comuns com o monitoramento do PostgreSQL.

Referência de métricas

Saiba mais sobre as métricas disponíveis coletadas pelo NRDOT Collector.

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

Instalar & configurar o NRDOT Collector para monitoramento de PostgreSQL auto-hospedado

Visualização

Pré-requisitos

Configurar o NRDOT Collector

Para arquitetura AMD64

Para arquitetura ARM64

Configurar usuário do banco de dados e concessões

Dica

Configurar o NRDOT Collector

Configuração padrão

Configuração com todos os recursos

Importante

Parâmetro de configuração

Dica

Validar a configuração do NRDOT Collector

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Vincular seu banco de dados PostgreSQL ao APM

Guia de solução de problemas

Referência de métricas

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

Instalar & configurar o NRDOT Collector para monitoramento de PostgreSQL auto-hospedado

Visualização

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

Configurar o NRDOT Collector

Para arquitetura ARM64

Configurar usuário do banco de dados e concessões

Dica

Configurar o NRDOT Collector

Configuração padrão

Configuração com todos os recursos

Parâmetro de configuração

Dica

Validar a configuração do NRDOT Collector

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Documentação relacionada

Vincular seu banco de dados PostgreSQL ao APM

Guia de solução de problemas

Referência de métricas

Pré-requisitos