- 重要な情報
- アプリ内
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
Datadog API エンドポイントを使用して、バックエンドからデータをリッチ化して送信したり、Datadog から直接データを取り出したりすることができます。API インテグレーションは、Datadog と他の SaaS プラットフォーム間のコネクターを構築する際に効果的です。この方法は、SaaS ベースで、作成者が認可のためにログインするための既存の Web サイトを持っている技術パートナーに最適です。
API インテグレーションは、以下の種類のデータを Datadog に送信します。
このページでは、integrations-extras
リポジトリで API インテグレーションを作成するための手順を説明します。API ベースのインテグレーションを作成する理由については、独自のソリューションを作成するを参照してください。API インテグレーションは、Datadog Agent を使用してデータを収集しないため、開発作業が完了したら、情報用のタイルのみのリストを作成する必要があります。
API キーは、Datadog の API エンドポイントにデータを送信するために必要です。アプリケーションキーは、Datadog からデータをクエリしたり、Datadog サイト内でリソースを作成するために必要です。詳しくは、API とアプリケーションキーを参照してください。
API キー、アプリケーションキー、サイト URL を使用して、自社のプラットフォームで Datadog への接続を作成します。
Datadog では、これらの資格情報をユーザーに直接リクエストする代わりに、OAuth クライアントを使用して、API ベースの統合のための認可とアクセスを処理することを推奨しています。詳細については、インテグレーションのための OAuth と認可エンドポイントを参照してください。
Vantage のような integrations-extras
リポジトリで、既存の API インテグレーションの例を調べることができます。
integrations-extras
リポジトリをフォークします。dd
ディレクトリを作成します。
mkdir $HOME/dd
Datadog Development Toolkit は、$HOME/dd/
ディレクトリで作業していることを想定しています。これは必須ではありませんが、異なるディレクトリで作業する場合は、追加の構成手順が必要です。
integrations-extras
リポジトリを複製します。
git clone git@github.com:DataDog/integrations-extras.git
Datadog Development Toolkit (ddev
) を使用すると、インテグレーションに必要なディレクトリ構造、アセット、メタデータを生成することができます。
始める前に、以下の前提条件を満たしていることを確認してください。
venv
を使用します。Development Toolkit をインストールして構成します。
integrations-extras
ディレクトリの中にいることを確認します。
cd $HOME/dd/integrations-extras
Python の仮想環境を構築します。
python3 -m venv venv
. venv/bin/activate
仮想環境は deactivate
を実行することでいつでも終了させることができます。
Developer Toolkit をインストールします。
pip3 install "datadog-checks-dev[cli]"
Z Shell を使用している場合は、pip3 install datadog-checks-dev\[cli\]
を実行して、エスケープされた文字を使用する必要があるかもしれません。
デフォルトの作業用リポジトリとして integrations-extras
を設定します。
ddev config set integrations-extras $HOME/dd/integrations-extras
ddev config set repo integrations-extras
integrations-extras
ディレクトリの複製に $HOME/dd
以外のディレクトリを使用した場合は、以下のコマンドを使用して作業リポジトリを設定します。
ddev config set integrations-extras <PATH/TO/INTEGRATIONS-EXTRAS>
ddev config set repo integrations-extras
dev
コマンドを実行して、情報タイルのみの出品のためのスキャフォールディングを作成します。
integrations-extras
ディレクトリの中にいることを確認します。cd $HOME/dd/integrations-extras
-t tile
オプションを付けて ddev
コマンドを実行しますddev create -t tile "<Offering Name>"
ddev
コマンドで使用するオプションは、開発しているインテグレーションの種類によって異なります。ddev
コマンドで作成されるファイルの一覧は、インテグレーションアセットを参照してください。
インテグレーションに必要な以下のアセットが揃っていることを確認してください。
README.md
ファイルを作成したら、以下のセクションを H2s (##
) として追加し、インテグレーションのタイルに表示される内容を記入します。
ヘッダー名 | ヘッダー |
---|---|
概要 | API インテグレーションを購入しインストールすることで、ユーザーに提供する価値やメリット (例えば、すぐに使えるダッシュボード、ログ、アラートなど) を ## Overview ヘッダーの下に説明文を記述してください。この情報は、インテグレーションタイルの Overview タブに表示されます。 |
セットアップ | H3 の見出し (### ) に分けられた情報を含む、API インテグレーションを設定するためのすべてのステップを含みます。標準的なトピックは以下の通りです。- アプリ内インテグレーションタイルを使用してインテグレーションをインストールする。 - Datadog の組織で適切なロールと権限でインテグレーションを構成する。 |
アンインストール | API インテグレーションをアンインストールするためのすべてのステップを含めます。この情報は、インテグレーションタイルの Configure タブに表示されます。 |
収集データ | すぐに使えるメトリクス、イベント、またはサービスチェックに関する情報を含む、API インテグレーションによって収集されるデータの種類を指定します。 ログ、モニター、ダッシュボードなど、その他の収集データの種類を含めることができます。API インテグレーションがこれらのいずれかを提供しない場合、Data Collected セクションを追加する必要はありません。 |
サポート | サポートチームへのメール、自社への電話番号、自社のドキュメントやブログ記事へのリンク、その他のヘルプ情報などを含む連絡先情報を箇条書きで掲載します。 |
インテグレーションタイルには、画像とビデオのメディアカルーセルが含まれます。
テクノロジーパートナーは、インテグレーションタイルにビデオを追加することができます。プルリクエストでビデオをアップロードしないでください。代わりに、ビデオのコピーまたはダウンロードリンクを marketplace@datadoghq.com に送信してください。マーケットプレイスチームは vimeo_link
を返信します。このリンクを manifest.json
ファイルに追加すると、メディアカルーセルの中にビデオを含めることができます。
ビデオは以下の要件を満たしている必要があります。
ビデオ要件 | 説明 |
---|---|
タイプ | MP4 H.264 |
サイズ | ビデオサイズは最大 1GB です。 |
ディメンション | アスペクト比は正確に 16:9、解像度は 1920x1080 以上でなければなりません。 |
名前 | ビデオファイル名は、partnerName-appName.mp4 でなければなりません。 |
ビデオの長さ | ビデオの長さは最大 60 秒です。 |
説明 | 最大許容文字数は 300 文字です。 |
テクノロジーパートナーは、インテグレーションタイルのメディアカルーセルに最大 8 枚 (ビデオを含む場合は 7 枚) の画像を追加することができます。
イメージは以下の要件を満たしている必要があります。
イメージ要件 | 説明 |
---|---|
タイプ | .jpg または .png 。 |
サイズ | 平均は 500KB 程度です。最大イメージサイズは 1MB です。 |
ディメンション | アスペクト比は正確に 16:9 で、以下の仕様に適合している必要があります。 - 幅: 1440px - 最低高さ: 810px - 最大高さ: 2560px |
名前 | 英字、数字、アンダースコア、ハイフンを使用してください。スペースは使用しないでください。 |
カラーモード | RGB |
カラープロファイル | sRGB |
説明 | 最大許容文字数は 300 文字です。 |
このテンプレートに従って、イメージ、ビデオサムネイル、ビデオを含むメディアカルーセルの media
オブジェクトを定義してください。
manifest.json
"media": [
{
"media_type": "image",
"caption": "A Datadog API Integration OOTB Dashboard",
"image_url": "images/integration_name_image_name.png"
},
{
"media_type": "video",
"caption": "A Datadog API Integration Overview Video",
"image_url": "images/integration_name_video_thumbnail.png",
"vimeo_id": 123456789
},
],
詳しくは、インテグレーションアセットリファレンスをご覧ください。
integrations-extras
リポジトリで、画像 (ロゴやイメージなど) とアセットファイル (Changelog.md
、README.md
、manifest.json
など) を追加し、インテグレーションページで API インテグレーションのタイルのみの出品に追加するプルリクエストを開きます。自動テストは、プルリクエストが適切な状態にあり、更新に必要なすべてのコンテンツが含まれていることを確認するためにチェックを実行します。
プルリクエストが全てのチェックを通過すると、Datadog/agent-integrations
、Datadog/marketplace
、Datadog/documentation
チームのレビュアーが、ベストプラクティスに関する提案やフィードバックを提供します。
フィードバックに対応し、レビューを再要求すると、これらのレビュアーがプルリクエストを承認します。
お役に立つドキュメント、リンクや記事:
お役に立つドキュメント、リンクや記事: