ログインテグレーションの作成

Docs > 開発者 > インテグレーションの構築 > ログインテグレーションの作成

概要

このページでは、Datadog Log インテグレーションを作成する方法をテクノロジーパートナーに説明します。

ログインテグレーション

ログ取り込み HTTP エンドポイントを使用して、Datadog にログを送信します。

開発プロセス

ガイドライン

ログインテグレーションを作成する際には、以下のベストプラクティスを考慮してください。

source タグにインテグレーション名を設定します。: Datadog は、source タグに <integration_name> を設定し、service タグにテレメトリーを生成するサービス名を設定することを推奨しています。例えば、service タグは、製品ラインごとにログを区別するために使用することができます。

異なるサービスが存在しない場合は、service に source と同じ値を設定します。タグはインテグレーションパイプラインとダッシュボードを有効にするために使用されるため、source と service タグはユーザが編集できないようにする必要があります。タグはペイロードまたはクエリパラメーターで設定することができます (例: ?ddsource=example&service=example)。

source と service のタグは小文字である必要があります。
インテグレーションは、すべての Datadog サイトをサポートする必要があります。: ユーザーが異なる Datadog サイトを選択できるようにする必要があります。サイトの違いについては、Datadog サイトの概要を参照してください。

Datadog サイトのエンドポイントは http-intake.logs. です。
インテグレーションを設定する際に、ユーザーがカスタムタグをアタッチできるようにします。: Datadog は、手動ユーザータグを JSON 本文の key-value 属性として送信することを推奨しています。ログに手動タグを追加できない場合は、ddtags=<TAGS> クエリパラメーターを使用してタグを送信することができます。例については、Send Logs API ドキュメントを参照してください。
可能な限り、JSON 本文には配列を入れずにデータを送信します。: 一部のデータをタグとして送信することは可能ですが、Datadog は JSON 本文にデータを送信し、配列を避けることを推奨しています。これにより、Datadog ログ管理でデータに対して実行できる操作の柔軟性が高まります。
Datadog API キーをログに記録しません。: Datadog API キーは、ヘッダーで渡すか、HTTP パスの一部として渡すことができます。例については、Send Logs API ドキュメントを参照してください。Datadog は、セットアップで API キーをログに記録しないメソッドを使用することを推奨しています。
Datadog アプリケーションキーを使用しません。: Datadog アプリケーションキーは、API キーとは異なり、HTTP エンドポイントを使用してログを送信するためには必要ありません。

Datadog パートナーアカウントでログインテグレーションアセットを設定する

ログパイプラインの構成

Datadog に送信されたログは、ログパイプラインで処理され、検索や分析がしやすいように標準化されます。

パイプラインを設定するには、

Logs > Pipelines に移動します。
+ New Pipeline をクリックします。
Filter フィールドに、テクノロジーパートナーのログのログソースを定義する一意の source タグを入力します。例えば、Okta インテグレーションでは、source:okta となります。注: インテグレーションを通じて送信されるログは、Datadog に送信される前に正しいソースタグでタグ付けされていることを確認してください。
オプションで、タグと説明を追加します。
作成をクリックします。

パイプライン内にプロセッサーを追加することで、データを再構築し、属性を生成することができます。例:

日付リマッパーを使用して、ログの正式なタイムスタンプを定義します。
属性リマッパーを使用して、属性キーを標準の Datadog 属性にリマップします。例えば、クライアント IP を含む属性キーは、Datadog がすぐに使えるダッシュボードでテクノロジーパートナーログを表示できるように、network.client.ip にリマップする必要があります。
サービスリマッパーを使って、service 属性をリマップするか、source 属性と同じ値に設定します。
grok プロセッサーを使用して、ログ内の値を抽出し、検索や分析に役立てることができます。
メッセージリマッパーを使って、ログの公式メッセージを定義し、特定の属性を全文で検索できるようにします。

全ログプロセッサーの一覧は、プロセッサーを参照してください。

ログエクスプローラーにファセットを設定する

すぐに使えるダッシュボードウィジェットに表示されるファセットは、ログエクスプローラーでオプションで作成することができます。

ファセットは、相対的な洞察を得たり、一意の値をカウントするために使用されます。
メジャーは、ある範囲での検索に使用されるファセットの一種です。例えば、レイテンシー期間のメジャーを追加すると、特定のレイテンシー以上のすべてのログを検索することができます。注: メジャーファセットの単位は、属性が何を表すかに基づいて定義されます。

ファセットまたはメジャーを追加するには

ファセットまたはメジャーを追加したい属性を含むログをクリックします。
ログパネルで、属性の横にある歯車アイコンをクリックします。
Create facet/measure for @attribute を選択します。
メジャーの場合、単位を定義するには、Advanced options をクリックします。属性が表すものに基づいて、単位を選択します。
Add をクリックします。

ファセットリストを簡単に移動できるように、類似のファセットをグループ化します。インテグレーションログに固有のフィールドについては、source タグと同じ名前のグループを作成します。

ログパネルで、新しいグループに入れたい属性の横にある歯車アイコンをクリックします。
Edit facet/measure for @attribute を選択します。属性のファセットがまだ存在しない場合は、Create facet/measure for @attribute を選択します。
Advanced options をクリックします。
Group フィールドに、新しいグループの名前を入力し、New group を選択します。
Update をクリックします。

標準の Datadog 属性は、それぞれの特定のグループの下にあるデフォルトの標準属性リストを参照してください。