Installer & configurer NRDOT Collector pour le monitoring de PostgreSQL auto-hébergé

Aperçu

Nous travaillons toujours sur cette fonctionnalité, mais nous aimerions que vous l'essayiez !

Cette fonctionnalité est actuellement fournie dans le cadre d'un aperçu conformément à nos politiques de pré-sortie.

Configurez le monitoring PostgreSQL en utilisant le Collector NRDOT sur des environnements auto-hébergés incluant des serveurs physiques, des machines virtuelles et des installations autonomes.

Prérequis

Avant d’installer, assurez-vous d’avoir :

PostgreSQL 14 et versions ultérieures
Une clé de licence New Relic.
Accès administratif à votre instance PostgreSQL.
Connectivité réseau entre l'hôte où vous installez le Collector NRDOT et votre base de données PostgreSQL.
Connectivité réseau vers la documentation sur les points de terminaison OTLP de New Relic
Cette intégration est disponible dans le cadre du programme de préversion publique de New Relic. Vérifiez auprès de votre responsable d’organisation pour vous inscrire depuis la page Préversions et essais.
Pour les versions de PostgreSQL prises en charge, les autorisations requises et les paramètres de serveur recommandés, consultez Compatibilité et prérequis.

Configurer le Collector NRDOT

Installez le Collector NRDOT sur votre système :

Pour les systèmes Debian/Ubuntu, exécutez :
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
```

Pour les systèmes RHEL/CentOS/OEL, exécutez :

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

Pour les systèmes Debian/Ubuntu, exécutez :

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

Pour les systèmes RHEL/CentOS/OEL, exécutez :

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

Configurer l'utilisateur de la base de données et les autorisations

Créez un utilisateur de monitoring avec les privilèges nécessaires pour votre instance PostgreSQL.

Pour créer l'utilisateur de monitoring et les autorisations :

Connectez-vous à votre instance PostgreSQL en tant que superutilisateur ou autre utilisateur disposant des autorisations requises :
bash
```
$sudo -u postgres psql --dbname=postgres --port=5432
```
Créez l'utilisateur de monitoring :
```
CREATE USER <YOUR_DB_USERNAME> WITH LOGIN PASSWORD '<YOUR_DB_PASSWORD>';
```
Accordez l’appartenance au rôle d’utilisateur de monitoring selon les besoins :

Si vous utilisez PostgreSQL 15 ou une version ultérieure, attribuez le rôle pour hériter des privilèges :
```
ALTER ROLE <YOUR_DB_USERNAME> INHERIT;
```
Conseil
Si vous utilisez PostgreSQL 14, l'utilisateur de monitoring hérite des privilèges par défaut, vous pouvez donc ignorer cette étape.

Créez le schéma et les autorisations suivants dans chaque base de données que vous souhaitez monitorer :

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;

(Facultatif) Pour collecter les métriques vectorielles, créez l'extension pgvector dans chaque base de données :
```
CREATE EXTENSION IF NOT EXISTS vector;
```
Les fonctions de distance l1, hamming et jaccard nécessitent la version 0.7.0 ou supérieure de pgvector.

(Facultatif) Pour vérifier la connexion et les autorisations, exécutez :

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"

Si chaque commande se termine sans erreur, l’utilisateur de monitoring, l’hôte et le port sont tous corrects.

Configurer le collecteur NRDOT

Configurez le Collector NRDOT avec vos paramètres spécifiques à PostgreSQL. Sélectionnez votre type de configuration en fonction de vos besoins de monitoring :

Cette configuration se concentre sur le monitoring essentiel de PostgreSQL avec le Récepteur nrpostgresql uniquement.

Créez un fichier de configuration nommé postgresql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/postgresql-config.yaml
```

Ajoutez la configuration suivante au fichier postgresql-config.yaml que vous avez créé à l’étape précédente.

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]

Cette configuration ajoute des métriques au niveau de l'hôte telles que le CPU, la mémoire, le disque, le réseau et plus encore, en plus du monitoring de la base de données PostgreSQL.

