Agent の概要

Docs > はじめに > Agent の概要

このガイドでは、Agent の紹介と、Agent を使用して Datadog プラットフォームにシステムレベルのメトリクスを送信する方法について説明します。また、Ubuntu 上での Agent のインストール例についても説明します。以下の内容をカバーしています。

Agent のインストール
Agent が起動していることを確認する
Agent の機能を構成する
トラブルシューティングリソース

概要

Agent について

Datadog Agent は、ホスト上で実行されるソフトウェアです。ホストからイベントやメトリクスを収集し、Datadog に送信し、モニタリングやパフォーマンスデータを分析することができます。ローカルホスト (Windows、MacOS)、コンテナ環境 (Docker、Kubernetes)、オンプレミスデータセンターで実行することが可能です。構成管理ツール (Chef、Puppet、Ansible) を使って、インストールと構成が可能です。

Agent は、15～20 秒ごとに 75～100 のシステムレベルメトリクスを収集することができます。また、追加の構成により、Agent は実行中のプロセスからライブプロセスデータ、ログ、トレースを Datadog プラットフォームに送信することができます。Datadog Agent はオープンソースで、ソースコードは GitHub の DataDog/datadog-agent で公開されています。

Agent のオーバーヘッド

Agent が占有するスペースとリソースの量は、構成と Agent が送信するように構成されているデータによって異なります。初期状態では、平均して約 0.08% の CPU 使用率と、約 880MB から 1.3GB のディスクスペースが見込まれます。

これらのベンチマークについて詳しくは、Agent Overhead を参照してください。

データ収集

Agent メトリクス

以下の Agent メトリクスは、Agent が Datadog に送信する自分自身に関する情報であり、どのホストやコンテナで Agent が動作しているか、Agent がいつ起動するか、どのバージョンの Python が動作しているかなどを判断することができます。

メトリクス	説明
`datadog.agent.python.version`	Agent が Datadog に報告中の場合は、値 `1` が表示されます。メトリクスには `python_version` がタグ付けされています。
`datadog.agent.running`	Agent が Datadog に報告中の場合は、値 `1` が表示されます。
`datadog.agent.started`	Agent 起動時に値 `1` で送信されるカウント (v6.12 以上で使用可能)。

Agent メトリクスの全リストは、Agent メトリクスのインテグレーションをご覧ください。

チェック

一部のプラットフォームの Agent では、メトリクスを収集するいくつかのコアチェックがデフォルトで有効になっています。

チェック	メトリクス	プラットフォーム
CPU	System	All
ディスク	Disk	All
IO	System	All
メモリ	System	All
ネットワーク	Network	All
NTP	NTP	All
アップタイム	System	All
ファイル処理	System	Mac 以外のすべて
ロード	System	Windows 以外のすべて
Docker	Docker	Docker
Winproc	System	Windows

他のテクノロジーからメトリクスを収集する方法については、インテグレーションのページを参照してください。

ホスト用 Agent とコンテナ用 Agent の相違点

このガイドでは、ホストへの Agent のインストールと構成を説明します。最終的にコンテナ環境に Agent をインストールする予定がある場合、いくつか知っておくべき相違点があります。

ホストでは、Agent は YAML ファイルを使用して構成されます (このガイドの後半で説明します)。一方、コンテナの Agent の構成オプションは、環境変数で渡されます。たとえば、以下のようになります。
- DD_API_KEY は Datadog API キー用
- DD_SITE は Datadog サイト用
同様に、ホスト上では、インテグレーションは Agent 構成ファイルを通して特定されますが、コンテナ環境では、Datadog のオートディスカバリー機能によりインテグレーションが自動的に特定されます。詳しくは、基本的な Agent のオートディスカバリーを参照してください。

コンテナ環境で Agent を実行するためのチュートリアルは、Docker Agent または Kubernetes を参照してください。

なぜ Agent をインストールする必要があるのですか？

Agent ベースのインテグレーションからデータを送信するには、Agent をインストールする必要があります。Agent は必ずしも Datadog プラットフォームにデータを転送することを求められておらず、例えば、ログやメトリクスの送信は Datadog API を通じて行うことができます。しかし、Agent は Datadog プラットフォームにデータを転送する方法として推奨されています。

Agent は 15 秒ごとにホストデータを収集し、環境全体で何が起こっているかを正確に把握することができます。チェックのセクションで述べたように、Agent は 50 以上のデフォルトメトリクスを収集するいくつかのチェックを有効にし、システムレベルのデータについてより深い洞察を提供します。

セットアップ

前提条件

Datadog アカウントを作成します。
Datadog API キーを手元に用意します。
Datadog の UI を開いておきます。

注: このチュートリアルでは、Ubuntu オペレーティングシステムを使用しています。サポートされているプラットフォームの全リストは、基本的な Agent の利用方法ページを参照してください。

インストール

Datadog UI で Agent Installation ページに移動し、Ubuntu をクリックします。ホストに Datadog Agent をインストールするには、そのページから 1 行のインストールコマンド (下図の例) を使用し、Datadog API キーで更新します。

Ubuntu の 1 行インストールコマンドの例:

DD_API_KEY=<DATADOG_API_KEY> DD_SITE="" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"

Agent Installation ページを使用して、お使いのオペレーティングシステムの最新のインストール手順を参照してください。

検証

ターミナルコマンド

インストールを検証するには、Agent のステータスコマンドを実行します。

sudo datadog-agent status

インストールに成功すると、次のような Agent 情報で始まる Agent Status レポートが返されます。

