datadog ユーザーに関連テーブルへの権限を付与します。

ALTER ROLE datadog INHERIT;

すべてのデータベースで以下のスキーマを作成します。

CREATE SCHEMA datadog;
GRANT USAGE ON SCHEMA datadog TO datadog;
GRANT USAGE ON SCHEMA public TO datadog;
GRANT pg_monitor TO datadog;
CREATE EXTENSION IF NOT EXISTS pg_stat_statements schema public;

すべてのデータベースで以下のスキーマを作成します。

CREATE SCHEMA datadog;
GRANT USAGE ON SCHEMA datadog TO datadog;
GRANT USAGE ON SCHEMA public TO datadog;
GRANT pg_monitor TO datadog;
CREATE EXTENSION IF NOT EXISTS pg_stat_statements schema public;

すべてのデータベースで以下のスキーマを作成します。

CREATE SCHEMA datadog;
GRANT USAGE ON SCHEMA datadog TO datadog;
GRANT USAGE ON SCHEMA public TO datadog;
GRANT SELECT ON pg_stat_database TO datadog;
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;

すべてのデータベースで関数を作成し、Agent がpg_stat_activityとpg_stat_statements の完全な内容を読み取れるようにします:

CREATE OR REPLACE FUNCTION datadog.pg_stat_activity() RETURNS SETOF pg_stat_activity AS
  $$ SELECT * FROM pg_catalog.pg_stat_activity; $$
LANGUAGE sql
SECURITY DEFINER;
CREATE OR REPLACE FUNCTION datadog.pg_stat_statements() RETURNS SETOF pg_stat_statements AS
    $$ SELECT * FROM pg_stat_statements; $$
LANGUAGE sql
SECURITY DEFINER;

ホスト上で実行されている Agent での Database Monitoring メトリクスの収集を構成するには (たとえば、RDS データベースから収集するために小規模な EC2 インスタンスを Agent 用にプロビジョニングする場合など)、次の手順に従ってください。

1. postgres.d/conf.yaml ファイルを編集して、host/port を指定し、監視するマスターを設定します。使用可能なすべての構成オプションについては、サンプルの postgres.d/conf.yaml を参照してください。

   init_config:
   instances:
     - dbm: true
       host: '<AWS_INSTANCE_ENDPOINT>'
       port: 5432
       username: datadog
       password: 'ENC[datadog_user_database_password]'
       aws:
         instance_endpoint: '<AWS_INSTANCE_ENDPOINT>'
         region: '<REGION>'
       tags:
         - "dbinstanceidentifier:<DB_INSTANCE_NAME>"
   
       ## Required for Postgres 9.6: Uncomment these lines to use the functions created in the setup
       # pg_stat_statements_view: datadog.pg_stat_statements()
       # pg_stat_activity_view: datadog.pg_stat_activity()
   
       ## Optional: Connect to a different database if needed for `custom_queries`
       # dbname: '<DB_NAME>'
   

   Agent バージョンが ≤ 7.49 の場合、host と port が指定されているインスタンス構成に次の設定を追加します。

   ssl: allow
   

   IAM で認証する場合は、region および instance_endpoint パラメーターを指定し、managed_authentication.enabled を true に設定します。

   注: IAM 認証を使用する場合のみ managed_authentication を有効にしてください。IAM 認証は password フィールドよりも優先されます。

   init_config:
   instances:
     - dbm: true
       host: '<AWS_INSTANCE_ENDPOINT>'
       port: 5432
       username: datadog
       aws:
         instance_endpoint: '<AWS_INSTANCE_ENDPOINT>'
         region: '<REGION>'
         managed_authentication:
           enabled: true
       tags:
         - "dbinstanceidentifier:<DB_INSTANCE_NAME>"
   
       ## Required for Postgres 9.6: Uncomment these lines to use the functions created in the setup
       # pg_stat_statements_view: datadog.pg_stat_statements()
       # pg_stat_activity_view: datadog.pg_stat_activity()
   
       ## Optional: Connect to a different database if needed for `custom_queries`
       # dbname: '<DB_NAME>'
   

   RDS インスタンスでの IAM 認証の構成については、マネージド認証との接続 を参照してください。

2. Agent を再起動 します。

ECS や Fargate のような Docker コンテナで実行されている Agent に対してインテグレーションを構成するには、いくつかの方法があり、すべて Docker 醸成ドキュメント で詳しく説明されています。

