このモジュールは、Datadog Agent をインストールし、Puppet レポートを Datadog に送信します。

要件

Datadog Puppet モジュールは Linux および Windows をサポートし、Puppet >= 4.6.x または Puppet Enterprise バージョン >= 2016.4 と互換性があります。互換性の詳細については、Puppet Forge のモジュールページを確認してください。

インストール

datadog_agent Puppet モジュールを Puppet マスターのモジュールパスにインストールします。

puppet module install datadog-datadog_agent

アップグレード

• デフォルトでは、Datadog Agent v7.x がインストールされます。以前のバージョンの Agent を使用するには、設定 agent_major_version を変更します。
• agent5_enable は agent_major_version に置き換えられたため使用されなくなりました。
• agent6_extra_options は、Agent v6 と v7 の両方に適用されるため、agent_extra_options に名前が変更されました。
• agent6_log_file は、Agent v6 と v7 の両方に適用されるため、agent_log_file に名前が変更されました。
• agent5_repo_uri と agent6_repo_uri は、すべての Agent バージョンで agent_repo_uri になります。
• conf_dir と conf6_dir はすべての Agent バージョンで conf_dir になります。
• Linux で作成されたリポジトリファイルの名前は、すべての Agent バージョンで datadog5/datadog6 ではなく datadog になりました。

コンフィギュレーション

datadog_agent モジュールが puppetserver/puppetmaster（またはマスターレスホスト）にインストールされたら、次の構成手順に従います。

1. Datadog API キーを取得します。

2. Datadog クラスをノードマニフェストに追加します (例: /etc/puppetlabs/code/environments/production/manifests/site.pp)。

   class { 'datadog_agent':
       api_key => "<YOUR_DD_API_KEY>",
   }
   

   デフォルトの ‘datadoghq.com’ 以外の Datadog サイトを使用している場合は、ここにも設定します。

   class { 'datadog_agent':
       api_key => "<YOUR_DD_API_KEY>",
       datadog_site => "datadoghq.eu",
   }
   

   CentOS/RHEL バージョン <7.0 と Ubuntu < 15.04 の場合は、サービスプロバイダーを upstart と指定します。

   class { 'datadog_agent':
       api_key => "<YOUR_DD_API_KEY>",
       service_provider => 'upstart'
   }
   

   ここで使用できる引数のリストについては、コンフィギュレーション変数セクションを参照してください。

3. (オプション) Agent で使用するインテグレーションを含めます。次の例では、mongo インテグレーションをインストールします。

   class { 'datadog_agent::integrations::mongo':
       # integration arguments go here
   }
   

   特定のインテグレーションで使用できるすべての引数については、コード内のコメントを参照してください。

   インテグレーションに専用クラスのマニフェストがない場合でも、その構成を追加できます。以下は ntp チェックの例です。

   class { 'datadog_agent':
       api_key      => "<YOUR_DD_API_KEY>",
       integrations => {
           "ntp" => {
               init_config => {},
               instances => [{
                   offset_threshold => 30,
               }],
           },
       },
   }
   

4. (オプション) Puppet 自体に関するメトリクスとイベントを収集するには、レポートに関するセクションを参照してください。

インテグレーションのアップグレード

特定のインテグレーションバージョンをインストールして固定するには、datadog_agent::install_integration を使用します。これは、datadog-agent integration コマンドを呼び出して、特定のインテグレーションが確実にインストールまたはアンインストールされるようにします。次に例を示します。

datadog_agent::install_integration { "mongo-1.9":
    ensure => present,
    integration_name => 'datadog-mongo',
    version => '1.9.0',
    third_party => false,
}

ensure 引数は次の 2 つの値を取ることができます。

• present（デフォルト）
• absent（以前に固定されたバージョンのインテグレーションを削除します）

サードパーティのインテグレーションをインストールするには (たとえば、マーケットプレイスから)、third_party 引数を true に設定します。

インテグレーションを、Agent にバンドルされているバージョンより古いバージョンにダウングレードすることはできませんのでご注意ください。

レポート

Datadog タイムラインへの Puppet 実行のレポートを有効にするには、Puppet マスターのレポートプロセッサとクライアントのレポートを有効にします。クライアントは、各チェックイン後に実行レポートをマスターに送り返します。

1. マスターのノード構成マニフェストで puppet_run_reports オプションを true に設定します。

   class { 'datadog-agent':
     api_key            => '<YOUR_DD_API_KEY>',
     puppet_run_reports => true
     # ...
   }
   

   dogapi gem は自動的にインストールされます。インストールをカスタマイズしたい場合は manage_dogapi_gem を false に設定してください。

2. 次のコンフィギュレーションオプションを Puppet マスターコンフィギュレーションに追加します (例: /etc/puppetlabs/puppet/puppet.conf)。

   [main]
   # No modification needed to this section
   # ...
   
   [master]
   # Enable reporting to Datadog
   reports=datadog_reports
   # If you use other reports, add datadog_reports to the end,
   # for example: reports=store,log,datadog_reports
   # ...
   
   [agent]
   # ...
   report=true
   

ini_setting module を使用する場合:

  ini_setting { 'puppet_conf_master_report_datadog_puppetdb':
    ensure  => present,
    path    => '/etc/puppetlabs/puppet/puppet.conf',
    section => 'master',
    setting => 'reports',
    value   => 'datadog_reports,puppetdb',
    notify  => [
      Service['puppet'],
      Service['puppetserver'],
    ],
  }

3. すべての Puppet クライアントノードで、同じ場所に以下を追加します。

   [agent]
   # ...
   report=true
   

