セルフホストでのPostgreSQL監視のためのNRDOTのインストールと設定

前提条件

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

• PostgreSQL 14以降

• NewRelicライセンスキー。

• PostgreSQLインスタンスへの管理アクセス。

• NRDOT CollectorをインストールするホストとPostgreSQLデータベース間のネットワーク接続。

• New Relic OTLPエンドポイントのドキュメントへのネットワーク接続

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

NRDOT Collectorのセットアップ

システムにNRDOT Collectorをインストールします：

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

PostgreSQLインスタンスに必要な権限を持つ監視ユーザーを作成します。

監視ユーザーと権限を作成するには：

1. スーパーユーザー、または必要な権限を持つ別のユーザーとしてPostgreSQLインスタンスに接続します：

   bash

   コピー

   $
   sudo -u postgres psql --dbname=postgres --port=5432

2. 監視ユーザーを作成する：

   CREATE USER <YOUR_DB_USERNAME> WITH LOGIN PASSWORD '<YOUR_DB_PASSWORD>';

   コピー

3. 必要に応じて、監視ユーザーロールのメンバーシップを付与する：

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

  ALTER ROLE <YOUR_DB_USERNAME> INHERIT;

  コピー

  ヒント

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

• 監視するすべてのデータベースに次のスキーマと権限を作成します：

  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;

  コピー

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

  CREATE EXTENSION IF NOT EXISTS vector;

  コピー

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

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

  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"

  各コマンドがエラーなしで完了した場合、監視ユーザー、ホスト、およびポートはすべて正しいです。

NRDOT Collectorを構成する

PostgreSQL固有の設定でNRDOT Collectorを設定してください。

この設定は、nrpostgresqlレシーバーのみを使用した基本的なPostgreSQL監視に焦点を当てています。

1. postgresql-config.yamlという名前の設定ファイルを作成します：

   bash

   コピー

   $
   sudo nano /etc/nrdot-collector/postgresql-config.yaml