Créez un fichier de configuration nommé postgresql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/postgresql-config.yaml
```

Ajoutez la configuration suivante au fichier postgresql-config.yaml que vous avez créé à l’étape précédente.

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]

Important

L’intégration de PostgreSQL via le NRDOT Collector suit la tarification standard d’ingestion de données. Notez que la configuration complète de la fonctionnalité ingère plus de données qu’une configuration standard, ce qui peut augmenter votre facture globale.

Paramètres de configuration

Le tableau suivant décrit les principaux paramètres de configuration du récepteur nrpostgresql :

paramètres	Description
`<YOUR_DB_HOST>`	Saisissez le nom d’hôte de votre base de données PostgreSQL.
`<YOUR_DB_PORT>`	Saisissez le port de votre base de données PostgreSQL.
`<YOUR_DB_USERNAME>`	Saisissez le nom d'utilisateur de votre base de données.
`<YOUR_DB_PASSWORD>`	Saisissez le mot de passe de votre base de données.
`<YOUR_DATABASE_NAME>`	Saisissez le nom de la base de données que vous souhaitez monitorer.
`<YOUR_NEWRELIC_OTLP_ENDPOINT>`	Saisissez le point de terminaison OTLP New Relic. Pour plus d'informations, consultez les points de terminaison OTLP New Relic.
`<YOUR_NEWRELIC_LICENSE_KEY>`	Saisissez votre clé de licence New Relic.
`collection_interval`	Saisissez l'intervalle entre les collectes de métriques. Valeur par défaut : `15s`.

Conseil

Vous pouvez également :

Configurer plusieurs récepteurs: pour monitorer plusieurs instances PostgreSQL à partir d'un seul collecteur.
Liez votre base de données PostgreSQL à l'APM: pour corréler les performances des applications avec les opérations de la base de données. Cela vous permet de voir exactement quelles applications génèrent des workloads de base de données spécifiques.
Autorisations du plan EXPLAIN: pour collecter des plans de requête pour les instructions de verrouillage ou d'écriture sans accorder d'accès en écriture à l'utilisateur de monitoring.
Configurer le Récepteur de requêtes SQL: pour collecter des métriques personnalisées à partir de votre base de données PostgreSQL.
Configurer la gestion des secrets: pour gérer en toute sécurité des informations sensibles, telles que les identifiants de base de données. Cela permet de renforcer la sécurité de votre configuration de monitoring en évitant de coder en dur des données sensibles dans les fichiers de configuration.

Valider la configuration du Collector NRDOT

Mettez à jour le chemin de configuration pour pointer vers votre nouveau fichier postgresql-config.yaml :
bash
```
$OTELCOL_OPTIONS="/etc/nrdot-collector/postgresql-config.yaml"
```
Validez la configuration du Collector NRDOT pour vous assurer qu'elle est correctement formatée et qu'elle fonctionnera correctement :
bash
```
$sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/postgresql-config.yaml
```

Redémarrer NRDOT Collector

Après avoir configuré le collecteur, redémarrez le service NRDOT Collector pour appliquer les modifications :

bash

$sudo systemctl restart nrdot-collector

Pour vérifier que le collecteur fonctionne correctement, vérifiez l'état du service :

bash

$sudo systemctl status nrdot-collector

Conseil

Redémarrez toujours le Collector NRDOT après avoir modifié la configuration pour garantir la prise en compte des nouveaux paramètres.

Trouvez et utilisez vos données

Les échantillons de requêtes et les requêtes principales arrivent sous forme d'événements de log (event.name = 'db.server.query_sample' / 'db.server.top_query', db.system.name = 'postgresql'). Les métriques arrivent sous l'espace de nommage postgresql.*.

Pour trouver votre entité de base de données PostgreSQL dans New Relic :

Allez à https://one.newrelic.com > All Capabilities > Databases.
Dans la liste déroulante Entity type, sélectionnez PostgreSQL instance, puis cliquez sur Apply.
Sélectionnez votre base de données PostgreSQL dans la liste des entités.

Lier votre base de données PostgreSQL à APM

Apprenez à corréler les performances des applications avec les opérations de base de données.

Guide de dépannage

Apprenez à résoudre les problèmes courants liés au monitoring PostgreSQL.

Référence des métriques

Découvrez les métriques disponibles collectées par le collecteur NRDOT.

Cette traduction automatique est fournie pour votre commodité.

Installer & configurer NRDOT Collector pour le monitoring de PostgreSQL auto-hébergé

Aperçu

Prérequis

Configurer le Collector NRDOT

Pour l'architecture AMD64

Pour l'architecture ARM64

Configurer l'utilisateur de la base de données et les autorisations

Conseil

Configurer le collecteur NRDOT

Configuration standard

Configuration avec toutes les fonctionnalités

Important

Paramètres de configuration

Conseil

Valider la configuration du Collector NRDOT

Redémarrer NRDOT Collector

Conseil

Trouvez et utilisez vos données

Lier votre base de données PostgreSQL à APM

Guide de dépannage

Référence des métriques

Cette traduction automatique est fournie pour votre commodité.

Installer & configurer NRDOT Collector pour le monitoring de PostgreSQL auto-hébergé

Aperçu

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

Configurer le Collector NRDOT

Pour l'architecture ARM64

Configurer l'utilisateur de la base de données et les autorisations

Conseil

Configurer le collecteur NRDOT

Configuration standard

Configuration avec toutes les fonctionnalités

Paramètres de configuration

Conseil

Valider la configuration du Collector NRDOT

Redémarrer NRDOT Collector

Conseil

Trouvez et utilisez vos données

Documentation associée

Lier votre base de données PostgreSQL à APM

Guide de dépannage

Référence des métriques

Prérequis