Dogshell

コマンドライン ラッパーである Dogshell を使用すると、Datadog API をコマンドラインから操作できます。

Dogshell をインストールする

Dogshell は公式にサポートされている datadogpy Python ライブラリ に同梱されています。このライブラリは DogStatsD を使用して Datadog にデータを送信する際によく利用されます。pip でライブラリをインストールするには、次のコマンドを実行してください:

pip install datadog

環境によっては、ライブラリを PATH に追加する必要があります。その他のインストール手順は datadogpy の GitHub リポジトリ を参照してください。

Dogshell の設定

Dogshell は .dogrc という構成ファイルに API キー、アプリケーション キー、Datadog サイトを保存します。

Dogshell を設定する手順:

  1. ホーム ディレクトリに .dogrc ファイルを作成します:

    touch ~/.dogrc

  2. ファイルに以下の内容を追加し、MY_API_KEYMY_APP_KEY をそれぞれのキーに置き換えてください:

    [Connection]
    apikey = MY_API_KEY
    appkey = MY_APP_KEY
    api_host = 
    
    複数の環境でコマンドを実行する必要がある場合は、複数の構成ファイルを作成できます。--config フラグで別の構成ファイルへのパスを指定してください。
  3. テスト用メトリクスをポストして dogshell コマンドを確認します:

    dog metric post test_metric 1

Dogshell コマンド

利用可能な Dogshell コマンドの一覧は -h フラグで確認できます:

dog -h

次のコマンドに -h オプションを付けると、各 Dogshell コマンドの詳細な使用方法を確認できます:

  • dog metric
  • dog event
  • dog service_check
  • dog monitor
  • dog downtime
  • dog timeboard
  • dog screenboard
  • dog dashboard
  • dog host
  • dog tag
  • dog search
  • dog comment

詳細は Dogshell のコード を参照してください。

Dogshell の例

次の構文で Datadog アカウントにメトリクスを送信できます:

dog metric post MY_METRIC_NAME METRIC_VALUE --tags "TAG_KEY_1:TAG_VALUE_1,TAG_KEY_2:TAG_VALUE_2"

例として、次のコマンドは test_dogshell_metric というメトリクスを値 1.0、タグ test:oneexample:one と共に送信します:

dog metric post test_dogshell_metric 1.0 --tags "test:one,example:one"

コマンド実行後、Metrics Explorertest_dogshell_metric を検索してください。

Metrics Explorer で test_dogshell_metric を確認している様子