インテグレーションアセットリファレンス

概要

このページでは、Integrations ページまたは Marketplace ページで製品を開発する方法について説明します。

構成ファイル

新しいインテグレーションを用意する際は、必要なオプションと適正なデフォルトを設定したコンフィギュレーションサンプルを追加する必要があります。この例のサンプルコンフィギュレーションファイルは <チェック名>/datadog_checks/<チェック名>/data/conf.yaml.example にあり、init_config と instances という 2 つのトップレベル要素を持っています。

init_config 下のコンフィギュレーションはインテグレーションにグローバルに適用され、インテグレーションのすべてのインスタンスで使用されます。一方、instances 内のコンフィギュレーションは特定のインスタンスに適用されます。

どちらのセクションの構成ブロックも次の形式になります。

## @<COMMAND> [- <ARGS>]
## <DESCRIPTION LINE 1>
## <DESCRIPTION LINE 2>
#
<KEY>: <VALUE>

構成ブロックは以下のガイドラインに従います。

• 説明を空にすることはできません。
• プレースホルダーは常に <THIS_IS_A_PLACEHOLDER> のフォーマットに従ってください。詳しくは、ドキュメントサイトの寄稿ガイドラインを参照してください。
• すべての必須パラメーターはデフォルトでコメントにされません。
• すべてのオプションパラメーターはデフォルトでコメントにされます。
• プレースホルダーにインテグレーションのデフォルト値がある場合 (たとえば、インテグレーションのステータスエンドポイント)、それを汎用プレースホルダーの代わりに使用できます。

@param の指定

@param コマンドは、構成ブロックを記述し、構成のドキュメントを提供するために使用することができます。

param は、以下のいずれかの形式で実装されます。

@param <name> - <type> - 必須
@param <name> - <type> - オプション
@param <name> - <type> - オプション - デフォルト: <defval>

引数:

• name: パラメーターの名前。例: search_string (必須)。
• type: パラメーター値のデータタイプ (必須)。 Possible values include the following: boolean, string, integer, double, float, dictionary, list*, and object*.
• defval: パラメーターのデフォルト値。空でもかまいません (オプション)。

list および object 変数は複数行にまたがり、特別な規則があります。

• list の個々の要素は、@param 指定を使用して文書化されません。
• object の場合は、@param 指定を使用して要素を個別に文書化することも、オブジェクト自体の指定に続けてトップレベルに共通の説明を付けることもできます。

オプションパラメーター

オプションパラメーターはデフォルトでコメントにする必要があります。パラメーターの記述に使用される各行の前に、@param 指定と同じインデントで # を追加します。

ブロックコメント

次の規則に従って、構成ファイルの任意の場所にブロックコメントを追加できます。

• コメントは ## で開始されます。
• コメントは変数と同様にインデントされます (ハイフンはカウントされません)。

YAML 構文についての詳細は、YAMLに関する Wikipedia の記事を参照してください。また、Online YAML Parser を調べることもできます。

マニフェストファイル

Integrations ページまたは Marketplace ページにあるすべての製品には、動作パラメーター、より大きなDatadog インテグレーションエコシステム内での位置づけ、追加のメタデータを定義する manifest.json ファイルがあります。

You can find the complete list of mandatory and optional attributes for the manifest.json file below:

分類子タグ

classifier_tags パラメーターを使用して、複数のカテゴリーを設定し、インテグレーションに送信またはクエリされるデータタイプを定義することができます。

manifest.json ファイルに対する分類子タグの完全なリストは、以下の通りです。

サービスチェックファイル

service_check.json ファイルは、インテグレーションによって作成されたサービスチェックを記述します。

service_checks.json ファイルの必須属性の完全なリストは、以下の通りです。

メトリクスメタデータファイル

metadata.csv ファイルには、インテグレーションが収集できるすべてのメトリクスが記述されます。

以下に、metadata.csv ファイルの必須属性とオプション属性の完全なリストを示します。

その他の参考資料

お役に立つドキュメント、リンクや記事:

ドキュメントサイトへの寄稿ガイドラインGITHUB Agent または API ベースのインテグレーションの作成についてDOCUMENTATION OAuth を使ったインテグレーションについてDOCUMENTATION