Dockerを使用したPostgreSQL監視のためのNRDOTのインストールと設定

前提条件

インストールする前に、以下のものがあることを確認してください：

• ホストにインストールされているDocker。

• すでに実行中のPostgreSQLコンテナ（PostgreSQL 14以降）。

• NewRelicライセンスキー。

• コレクターコンテナからNew Relic OTLPエンドポイントへのネットワーク接続。

  サポートされているPostgreSQLのバージョン、必要な権限、および推奨されるサーバーパラメーターについては、互換性と前提条件をご覧ください。

データベースユーザーと権限を設定する

docker execを使用してPostgreSQLコンテナに対してSQLを実行し、必要な権限を持つ監視ユーザーを作成します。<YOUR_POSTGRESQL_CONTAINER_NAME>、<YOUR_SUPERUSER>、<YOUR_DB_USERNAME>、<YOUR_DB_PASSWORD>をご自身の値に置き換えます。

1. スーパーユーザーとして接続し、監視ユーザーを作成します：

   bash

   コピー

   $
   docker exec -i <YOUR_POSTGRESQL_CONTAINER_NAME> psql -U <YOUR_SUPERUSER> -d postgres -c "
   $
   CREATE USER <YOUR_DB_USERNAME> WITH LOGIN PASSWORD '<YOUR_DB_PASSWORD>';
   $
   "

2. PostgreSQL 15以降を使用している場合は、権限を継承するようにロールを割り当ててください：

   bash

   コピー

   $
   docker exec -i <YOUR_POSTGRESQL_CONTAINER_NAME> psql -U <YOUR_SUPERUSER> -d postgres -c "
   $
   ALTER ROLE <YOUR_DB_USERNAME> INHERIT;
   $
   "

   ヒント

   PostgreSQL 14を使用している場合、監視ユーザーはデフォルトで権限を継承するため、この手順をスキップできます。

3. モニターするすべてのデータベースにスキーマと権限を適用してください。<DB_NAMES>をスペース区切りのデータベース名のリストに置き換えてください：

   bash

   コピー

   $
   for db in <DB_NAMES>; do
   $
     docker exec -i <YOUR_POSTGRESQL_CONTAINER_NAME> psql -U <YOUR_SUPERUSER> -d "$db" -c "
   $
     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;
   $
     "
   $
   done

4. （オプション）ベクトルメトリクスを収集するには、各データベースでpgvector拡張機能を作成します：

   bash

   コピー

   $
   for db in <DB_NAMES>; do
   $
     docker exec -i <YOUR_POSTGRESQL_CONTAINER_NAME> psql -U <YOUR_SUPERUSER> -d "$db" -c "CREATE EXTENSION IF NOT EXISTS vector;"
   $
   done

   l1、hamming、およびjaccardの距離関数には、pgvectorバージョン0.7.0以降が必要です。

5. （オプション）接続と権限を確認するには、次を実行します：

   bash

   コピー

   $
   docker exec -i <YOUR_POSTGRESQL_CONTAINER_NAME> psql -U <YOUR_DB_USERNAME> -d <YOUR_DATABASE_NAME> -c "SELECT * FROM pg_stat_statements LIMIT 1;"

   コマンドがエラーなしで完了した場合、監視ユーザーと権限は正しいです。

NRDOT Collector の設定を作成します

この設定は、nrpostgresqlレシーバーを使用した必須のPostgreSQL監視に焦点を当てています。現在のディレクトリにpostgresql-config.yamlを生成するには、Dockerホストで以下を実行します：

$
cat << 'EOF' > postgresql-config.yaml
$
receivers:
$
  nrpostgresql:
$
    endpoint: "<YOUR_POSTGRESQL_CONTAINER_NAME>:5432"
$
    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
$
      db.server.query_plan:
$
        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]
$

$
    resource_attributes:
$
      db.system.version:
$
        enabled: true
$
    # 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:
$
  batch/metrics:
$
    send_batch_size: 8192
$
    send_batch_max_size: 8192
$
    timeout: 10s
$

$
exporters:
$
  otlp/newrelic:
$
    endpoint: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
$
    headers:
$
      api-key: "<YOUR_NEWRELIC_LICENSE_KEY>"
$
    compression: gzip
$
    sending_queue:
$
      enabled: true
$
      sizer: bytes
$
      queue_size: 100_000_000
$
      num_consumers: 10
$
      batch:
$
        sizer: bytes
$
        max_size: 1_000_000
$
        min_size: 0
$
        flush_timeout: 5s
$
    retry_on_failure:
$
      enabled: true
$
      initial_interval: 5s
$
      max_interval: 30s
$
      max_elapsed_time: 300s
$

$
service:
$
  telemetry:
$
    metrics:
$
      level: none
$
  pipelines:
$
    metrics:
$
      receivers: [nrpostgresql]
$
      processors: [batch/metrics]
$
      exporters: [otlp/newrelic]
$
    logs:
$
      receivers: [nrpostgresql]
$
      processors: [batch]
$
      exporters: [otlp/newrelic]
$
EOF

設定パラメーター [#configuration-parameters]

NRDOT Collectorコンテナを起動してください。

コンテナ名で<YOUR_POSTGRESQL_CONTAINER_NAME>を解決できるように、PostgreSQLコンテナと同じDockerネットワーク上でコレクターを実行します：

$
docker run -d \
>
  --name nrdot-collector \
>
  --network <YOUR_DOCKER_NETWORK> \
>
  -v "$PWD/postgresql-config.yaml:/etc/nrdot-collector/postgresql-config.yaml" \
>
  newrelic/nrdot-collector:latest \
>
  --config /etc/nrdot-collector/postgresql-config.yaml

$
docker network create <YOUR_DOCKER_NETWORK>
$
docker network connect <YOUR_DOCKER_NETWORK> <YOUR_POSTGRESQL_CONTAINER_NAME>

コレクターコンテナが実行されていることを確認します：

$
docker ps --filter name=nrdot-collector

実行されていない場合は、ログでエラーを確認してください。最も一般的な原因は、postgresql-config.yamlにおけるYAMLインデントの問題、または到達不能なPostgreSQLコンテナです：

$
docker logs nrdot-collector

$
docker restart nrdot-collector

データを探す、使う

データの収集が開始されると、New Relic UIから包括的なPostgreSQLデータベース監視にアクセスできます。

New RelicでPostgreSQLデータベースエンティティを見つけるには：

1. one.newrelic.com > All capabilities > Databasesに移動します。

2. Entity typeドロップダウンからPostgreSQL instanceを選択し、Applyをクリックします。

3. エンティティのリストからPostgreSQLデータベースを選択します。

   データが到着していることを確認するには、クエリビルダーで次のクエリを実行します：

   SELECT count(*) FROM Metric
   WHERE metricName LIKE 'postgresql.%'
   AND instrumentation.provider = 'opentelemetry'
   SINCE 10 minutes ago

   コピー