2. 前の手順で作成したpostgresql-config.yamlファイルに以下の設定を追加します。

   PostgreSQL ホスト名/IP

   PostgreSQLのホスト名またはIPアドレスを入力してください。

   PostgreSQLポート

   PostgreSQLのポート番号を入力してください。デフォルト値は5432です。

   データベースユーザー名

   認証用のデータベースユーザー名を入力してください

   データベースパスワード

   監視ユーザーに設定したパスワードを入力してください。

   データベース名

   モニターするデータベースの名前を入力してください。

   New Relic OTLPエンドポイント

   New Relic OTLPエンドポイントを入力します。詳細については、https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/ を参照してください。

   New Relicライセンスキー

   New Relicライセンスキーを入力してください。

   postgresql-config.yaml

   Downloadコピー

   1
   receivers:
   2
   nrpostgresql:
   3
     endpoint: "postgresql.example.com:5432"
   4
     username: "newrelic"
   5
     password: "YOUR_PASSWORD"
   6
   databases:
   7
      - YOUR_DATABASE_NAME
   8
     collection_interval: 15s
   9
   events:
   10
      db.server.top_query:
   11
        enabled: true
   12
      db.server.query_sample:
   13
        enabled: true
   14
      db.server.query_plan:
   15
        enabled: true
   16
   top_query_collection:
   17
      max_rows_per_query: 1000
   18
      top_n_query: 200
   19
      collection_interval: 60s
   20
      allowed_comment_keys: [nr_service_guid]
   21
   query_sample_collection:
   22
      max_rows_per_query: 1000
   23
      allowed_comment_keys: [nr_service_guid]
   24
   resource_attributes:
   25
      db.system.version:
   26
        enabled: true
   27
     # Metrics needed for the out-of-the-box dashboard but disabled by default:
   28
     # see "Available metrics" below for the full default-on/default-off breakdown.
   29
   metrics:
   30
      postgresql.database.locks:
   31
        enabled: true
   32
      postgresql.deadlocks:
   33
        enabled: true
   34
      postgresql.function.calls:
   35
        enabled: true
   36
      postgresql.query.conflicts:
   37
        enabled: true
   38
      postgresql.sequential_scans:
   39
        enabled: true
   40
      postgresql.temp.io:
   41
        enabled: true
   42
      postgresql.temp_files:
   43
        enabled: true
   44
   processors:
   45
   batch:
   46
     batch/metrics:
   47
     send_batch_size: 8192
   48
     send_batch_max_size: 8192
   49
     timeout: 10s
   50
   exporters:
   51
     otlp/newrelic:
   52
     endpoint: "https://otlp.nr-data.net:4318"
   53
   headers:
   54
      api-key: "YOUR_LICENSE_KEY"
   55
     compression: gzip
   56
   sending_queue:
   57
      enabled: true
   58
      sizer: bytes
   59
      queue_size: 100_000_000
   60
      num_consumers: 10
   61
      batch:
   62
        sizer: bytes
   63
        max_size: 1_000_000
   64
        min_size: 0
   65
        flush_timeout: 5s
   66
   retry_on_failure:
   67
      enabled: true
   68
      initial_interval: 5s
   69
      max_interval: 30s
   70
      max_elapsed_time: 300s
   71
   service:
   72
   telemetry:
   73
   metrics:
   74
      level: none
   75
   pipelines:
   76
   metrics:
   77
      receivers: [nrpostgresql]
   78
      processors: [batch/metrics]
   79
      exporters: [otlp/newrelic]
   80
   logs:
   81
      receivers: [nrpostgresql]
   82
      processors: [batch]
   83
      exporters: [otlp/newrelic]

   設定パラメーター

   次の表は、 nrpostgresql受信機のキー設定を説明しています。

   パラメータ	説明
   <YOUR_DB_HOST>	PostgreSQLデータベースのホスト名を入力してください。
   <YOUR_DB_PORT>	PostgreSQLデータベースのポートを入力します。
   <YOUR_DB_USERNAME>	データベースのユーザー名を入力してください。
   <YOUR_DB_PASSWORD>	データベースのパスワードを入力してください。
   <YOUR_DATABASE_NAME>	監視するデータベースの名前を入力します。
   databases	統計を収集するデータベースのリストです。デフォルト：[]（すべての非テンプレートデータベース）。メトリクスにのみ適用されます。クエリサンプルとトップクエリはこのリストを無視し、exclude_databasesによってのみフィルタリングされます。
   exclude_databases	統計、クエリサンプル、トップクエリから除外されるデータベース。デフォルト：[]。監視ユーザーがアクセスできない内部データベースには、これを使用してください。
   <YOUR_NEWRELIC_OTLP_ENDPOINT>	New Relic OTLPエンドポイントを入力します。詳細については、New Relic OTLPエンドポイントを参照してください。
   <YOUR_NEWRELIC_LICENSE_KEY>	New Relicのライセンスキーを入力してください。
   collection_interval	メトリクススクレイプの間隔を入力します。デフォルト：15s。

NRDOT Collectorの設定の検証

1. 新しいpostgresql-config.yamlファイルを指すように設定パスを更新します：

   bash

   コピー

   $
   sudo sed -i 's|OTELCOL_OPTIONS="--config=/etc/nrdot-collector/config.yaml"|OTELCOL_OPTIONS="--config=/etc/nrdot-collector/postgresql-config.yaml"|' /etc/nrdot-collector/nrdot-collector.conf

2. NRDOT Collectorの設定を検証して、正しくフォーマットされ、適切に機能することを確認します：

   bash

   コピー

   $
   sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/postgresql-config.yaml

NRDOT Collectorを再起動します

コレクターを設定した後、NRDOT Collectorサービスを再起動して変更を適用します：

$
sudo systemctl restart nrdot-collector

コレクターが正常に実行されていることを確認するには、サービスステータスを確認します：

$
sudo systemctl status nrdot-collector

データを探す、使う

クエリのサンプルと上位のクエリは、ログイベント（event.name = 'db.server.query_sample'/'db.server.top_query'、db.system.name = 'postgresql'）として到着します。メトリクスはpostgresql.*ネームスペースの下に到着します。

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

1. https://one.newrelic.com > All Capabilities > Databasesに移動します。
2. Entity typeドロップダウンからPostgreSQL instanceを選択し、Applyをクリックします。
3. エンティティのリストからPostgreSQLデータベースを選択します。