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

Docs > 開発者 > インテグレーションの構築 > インテグレーションアセットリファレンス

概要

このページでは、** Integrations** ページまたは Marketplace ページで製品を作成するために入力する必要があるファイルについて説明します。

構成ファイル

When preparing a new integration, you must include an example configuration that contains the necessary options and reasonable defaults. The example configuration file—which in this case, is located at <CHECK_NAME>/datadog_checks/<CHECK_NAME>/data/conf.yaml.example—has two top-level elements: init_config and instances.

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 変数は複数行にまたがり、特別な規則があります。

In a list, individual elements are not documented with the @param specification.
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:

manifest_version: Mandatory
Type: String Enum.
Description: Version of the manifest schema. Supported values include 1.0.0 and 2.0.0.
app_uuid: Mandatory
Type: UUID.
Description: Globally unique UUID for this application. This is automatically generated by Datadog when the developer toolkit ddev create command runs as part of creating tile scaffolding for your integration tile.
app_id: Mandatory
Type: String.
Description: The unique identifying name of this offering. Usually kebab case of the app title. For example, if the app title is “Marketplace Offering”, then the app_id would be marketplace-offering.
assets: Mandatory
Type: Dictionary.
Description: Object containing any Datadog installable entity.
assets[dashboards]: Optional
Type: Dictionary.
Description: Out-of-the-box dashboards associated with this offering.
assets[dashboards["dashboard_short_name"]]: Mandatory
Type: String.
Description: Key and value pairs for any out-of-the-box dashboards. The key is the globally unique short name of the dashboard and the value is the relative path to the dashboard’s JSON definition in relation to this manifest.
assets[integration]: Optional
Type: Dictionary.
Description: Object containing information about the integration.
assets[integration[auto_install]]: Mandatory
Type: Boolean.
Description: Whether or not the integration and related assets should be installed automatically when metrics or logs from the integration are received from the source. This is typically set to true for integrations using the Datadog Agent, and other integrations that are configured outside the Datadog UI. It is typically set to false for marketplace integrations and integrations that are configured with the Datadog UI, such as integrations using OAuth.
assets[integration[configuration]]: Mandatory, can be { }
Type: Dictionary.
Description: Object representing the configuration specification for this integration.
assets[integration[configuration[spec]]]: Mandatory
Type: String.
Description: Relative path to where the configuration spec lives in relation to this manifest.
assets[integration[events]]: Mandatory
Type: Dictionary.
Description: Information about events emitted by this integration.
assets[integration[events[creates_events]]]: Mandatory
Type: Boolean.
Description: Whether or not this integration emits events to Datadog.
assets[integration[metrics]]: Mandatory
Type: Dictionary.
Description: Information about the metrics this integration emits.
assets[integration[metrics[check]]]: Mandatory
Type: String or list of strings.
Description: A string or list representing metrics that this integration always emits on every run.
assets[integration[metrics[metadata_path]]]: Mandatory
Type: String.
Description: Relative path to where the metrics metadata lives in relation to this manifest.
assets[integration[metrics[prefix]]]: Mandatory
Type: String.
Description: The prefix for metrics emitted by this integration.
assets[integration[service_checks]]: Mandatory, can be { }
Type: Dictionary.
Description: Information about service checks emitted by this integration.
assets[integration[service_checks[metadata_path]]]: Mandatory
Type: String.
Description: Relative path to where the service check metadata lives in relation to this manifest.
assets[integration[source_type_name]]: Mandatory
Type: String.
Description: User-facing name of this integration.
assets[integration[source_type_id]]: Mandatory
Type: Integer.
Description: Globally unique ID for this integration. This is automatically generated by Datadog when the developer toolkit ddev create command runs as part of creating tile scaffolding for your integration tile.
assets[monitors]: Optional
Type: Dictionary.
Description: Recommended monitors.
assets[monitors["monitor_short_name"]]: Mandatory
Type: String.
Description: Key and value pairs for any recommended monitors. The key is the globally unique short name of the monitor and the value is the relative path to the monitor’s JSON definition in relation to this manifest.
author: Mandatory
Type: Dictionary.
Description: Information about the author of this app.
author[homepage]: Mandatory
Type: String (URL).
Description: The web URL to the homepage of the author.
author[name]: Mandatory
Type: String.
Description: The human-readable name for this company.
author[sales_email]: Mandatory
Type: String (Email).
Description: The Partner email to contact for any subscription-level events.
author[support_email]: Mandatory
Type: String (Email).
Description: The Partner email to contact for any support and maintenance queries.
author[contact_link]: Optional
Type: String (URL).
Description: The URL link to meeting scheduling software, such as Calendly. This field is mandatory for professional services listings.
author[vendor_id]: Mandatory
Type: String.
Description: The vendor ID to use for subscription purposes. Must be globally unique and cannot be changed. Should follow the strict standards of app_id where only dashes and alphabetic chars are allowed. This value is provided to Datadog Technology Partners.
display_on_public_website: Mandatory
Type: Boolean.
Description: Whether or not information about this listing is displayed on the public Datadog Docs site. Once this is set to true, it cannot be changed.
legal_terms: Mandatory
Type: Dictionary.
Description: Any legal documentation that a user needs to agree to in order to use this app.
legal_terms[eula]: Mandatory
Type: String.
Description: Relative path to the End User License Agreement (EULA) PDF in relation to this manifest.
pricing: Mandatory
Type: Array of Dictionaries.
Description: List of objects representing the pricing model of the integration. See the Marketplace GitHub repository for pricing details. The Marketplace GitHub repository is private, email marketplace@datadog.com for access.
tile: Mandatory
Type: Dictionary.
Description: Information about this offering.
tile[description]: Mandatory
Type: String[80].
Description: A brief description of what this offering provides. Limited to 80 characters.
tile[title]: Mandatory
Type: String[50].
Description: The user-friendly title for this app.
tile[media]: Mandatory, can be [ ]
Type: Array of Dictionaries.
Description: Information about the various image and video style objects that are presented in the media gallery carousel on the listing page.
tile[media[media_type]]: Mandatory
Type: String or Enum.
Description: The type of media this is. Allowed values are image and video.
tile[media[caption]]: Mandatory
Type: String.
Description: The caption for the image.
tile[media[image_url]]: Mandatory
Type: String.
Description: The relative path to this image in relation to this manifest file.
tile[classifier_tags]: Mandatory, can be [ ]
Type: Array of strings.
Description: Select and use the appropriate classifiers to describe this app, including categories, submitted or queried data types, supported_os, and available_offerings. For more information, see Classifier Tags.
tile[resources]: Optional
Type: Array of Dictionaries.
Description: List of externally hosted resources (blog posts, documentation, etc.) that appear in the “Dive Deeper” section of the integration tile with rich previews.
tile[resources[resource_type]]: Mandatory
Type: String.
Description: Type of resource being linked. Can be blog, documentation, faq, or other.
tile[resources[url]]: Mandatory
Type: String.
Description: Link to resource.