次の例では、Docker ラベル と Autodiscovery テンプレート を使用して Postgres インテグレーションを構成する方法を示します。

注: Autodiscovery によるラベルの検出を有効にするには、Agent が Docker ソケットの読み取り権限を持っている必要があります。

コマンドライン

コマンドライン から次のコマンドを実行して Agent を起動します。プレースホルダーの値を、実際のアカウントと環境の値に置き換えてください。

export DD_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export DD_AGENT_VERSION=<AGENT_VERSION>

docker run -e "DD_API_KEY=${DD_API_KEY}" \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -l com.datadoghq.ad.checks='{"postgres": {
    "init_config": {},
    "instances": [{
      "dbm": true,
      "host": "<AWS_INSTANCE_ENDPOINT>",
      "port": 5432,
      "username": "datadog",
      "password": "<UNIQUEPASSWORD>",
       "aws": {
         "instance_endpoint": "<AWS_INSTANCE_ENDPOINT>",
         "region": "<REGION>"
       },
      "tags": ["dbinstanceidentifier:<DB_INSTANCE_NAME>"]
    }]
  }}' \
  registry.datadoghq.com/agent:${DD_AGENT_VERSION}

Postgres 9.6 の場合、ホストとポートが指定されているインスタンス構成に次の設定を追加します。

"pg_stat_statements_view": "datadog.pg_stat_statements()",
"pg_stat_activity_view": "datadog.pg_stat_activity()"

Dockerfile

Dockerfile 内でラベルを指定することもできます。これにより、インフラストラクチャー構成を変更することなくカスタムの Agent を構築しデプロイできます。

FROM registry.datadoghq.com/agent:<AGENT_VERSION>

LABEL "com.datadoghq.ad.check_names"='["postgres"]'
LABEL "com.datadoghq.ad.init_configs"='[{}]'
LABEL "com.datadoghq.ad.instances"='[{"dbm": true, "host": "<AWS_INSTANCE_ENDPOINT>", "port": 5432,"username": "datadog","password": "ENC[datadog_user_database_password]","aws": {"instance_endpoint": "<AWS_INSTANCE_ENDPOINT>", "region": "<REGION>"}, "tags": ["dbinstanceidentifier:<DB_INSTANCE_NAME>"]}]'

Postgres 9.6 の場合、ホストとポートが指定されているインスタンス構成に次の設定を追加します。

"pg_stat_statements_view": "datadog.pg_stat_statements()",
"pg_stat_activity_view": "datadog.pg_stat_activity()"

datadogユーザーのパスワードをプレーンテキストで公開しないよう、Agent の シークレット管理パッケージ を使用し、ENC[] 構文を使ってパスワードを宣言します。または、Autodiscovery テンプレート変数のドキュメント を参照して、パスワードを環境変数として渡すこともできます。

Kubernetes クラスターを実行している場合は、Datadog Cluster Agent を使用して Database Monitoring を有効にしてください。

注: 続行する前に、Datadog Cluster Agent の クラスターチェック が有効になっていることを確認してください。

以下は、Datadog Cluster Agent のさまざまなデプロイ方法を使用して Postgres インテグレーションを構成するための手順です。

Operator

Kubernetes と Integrations の Operator 手順 を参照し、次の手順に従って Postgres インテグレーションを設定してください。

1. 次の構成で datadog-agent.yaml ファイルを作成または更新します。

   apiVersion: datadoghq.com/v2alpha1
   kind: DatadogAgent
   metadata:
     name: datadog
   spec:
     global:
       clusterName: <CLUSTER_NAME>
       site: <DD_SITE>
       credentials:
         apiSecret:
           secretName: datadog-agent-secret
           keyName: api-key
   
     features:
       clusterChecks:
         enabled: true
   
     override:
       nodeAgent:
         image:
           name: agent
           tag: <AGENT_VERSION>
   
       clusterAgent:
         extraConfd:
           configDataMap:
             postgres.yaml: |-
               cluster_check: true
               init_config:
               instances:
               - host: <AWS_INSTANCE_ENDPOINT>
                 port: 5432
                 username: datadog
                 password: 'ENC[datadog_user_database_password]'
                 dbm: true
                 aws:
                   instance_endpoint: <AWS_INSTANCE_ENDPOINT>
                   region: <REGION>
                 tags:
                 - "dbinstanceidentifier:<DB_INSTANCE_NAME>"
   

   Note: For Postgres 9.6, add the following lines to the instance config where host and port are specified:

   pg_stat_statements_view: datadog.pg_stat_statements()
   pg_stat_activity_view: datadog.pg_stat_activity()
   

