Splunk On-CallのDelivery Insightsインテグレーション 🔗
Splunk On-Call Delivery Insights Generic Endpointは、JSONペイロードを持つ HTTPS POSTリクエストを通じて、あらゆるソースからのメッセージを受け入れます。リクエストの内容さえ設定できれば、マージの投稿、プルリクエスト、タイムラインへのメッセージのビルドが可能です。
要件 🔗
このインテグレーションは以下のバージョンのSplunk On-Callと互換性があります:
Starter
Growth
エンタープライズ
インテグレーションを有効化する 🔗
Splunk On-Callで、インテグレーションページに移動します。
Delivery Insightsのエンドポイントインテグレーションが有効化されていない場合は、Enable を選択して、エンドポイントの宛先URLを生成してください。
注釈
Delivery Insightsエンドポイントは、一般的なAPIとは異なり、Delivery Insightsメッセージを作成するのに適した方法です。
必須フィールドと推奨フィールド 🔗
Delivery Insightsメッセージのペイロードは、お客様のデリバリーライフサイクルに関する簡潔な情報を提供し、リンクからその情報にすばやくアクセスできます。event_type
と entity_type
は、特定の値が必要な唯一のフィールドです。その他の必須フィールドは、リンクを含む簡潔で実用的なショートメッセージを作成するために使用されます。その他のフィールドはすべて、長文の拡張メッセージの一部として使用されます。
フィールド |
必須 |
説明 |
---|---|---|
|
はい |
メッセージのタイプ。有効な値:Build、Merge、Pull Request。 |
|
はい |
イベントのタイプ。有効な値:Build System、Software Configuration Management。 |
|
いいえ |
このメッセージを送信しているソースシステム。メッセージを送信するサードパーティツールまたは内部ツールの名前。 |
|
はい |
簡単な説明メッセージ。このメッセージは、ペイロードの一部として提供されたURLの表示値となります。 |
|
はい |
サードパーティツールのイベントにリンクするためのURL。このURLの表示は、ペイロードの一部として提供されるサマリーフィールドから取得されます。 |
|
はい |
このイベントに対して行われている特定のアクション。アクションは、このイベントに対してどのようなアクションが実行されているかを記述するために、要約の最後に付加されます。例:Open、Deployed、Createdなど。 |
|
はい |
アクションの結果。結果は概要の前に追加されるので、配信イベントに関して必要な情報を素早く得ることができます。例:成功、失敗など。 |
|
いいえ |
この問題が始まった時間(Unix時間)。このエンティティが現在の状態になった時刻(エポックからの秒数)。デフォルト値はアラートを受信した時刻です。 |
|
いいえ |
イベントに関連する他のシステムのユーザー。 |
例 🔗
以下の例では、JSONはタイムラインにメッセージを追加しています:
{
"entity_type": "build system",
"event_type": "Build",
"source": "Internal Tool",
"summary": "new version of mobile app",
"url": "https://www.splunk.com",
"action": "deployed",
"result": "SUCCESS",
"long_message": "New build includes bug fixes for connectivity issues and that new feature"
}
フィルター 🔗
Splunk On-CallタイムラインのDelivery Insightsメッセージは、event_type
のBranch、Pull Request、Merge、Build、Deployフィールドの値に基づいてフィルターできます。
メインのタイムラインからフィルターアイコンを選択し、Message Types、メッセージの種類を選択すると、Delivery Insightsに基づいてタイムラインのフィルターを調整することができます。
Delivery Insightsクイックフィルターは、以下の画像に示すように、「すべてのフィルター」メニューの隣にあります。クイックフィルターはスイッチです。これをオンにすると、手動フィルターで事前に選択されたすべてのDelivery Insightsメッセージがタイムラインに表示されます。どのメッセージも選択されていない場合、タイムラインにはすべてのDelivery Insightsメッセージが表示されます。