分類子タグ

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

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

名前	説明
Category::AI	AI 技術を監視するインテグレーション。
Category::Alerting	Datadog のデータを収集してアラートを出したり、Datadog にアラートを送信するインテグレーション。
Category::Automation	セキュリティ、コンプライアンス、テスト、AIOps などのプロセスを自動化するテクノロジーのインテグレーション。
Category::AWS	Amazon Web Services とその関連サービスからデータを送信するインテグレーション。
Category::Azure	Azure とその関連サービスからデータを送信するインテグレーション。
Category::Caching	キャッシュとキャッシュ技術を監視するインテグレーション。
Category::Cloud	クラウドプラットフォームとその関連サービスからデータを送信するインテグレーション。
Category::Collaboration	コードコラボレーション、メッセージングソフトウェア、電話会議など、コミュニケーションとコラボレーションを中心としたプラットフォームのインテグレーション。
カテゴリ::コンプライアンス	HIPPA、SOC2、GDPR などのコンプライアンスデータを監視し、Datadog に送信するインテグレーション。
Category::Configuration & Deployment	インフラストラクチャーを構成しデプロイできるプラットフォームを監視するインテグレーション。
Category::Containers	コンテナやコンテナ管理テクノロジーからのメトリクス、ログ、イベント、トレースを追跡するインテグレーション。
Category::Cost Management	クラウドコストの追跡と管理に役立つインテグレーション。
Category::Data Stores	データベース、クラスター、データレイクなどのデータストレージソリューションを監視するインテグレーション。
Category::Developer Tools	バージョン管理、CI/CD、コードとしてのインフラストラクチャーなど、開発者がアプリケーションの構築に使用するテクノロジーのインテグレーション。
Category::Event Management	Datadog にイベントを送信したり、外部プラットフォームに送信するイベントをクエリするインテグレーション。
Category::Google Cloud	Google Cloud とその関連サービスからデータを送信するインテグレーション。
Category::Incidents	Datadog にインシデントを送信したり、Datadog のデータに基づいて外部でインシデントを作成するインテグレーション。
Category::IOT	IoT (モノのインターネット) デバイスを監視するインテグレーション。
Category::Issue Tracking	ユーザーがインフラストラクチャーやコードの問題を特定し、管理するのに役立つインテグレーション。
Category::Kubernetes	Kubernetes と Kubernetes 関連サービスからデータを送信するインテグレーション。
Category::Languages	特定のプログラミング言語に基づいてメトリクスや追加データを送信するインテグレーション。
Category::Log Collection	Datadog からログを送信またはクエリするインテグレーション。
Category::Machine Learning & LLM	機械学習 (ML) テクノロジー、大規模言語モデルを監視し、ML オペレーションを支援するインテグレーション。
Category::Mainframe	IBM z/OS などのメインフレームシステムを監視するインテグレーション。
Category::Marketplace	Datadog Marketplace で追加料金で販売されているインテグレーション。
Category::Messaging	メッセージングキューとメッセージングシステムを監視するインテグレーション。
Category::Metrics	Datadog からメトリクスを送信し、クエリするインテグレーション。
Category::Mobile	モバイルデバイスとアプリケーションを監視するインテグレーション。
Category::Network	ネットワークとネットワークデバイスを監視するインテグレーション。
Category::Notifications	例えばインシデント対応など、通知に重点を置いたテクノロジーのインテグレーション。
Category::Oracle	Oracle ベースのテクノロジーを監視するインテグレーション。
Category::Orchestration	コンテナなどのオーケストレーションを提供するテクノロジーのインテグレーション。
Category::OS & System	オペレーティングシステムやその他の低レベルのシステムを監視するインテグレーション。
Category::Provisioning	クラウドやコンテナなどのリソースのプロビジョニングを管理するテクノロジーのインテグレーション。
Category::SAP	SAP テクノロジーのインテグレーション。
Category::Security	セキュリティツールを監視したり、セキュリティレポートを提供するインテグレーション。
Category::SNMP	SNMP と関連ツールを監視するインテグレーション。
カテゴリ::ソースコントロール	Git などのソースコードコラボレーションツールを監視するインテグレーション。
Category::Testing	ブラウザテスト、負荷テストなどを実行するテクノロジーを監視するインテグレーション。
Category::Tracing	Datadog からトレースを送信またはクエリし、Datadog APM と対話するインテグレーション。
Offering::Integration	これは、ユーザーの Datadog アカウントからデータを送信またはクエリする製品です。
Offering::Professional Service	これは、Datadog Marketplace を通じて Datadog のお客様にコンサルティングやインテグレーション作成などのサードパーティのプロフェッショナルサービスを提供する有料製品です。
Offering::Software License	これは、Datadog Marketplace を通じて SaaS 製品のサブスクリプションを提供する有料製品です。
Offering::UI Extension	これは、Datadog ユーザーのダッシュボード上にレンダリングされたインタラクティブな iFrame を表示するカスタムダッシュボードウィジェットです。
Queried Data Type::Metrics	Datadog ユーザーのアカウントからメトリクスを読み取るインテグレーション。
Queried Data Type::Logs	Datadog ユーザーのアカウントからログを読み取るインテグレーション。
Queried Data Type::Traces	Datadog ユーザーのアカウントからトレースを読み取るインテグレーション。
Queried Data Type::Events	Datadog ユーザーのアカウントからイベントを読み取るインテグレーション。
Queried Data Type::Incidents	Datadog ユーザーのアカウントからインシデントを読み取るインテグレーション。
Submitted Data Type::Metrics	Datadog ユーザーのアカウントにメトリクスを送信するインテグレーション。
Submitted Data Type::Logs	Datadog ユーザーのアカウントにログを送信するインテグレーション。
Submitted Data Type::Traces	Datadog ユーザーのアカウントにトレースを送信するインテグレーション。
Submitted Data Type::Events	Datadog ユーザーのアカウントにイベントを送信するインテグレーション。
Submitted Data Type::Incidents	Datadog ユーザーのアカウントにインシデントを送信するインテグレーション。
Supported OS::Android	Android 上で動作し、Android からデータをクエリ/送信できるインテグレーション。
Supported OS::Any	任意の OS 上で動作し、その OS からデータをクエリ/送信できるインテグレーション。
Supported OS::HP-UX	HP-UX 上で動作し、HP-UX からデータをクエリ/送信できるインテグレーション。
Supported OS::IBM i/OS	IBM i/OS 上で動作し、IBM i/OS からデータをクエリ/送信できるインテグレーション。
Supported OS::IBM z/OS	IBM z/OS 上で動作し、IBM z/OS からデータをクエリ/送信できるインテグレーション。
Supported OS::iOS	iOS 上で動作し、iOS からデータをクエリ/送信できるインテグレーション。
Supported OS::Linux	Linux 上で動作し、Linux からデータをクエリ/送信できるインテグレーション。
Supported OS::macOS	macOS 上で動作し、macOS からデータをクエリ/送信できるインテグレーション。
Supported OS::Solaris	Solaris 上で動作し、Solaris からデータをクエリ/送信できるインテグレーション。
Supported OS::Windows	Windows 上で動作し、Windows からデータをクエリ/送信できるインテグレーション。

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

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

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

