- 重要な情報
- はじめに
- 用語集
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
このページでは、Datadog マーケットプレイスで製品開発を行う方法について説明します。ご質問がある場合は、marketplace@datadoghq.com までご連絡ください。
マーケットプレイスタイルを開発するには、以下の手順で行います。
マーケットプレイスの標準的なインテグレーションタイルが以下のフォーマットで表示されます。
Datadog マーケットプレイスに掲載するインテグレーションタイルを作成するために、以下の製品タイプから選択します。
Agent ベースのインテグレーションは、Datadog Agent を使用してデータを収集し、Agent チェックを中心に構築されます。チェックの種類は 3 つあります。
Agent インテグレーションは、Datadog からデータを取得し、Datadog にデータをプッシュする双方向のものです。これは、Datadog マーケットプレイス上の情報タイルのみのリスト (スタンドアロン SaaS ライセンスやプロフェッショナルサービス製品など) とは異なるもので、双方向性ではありません。
インテグレーションは、以下の種類のデータを Datadog に送信します。
Datadog Agent ベースのインテグレーションの詳細については、以下を参照してください。
API インテグレーションを使用して、バックエンドからデータをリッチ化して送信したり、Datadog から直接データを取り出したりすることができます。API インテグレーションは、Datadog と他の SaaS プラットフォーム間のコネクターを構築する際に効果的です。この方法は、SaaS ベースで、作成者が認可のためにログインするための既存の Web サイトを持っている技術パートナーに最適です。
API インテグレーションは、Datadog Agent を使用してデータを収集しないため、開発作業が完了したら、情報タイルのみのリストを作成する必要があります。
REST API インテグレーションは、双方向でなければなりません。つまり、インテグレーションは、Datadog からデータを引き出し、Datadog にデータをプッシュすることができなければなりません。
REST API インテグレーションは、以下の種類のデータを Datadog に送信します。
Datadog API エンドポイントにデータを送信するには Datadog API キーが必要で、Datadog からデータをクエリするにはアプリケーションキーが必要です。Datadog では、これらの資格情報をユーザーに直接要求する代わりに、OAuth を使用して API ベースのインテグレーションの認可とアクセスを処理することを推奨しています。
Vantage のような integrations-extras リポジトリで、既存の API インテグレーションの例を調べることができます。
Datadog アプリは、Datadog Developer Platform で開発されたカスタムダッシュボードウィジェットです。Datadog アプリを公開できるようになったら、インテグレーションまたはマーケットプレイスページに情報タイルのみのリストを作成する必要があります。
SaaS ライセンスまたはプロフェッショナルサービス製品をマーケットプレイスに掲載するには、情報タイルのみの掲載を作成する必要があります。
製品が決まったら、ディレクトリを設定します。
マーケットプレイスのドキュメントの指示に従って、マーケットプレイスのリポジトリへのアクセスをリクエストします。
dd ディレクトリを作成します。
mkdir $HOME/ddDatadog Development Toolkit コマンドは、$HOME/dd/ ディレクトリで作業していることを想定しています。これは必須ではありませんが、異なるディレクトリで作業する場合は、追加の構成手順が必要です。
マーケットプレイスのリポジトリへのアクセスが許可されたら、dd ディレクトリを作成し、marketplace リポジトリを複製します。
git clone git@github.com:DataDog/marketplace.git作業するフィーチャーブランチを作成します。
Datadog Development Toolkit コマンド (ddev) を使用すると、インテグレーションを開発する際に、インテグレーションタイルのアセットとメタデータのスケルトンを生成してスキャフォールディングを作成することができます。
始める前に、以下の前提条件を満たしていることを確認してください。
venv を使用します。Development Toolkit をインストールして構成します。
marketplace ディレクトリの中にいることを確認します。
cd $HOME/dd/marketplacePython の仮想環境を構築します。
python3 -m venv venv
. venv/bin/activate仮想環境は deactivate を実行することでいつでも終了させることができます。
Developer Toolkit をインストールします。
pip3 install "datadog-checks-dev[cli]"Z Shell を使用している場合は、pip3 install datadog-checks-dev\[cli\] を実行して、エスケープされた文字を使用する必要があるかもしれません。
デフォルトの作業用リポジトリとして marketplace を設定します。
ddev config set marketplace $HOME/dd/marketplace
ddev config set repo marketplaceマーケットプレイスディレクトリの複製に $HOME/dd 以外のディレクトリを使用した場合は、以下のコマンドを使用して作業リポジトリを設定します。
ddev config set marketplace <PATH/TO/MARKETPLACE>
ddev config set repo marketplaceddev コマンドを実行すると、インテグレーションに必要なフォルダとファイルのスケルトンが生成されます。このコマンドで使用するオプションは、開発しているインテグレーションの種類によって異なります。ddev コマンドで作成されるファイルの一覧は、インテグレーションアセットを参照してください。
Datadog アプリ、Datadog REST API インテグレーション、プロフェッショナルサービス、スタンドアロン SaaS ライセンスについては、Datadog Development Toolkit を使用して、情報タイルのみの掲載のスキャフォールディングを作成することができます。
情報タイルのみの掲載のスキャフォールディングを作成するには
marketplace ディレクトリの中にいることを確認します。cd $HOME/dd/marketplace-t tile オプションを付けて ddev コマンドを実行しますddev create -t tile "<Offering Name>"Agent ベースのインテグレーションのためのスキャフォールディングを生成するには
marketplace ディレクトリの中にいることを確認します。cd $HOME/dd/marketplace-t tile オプションを付けて ddev コマンドを実行しますddev create "<Offering Name>"インテグレーションに必要な以下のアセットが揃っていることを確認してください。
| Asset Name | Asset Description |
|---|---|
| README | Includes an Overview, Setup, Data Collected (optional), and Support section using H2 headings (##) in Markdown. For more information, see README. |
| Media | Add any images and a video that you want to use for the integration tile’s media carousel in an images folder. You can add one video to each listing.Technology Partners can use .png files instead of .jpg files to reduce image compression. |
| Media Carousel | Define the images you want to add to the integration tile’s media carousel in the media object specified in the tile front matter on the manifest.json file.For more information, see Media Carousel. |
| Manifest.json | Specify a JSON object that includes elements such as manifest_version,display_on_public_website, tile, author, oauth, pricing, assets, and more.For more information, see Manifest file. |
| Metadata.csv | Contains a list of out-of-the-box metrics included in the integration defined in the following format ending with a comma: metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric.For more information, see Metrics metadata file. |
| Dashboards and Monitors | Provide the JSON files for out-of-the-box dashboards and monitors included in the integration in the dashboards and monitors folders nested in the assets directory.For both dashboards and monitors, a title and description is required. Technology Partners can create dashboards and monitors in a provisioned sandbox account, and export these assets into JSON files. For more information about dashboards, see Best Practices for Integration Preset Dashboards. |
| Logos | Add at least one SVG file which can be used in light and dark modes in a logos folder nested in the assets directory, or add the file(s) directly to the assets directory.Technology Partners are responsible for the licensing of submitted logos. |
| Changelog | Document release notes and version information in the Changelog.md file using the following format: 1.0.0 / YYYY-MM-DD. This information is displayed in the Release Notes tab of the integration tile.Technology Partners can add releases and version updates in descending order (latest version at the top). |
| CODEOWNERS | The CODEOWNERS file belongs in the shared .github directory and defines the individuals or teams responsible for maintaining the content and source code in the Marketplace repository.For more information about syntax, see the GitHub code owners documentation. |
| End User License Agreement (EULA) | Add the eula.pdf file in the assets directory.Technology Partners are responsible for adding the EULA. |
README.md ファイルを作成したら、以下のセクションを H2s (##) として追加し、マーケットプレイスのタイルに表示される内容を記入します。
| ヘッダー名 | ヘッダー |
|---|---|
| 概要 | Datadog マーケットプレイスでインテグレーションを購入しインストールすることで、ユーザーに提供する価値やメリット (例えば、すぐに使えるダッシュボード、ユーザーセッションのリプレイ、ログ、アラートなど) を ## Overview ヘッダーの下に説明文を記述してください。この情報は、インテグレーションタイルの Overview タブに表示されます。 |
| セットアップ | H3 の見出し (###) に分けられた情報を含む、マーケットプレイスインテグレーションを設定するためのすべてのステップを含みます。標準的なトピックは以下の通りです。- アプリ内インテグレーションタイルを使用してインテグレーションをインストールする。 - Datadog の組織で適切なロールと権限でインテグレーションを構成する。 - インテグレーションを購入しインストールしたユーザーがアクセスできる、すぐに使える Datadog の機能 (メトリクス、イベント、モニター、ログ、ダッシュボードなど) にアクセスする。 |
| アンインストール | マーケットプレイスインテグレーションをアンインストールするためのすべてのステップを含めます。この情報は、インテグレーションタイルの Configure タブに表示されます。 |
| 収集データ | すぐに使えるメトリクス、イベント、またはサービスチェックに関する情報を含む、マーケットプレイスインテグレーションによって収集されるデータの種類を指定します。 ログ、モニター、ダッシュボードなど、その他の収集データの種類を含めることができます。マーケットプレイスインテグレーションがこれらのいずれかを提供しない場合、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 Marketplace Integration OOTB Dashboard",
"image_url": "images/integration_name_image_name.png"
},
{
"media_type": "video",
"caption": "A Datadog Marketplace Integration Overview Video",
"image_url": "images/integration_name_video_thumbnail.png",
"vimeo_id": 123456789
},
],詳しくは、インテグレーションアセットリファレンスをご覧ください。
機能ブランチをプッシュアップし、インテグレーションタイルのアセットファイル (イメージを含む) を含むプルリクエストを marketplace リポジトリに開きます。Marketplace リポジトリはフォークを許可していません。リポジトリの複製を作成する手順については、[セットアップセクション](#set-up-a-directory and clone-the-marketplace-repository)を参照してください。プルリクエストを作成すると、Azure DevOps パイプラインで自動チェックが実行され、プルリクエストが正常であること、更新に必要なコンテンツがすべて含まれていることが確認されます。
Azure DevOps パイプラインへのアクセスをリクエストするには、プルリクエストにコメントを残して、アクセスをリクエストします。
プルリクエストが全てのチェックを通過すると、Datadog/agent-integrations、Datadog/marketplace-review、Datadog/documentation チームのレビュアーが、ベストプラクティスに関する提案やフィードバックを提供します。
フィードバックに対応し、レビューを再要求すると、これらのレビュアーがあなたのプルリクエストを承認します。サンドボックスアカウントでインテグレーションタイルをプレビューしたい場合は、マーケットプレイスチームに連絡してください。これにより、プルリクエストがマージされる前に、Datadog マーケットプレイスでインテグレーションタイルの追加変更を検証し、プレビューすることができます。
マーケットプレイスのタイルが稼動すると、テクノロジーパートナーは Datadog のパートナーマーケティングチームとミーティングを行い、以下のような共同の市場開拓 (GTM) 戦略を調整することができます。
