Build an Integration with Datadog

Docs > 開発者 > Datadog インテグレーション > Build an Integration with Datadog

概要

このページは、Technology Partner に対して、Datadog へインテグレーションまたは Marketplace オファリングを作成して提出するための具体的な手順を案内します。

はじめに

リスティングを作成する

Integrations > Developer Platform > Publishing に移動し、New Listing をクリックします。
オファリングの種類を選択します。
オファリングの名前を追加します。
Create をクリックします。

Overview を記入する

Overview セクションで、ベンダー名、ベンダー URL、短い説明などの関連詳細を入力し、適切なタグを適用します。
ロゴのワードマーク版を SVG 形式でアップロードします。
インテグレーションの識別子として使用される一意の integration ID を設定します。

インテグレーションコードを設計して作成する

Agent ベースのインテグレーションまたは API ベースのインテグレーションを作成するための手順に従います。

Agent ベースのインテグレーション を作成する場合は、記載の手順に従ってください。

Agent ベースのインテグレーションは、開発者が作成したチェックを通じてデータを送信するために Datadog Agent を使用します。

チェックは、メトリクス、イベント、サービスチェックを顧客の Datadog アカウントに送信できます。Agent 自体もログを送信できますが、それはチェックの外側で設定します。コードは GitHub でホストされます。

これらのインテグレーションの実装コードは Datadog によってホストされます。Agent インテグレーションは、ローカルエリアネットワーク (LAN) または仮想プライベートクラウド (VPC) 内にあるシステムやアプリケーションからデータを収集するのに最適です。Agent インテグレーションを作成するには、ソリューションを Python wheel (.whl) として公開およびデプロイする必要があります。

Agent Check の設定方法については Agent Check ドキュメントを参照し、残りの手順を進めるためにこのページに戻ってください。

API ベースのインテグレーション を作成する場合は、OAuth の使用が必須です。記載の手順に従ってください。

OAuth は、クライアントアプリケーションに安全な委任アクセスを提供するためにインテグレーションが使用できる標準です。OAuth は HTTPS 上で動作し、認証情報ではなくアクセストークンを用いてデバイス、API、サーバー、アプリケーションを認可します。

OAuth クライアントドキュメントを参照して OAuth Integration を設定し、残りの手順を進めるためにこのページに戻ってください。

プラットフォームが OAuth と互換性がない場合は、例外承認について Datadog Ecosystems チームに連絡してください。

セットアップおよびアンインストール手順を提供する

Setup instructions は、インストールプロセスをユーザーが進められるように案内します。必要な構成、認証ステップ、初期セットアップ作業を番号付きリストで記載してください。
Uninstallation instructions は、インテグレーションを正しくアンインストールする方法を案内します。

インテグレーションがやり取りするデータを定義する

Datadog のデータ型に関する情報は、ユーザーがインテグレーションの動作を理解するのに役立ちます。Datadog からデータを取得する場合は、Queried data セクションで対象のデータ型を指定してください。Datadog にデータを送信する場合は、Submitted data セクションで対象のデータ型を指定してください。項目によっては、より詳しい情報が必要な場合があります。

インテグレーションがメトリクスを送信する場合:

metric check を設定します。これは、インテグレーションが稼働していることをユーザーに知らせるために、各実行で送信されるメトリクスです。
metadata.csv ファイルに記入して、メトリクスの一覧をアップロードします。

インテグレーションがログを送信する場合は、ログパイプラインが必須です。

手順に従ってログパイプラインを作成します。
直前の手順でエクスポートした 2 つのファイルをアップロードします。

インテグレーション固有のコンテンツを作成する

Datadog Integrations は、インストール直後に使用できる標準コンテンツをサポートします。ダッシュボード、モニターテンプレート、SIEM 検知ルールなどのコンテンツを含め、ユーザーがインテグレーションから価値を得られるようにしてください。

インテグレーションに同梱するダッシュボードを少なくとも 1 つ作成して添付します。
- ダッシュボードはすべてのインテグレーションで必須です。新しいダッシュボードを作成する際は、Datadog のベストプラクティスに従ってください。
その他のコンテンツも作成して添付します。
- 新しいモニターテンプレートを作成するには、Datadog のベストプラクティスに従ってください。
- SIEM 検知ルールを作成するには、Datadog のベストプラクティスに従ってください。