===============
Agent (v7.36.1)
===============

  Status date: 2022-06-15 15:54:48.364 EDT / 2022-06-15 19:54:48.364 UTC (1655322888364)
  Agent start: 2022-06-15 15:54:29.85 EDT / 2022-06-15 19:54:29.85 UTC (1655322869850)
  Pid: 9801
  Go Version: go1.17.6
  Python Version: 3.8.11
  Build arch: amd64
  Agent flavor: agent
  Check Runners: 6
  Log Level: info

イベント

Datadog UI で Events Explorer ページに移動します。Agent が起動または再起動されると、Agent は Datadog にイベントを送信します。Agent が正常にインストールされると、以下のメッセージが表示されます。

Datadog agent (v. 7.XX.X) started on <Hostname>

サービスチェック

Agent は、以下のサービスチェックを行うように設定されています。

datadog.agent.up: Returns OK if the Agent connects to Datadog.
AIX Agents do not report the datadog.agent.up service check. You can use the metric datadog.agent.running to monitor the uptime of an AIX Agent. The metric emits a value of 1 if the Agent is reporting to Datadog.
datadog.agent.check_status: Returns CRITICAL if an Agent check is unable to send metrics to Datadog, otherwise returns OK.

These checks can be used in the Datadog Platform to visualize the Agent status through monitors and dashboards at a quick glance. See Service Check Overview to learn more.

Metrics

In the Datadog UI, go to the Metrics Summary page and search for the metric datadog.agent.started or the metric datadog.agent.running. If these metrics are not visible right away, it may take a few minutes for the Agent to send the data to the Datadog Platform.

Click on either of the metrics and a Metric panel opens up. This panel shows additional metadata about where these metrics are collected from and any associated tags. Because so far in this walkthrough no tags are configured on this host, you should see only the default tags that Datadog assigns to the metrics including version and host. See the following section on Agent Configuration Files to learn more about how to add tags.

Explore other default metrics such as ntp.offset or system.cpu.idle.

Agent configuration files

The Agent’s main configuration file is datadog.yaml. The required parameters are:

your Datadog API key, which is used to associate your Agent’s data with your organization, and
the Datadog site ().

See the sample config_template.yaml file for all available configuration options.

You can adjust the Agent configuration files to take advantage of other Datadog features including tags.

Setting tags through the Agent configuration file

Tags add an additional layer of metadata to your metrics and events. They allow you to scope and compare your data in Datadog visualizations. When data is sent to Datadog from multiple hosts, tagging this information allows you to scope down to the data you are most interested in visualizing.

For example, let’s say you have data that is collected from different teams and you are only interested in seeing the metrics from team alpha, tagging those specific hosts with either the team:alpha or team:bravo tag gives you the ability to filter down to the metrics that are tagged with team:alpha. See Getting Started with Tags to learn more about tagging your data.

Locate your Agent’s main configuration file. For Ubuntu, the file locations is /etc/datadog-agent/datadog.yaml.

In the datadog.yaml file, locate the tags parameter. Host level tags can be set in the datadog.yaml configuration to apply tags on all metrics, traces and logs forwarded from this host.

## @param tags  - list of key:value elements - optional
## @env DD_TAGS - space separated list of strings - optional
## List of host tags. Attached in-app to every metric, event, log, trace, and service check emitted by this Agent.
##
## This configuration value merges with `DD_EXTRA_TAGS`, allowing some
## tags to be set in a configuration file (`tags`), and additional tags to be added
## with an environment variable (`DD_EXTRA_TAGS`).
##
## Learn more about tagging: https://docs.datadoghq.com/tagging/
#
# tags:
#   - team:infra
#   - <TAG_KEY>:<TAG_VALUE>

Uncomment the tags parameter and the provided example team:infra tag. You can also add your own custom tag, for example test:agent_walkthrough.

## @param tags  - list of key:value elements - optional
## @env DD_TAGS - space separated list of strings - optional
## List of host tags. Attached in-app to every metric, event, log, trace, and service check emitted by this Agent.
##
## This configuration value merges with `DD_EXTRA_TAGS`, allowing some
## tags to be set in a configuration file (`tags`), and additional tags to be added
## with an environment variable (`DD_EXTRA_TAGS`).
##
## Learn more about tagging: https://docs.datadoghq.com/tagging/
#
tags:
   - team:infra
   - test:agent_walkthrough

Restart the Agent by running the Agent’s restart command. The Ubuntu restart command:
```
sudo service datadog-agent restart
```
After a few minutes, go to the Metrics Summary page again, and click on the metric datadog.agent.started. In addition to the default host and version tags, you can also see the team tag and any personal tags you added. You can also filter metrics by the Tag field at the top of the page.
Go to the Events Explorer page and find the custom tags displayed with the latest Agent Event.

Other configuration options

The collection of logs, traces, and processes data can be enabled through the Agent configuration file. These are not features that are enabled by default. For example, in the configuration file, the logs_enabled parameter is set to false.

##################################
## Log collection Configuration ##
##################################

## @param logs_enabled - boolean - optional - default: false
## @env DD_LOGS_ENABLED - boolean - optional - default: false
## Enable Datadog Agent log collection by setting logs_enabled to true.
#
# logs_enabled: false

Other Datadog features that can be configured through the Agent configuration file include:

Enabling OTLP Trace Ingestion
Customizing log collection to filter or scrub sensitive data
Configuring custom data through DogStatsD

Throughout your setup, when the documentation refers to the datadog.yaml file or the Agent configuration file, this is the file you need to configure.