ini_setting module を使用する場合:

  ini_setting { 'puppet_conf_agent_report_true':
    ensure  => present,
    path    => '/etc/puppetlabs/puppet/puppet.conf',
    section => 'agent',
    setting => 'report',
    value   => 'true',
    notify  => [
      Service['puppet'],
    ],
  }

4. (オプション) レポートとファクトのタグ付けを有効にします。

   Datadog にイベントとして送られたレポートにタグを追加することができます。これらのタグの源泉は、レポートが関連付けられている任意のノードについての Puppet ファクトです。必ず 1:1 の関係であるものとし、可読性を確保するために構造化ファクト (ハッシュ、配列など) を含むことは禁止されています。通常のファクトのタグ付けを有効にするには、パラメーター datadog_agent::reports::report_fact_tags をファクトの配列値に設定します (例: ["virtual","operatingsystem"])。信頼できるファクトのタグ付けを有効にするには、パラメーター datadog_agent::reports::report_trusted_fact_tags をファクトの配列値に設定します (例: ["certname","extensions.pp_role","hostname"])。

   例: これらの設定を変更するには、pe-puppetserver (または puppetserver) を再起動してレポートのプロセッサを再読み込みする必要があります。サービスを再起動する前に、変更がデプロイされていることをご確認ください。

   ヒント:

   • ドットインデックスを使用してターゲットファクトを指定します。これを行わない場合、ファクトデータセット全体がひとつの文字列の値として扱われます (あまり有用とは言えません) 。
   • ホスト名、アップタイム、メモリーなど、モニタリングの汎用データを複製しないでください。
   • ロール、所有者、テンプレート、データセンターなどのコアファクトを調整します。これらはメトリクスから取得した同じタグに意義ある相関関係を構築するのに役立ちます。

5. Event Stream で sources:puppet を検索して、Puppet データが Datadog にあることを確認します。

NPM の設定

Datadog Agent Network Performance Monitoring (NPM) 機能を有効にするには、次の手順に従います。

1. (Windows のみ) すでに Agent がインストールされている場合は、メインクラスに win_ensure => absent を渡してアンインストールし、他のクラスの定義も削除します。
2. (Windows のみ) datadog::datadog_agent クラスに windows_npm_install オプションを値 true で渡します。前のステップで追加した win_ensure を削除します。
3. datadog_agent::system_probe クラスを使用して、コンフィギュレーションファイルを適切に作成します。

class { 'datadog_agent::system_probe':
    network_enabled => true, 
}

USM のセットアップ

Datadog Agent Universal Service Monitoring (USM) を有効にするには、datadog_agent::system_probe クラスを使用して、コンフィギュレーションファイルを適切に作成します。

class { 'datadog_agent::system_probe':
    service_monitoring_enabled => true, 
}

トラブルシューティング

Puppet Agent を手動で実行して、出力のエラーを確認できます。

```shell
sudo systemctl restart puppetserver
sudo puppet agent --onetime --no-daemonize --no-splay --verbose
```

 Example response:

```text
info: Retrieving plugin
info: Caching catalog for alq-linux.dev.datadoghq.com
info: Applying configuration version '1333470114'
notice: Finished catalog run in 0.81 seconds
```

次のエラーが表示される場合は、[main] ではなく [master] で reports=datadog_reports が定義されていることを確認してください。

```text
err: Could not send report:
Error 400 on SERVER: Could not autoload datadog_reports:
Class Datadog_reports is already defined in Puppet::Reports
```

レポートを受信しない場合は、Puppet サーバーログを確認してください。

マスターレス Puppet

1. Datadog モジュールとその依存関係は、マスターレスで実行しているすべてのノードにインストールする必要があります。

2. これを各ノードの site.pp ファイルに追加します。

   class { "datadog_agent":
       api_key            => "<YOUR_DD_API_KEY>",
       puppet_run_reports => true
   }
   

3. マスターレス構成で Puppet を実行します。

   puppet apply --modulepath <path_to_modules> <path_to_site.pp>
   

クライアントノードのタグ付け

Datadog Agent 構成ファイルは、Puppet を実行するたびにテンプレートから再作成されます。ノードにタグを付ける必要がある場合は、Hiera に配列エントリを追加します。

datadog_agent::tags:
- 'keyname:value'
- 'anotherkey:%{factname}'

カスタムファクトからタグを生成するには、Puppet Enterprise コンソールまたは Hiera を介して、ノードを Puppet ファクトで配列として facts_to_tags パラメーターに分類します。次に例を示します。

class { "datadog_agent":
  api_key            => "<YOUR_DD_API_KEY>",
  facts_to_tags      => ["osfamily","networking.domain","my_custom_fact"],
}

ヒント:

1. 構造化ファクトの場合、特定のファクト値にインデックスを付けます。こうしないと配列全体が文字列として渡され、最終的に使用するのが難しくなります。
2. CPU 使用率やアップタイムなど、実行ごとに変化が予想される動的ファクトは、タグ付けには理想的ではありません。ノードの存続期間中存続すると予想される静的ファクトが、タグ付けの最適な候補です。

構成変数

これらの変数は、datadog_agent クラスで設定して、Agent の設定を制御できます。サポートされている引数の完全なリストについては、コード内のコメントを参照してください。

(1) agent_extra_options は、追加の Agent v6/v7 構成オプションを細かく制御するために使用されます。datadog_agent クラスパラメーターで提供されるオプションをオーバーライドする可能性のあるディープマージが実行されます。例:

class { "datadog_agent":
    < your other arguments to the class >,
    agent_extra_options => {
        use_http => true,
        use_compression => true,
        compression_level => 6,
    },
}

(2) hostname_extraction_regex は、Puppet モジュールと Datadog Agent がインフラストラクチャーリスト内の同じホストに対して異なるホスト名をレポートしている場合に役立ちます。