2. 次のコマンドを使用して Datadog Operator に変更を適用します。

   kubectl apply -f datadog-agent.yaml
   

Helm

Kubernetes と Integrations の Helm 手順 を参照し、次の手順で Postgres インテグレーションを設定してください。

1. Cluster Agent インストール手順で使用した datadog-values.yaml ファイルを、次の構成で更新します。

   datadog:
     clusterChecks:
       enabled: true
   
   clusterChecksRunner:
     enabled: true
   
   clusterAgent:
     enabled: true
     confd:
       postgres.yaml: |-
         cluster_check: true
         init_config:
         instances:
         - dbm: true
           host: <AWS_INSTANCE_ENDPOINT>
           port: 5432
           username: datadog
           password: 'ENC[datadog_user_database_password]'
           aws:
             instance_endpoint: <AWS_INSTANCE_ENDPOINT>
             region: <REGION>
           tags:
           - "dbinstanceidentifier:<DB_INSTANCE_NAME>"
   

   Note: For Postgres 9.6, add the following lines to the instance config where host and port are specified:

   pg_stat_statements_view: datadog.pg_stat_statements()
   pg_stat_activity_view: datadog.pg_stat_activity()
   

2. 上記の構成ファイルを使用して、次のコマンドで Agent をデプロイします。

   helm install datadog-agent -f datadog-values.yaml datadog/datadog
   

マウントされたファイルで構成する

マウントされた構成ファイルを使用してクラスターチェックを設定するには、構成ファイルを Cluster Agent コンテナのパス /conf.d/postgres.yaml にマウントします。

cluster_check: true  # Make sure to include this flag
init_config:
instances:
  - dbm: true
    host: '<AWS_INSTANCE_ENDPOINT>'
    port: 5432
    username: datadog
    password: 'ENC[datadog_user_database_password]'
    aws:
      instance_endpoint: <AWS_INSTANCE_ENDPOINT>
      region: <REGION>
    tags:
    - "dbinstanceidentifier:<DB_INSTANCE_NAME>"

    ## Required: For Postgres 9.6, uncomment these lines to use the functions created in the setup
    # pg_stat_statements_view: datadog.pg_stat_statements()
    # pg_stat_activity_view: datadog.pg_stat_activity()

Kubernetes サービスアノテーションで構成する

ファイルをマウントする代わりに、インスタンス構成を Kubernetes サービスとして宣言できます。Kubernetes 上で実行されているエージェントに対してこのチェックを構成するには、次の構文を使用してサービスを作成します。

Autodiscovery アノテーション v2

apiVersion: v1
kind: Service
metadata:
  name: postgres
  labels:
    tags.datadoghq.com/env: '<ENV>'
    tags.datadoghq.com/service: '<SERVICE>'
  annotations:
    ad.datadoghq.com/service.checks: |
      {
        "postgres": {
          "init_config": <INIT_CONFIG>,
          "instances": [
            {
              "dbm": true,
              "host": "<AWS_INSTANCE_ENDPOINT>",
              "port": 5432,
              "username": "datadog",
              "password": "ENC[datadog_user_database_password]",
              "aws": {
                "instance_endpoint": "<AWS_INSTANCE_ENDPOINT>",
                "region": "<REGION>"
              },
              "tags": [
                "dbinstanceidentifier:<DB_INSTANCE_NAME>"
              ]
            }
          ]
        }
      }
spec:
  ports:
  - port: 5432
    protocol: TCP
    targetPort: 5432
    name: postgres

詳細については、Autodiscovery アノテーション を参照してください。

Postgres 9.6 を使用している場合、インスタンス構成に次の内容を追加します。

"pg_stat_statements_view": "datadog.pg_stat_statements()",
"pg_stat_activity_view": "datadog.pg_stat_activity()"

Cluster Agent は自動的にこの構成を登録し、Postgres チェックを開始します。

datadog ユーザーのパスワードをプレーンテキストで公開しないよう、Agent の シークレット管理パッケージ を使用し、ENC[] 構文を使ってパスワードを宣言します。