属性	説明
`agent_version`	サポートされている Agent の最小バージョン。
`integration`	このサービスチェックを送信するインテグレーションの名前。これは、`manifest.json` にある正規化されていない `tile.title` です。
`check`	サービスチェックの名前。一意である必要があります。
`statuses`	チェックのさまざまなステータスのリスト。`ok`、`warning`、`critical` から選択します。`unknown` も可能です。
`groups`	サービスチェックと共に送信されるタグ。
`name`	サービスチェックの表示名。表示名はわかりやすく、すべてのインテグレーションで一意である必要があります。
`description`	サービスチェックの説明。

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

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

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

列名	必須またはオプション	説明
`metric_name`	必須	メトリクスの名前。
`metric_type`	必須	メトリクスのタイプ。利用可能なメトリクス送信タイプの一覧は、メトリクスタイプを参照してください。
`interval`	オプション	メトリクスの収集間隔 (秒単位)。
`unit_name`	オプション	メトリクスの単位。対応する単位の一覧は、メトリクスの単位を参照してください。
`per_unit_name`	オプション	単位の下位区分がある場合。`request per second` (1 秒あたりのリクエスト) など。
`description`	オプション	メトリクスの説明。
`orientation`	必須	`myapp.turnover` のように、大きい方がよいメトリクスの場合は `1` に設定します。メトリクスの変動が特に重要でない場合は `0` に設定します。`myapp.latency` のように、小さい方がよいメトリクスの場合は `-1` に設定します。
`integration`	必須	メトリクスを送信するインテグレーションの名前。これは、`manifest.json` ファイルにある `tile.title` を正規化した文字列です。文字、アンダースコア、ダッシュ、数字以外の文字はアンダースコアに変換されます。例: `Openstack Controller` -> `openstack_controller`、`ASP.NET` -> `asp_net`、`CRI-o` -> `cri-o`。
`short_name`	必須	Explicit unique ID for the metric.
`curated_metric`	オプション	インテグレーションのためのどのメトリクスが、与えられたタイプで注目すべきかをマークします (`cpu`と`memory`の両方が受け入れられる)。これらは、UI で他のインテグレーションメトリクスの上に表示されます。