Docs » Splunk Observability Cloudを使用してサービスにアラート通知を送信する » Splunk Observability Cloudを使用してSplunkプラットフォームにアラート通知を送信する

Splunk Observability Cloudを使用してSplunkプラットフォームにアラート通知を送信する 🔗

条件によってディテクターがトリガーされたとき、および解除条件によってアラート条件が解除されたときにSplunkプラットフォームにアラート通知を自動送信するように、Splunk Observability Cloudを設定できます。

注釈

  • ディテクターのアラート受信者としてSplunkプラットフォームを追加するには、管理者アクセス権限が必要です。このアクセス権を得るには、既存の管理者があなたのユーザープロファイルに権限を追加する必要があります。詳細は、Splunk Observability Cloudでユーザーを作成および管理する を参照してください。

Splunk Observability Cloudのアラート通知をSplunkプラットフォームに送信するには、以下の設定タスクを実行します：

ステップ1：Splunk Observability CloudでSplunkプラットフォームインテグレーションを作成する 🔗

  1. Splunk Observability Cloudにログインします。

  2. Splunkプラットフォームガイド付きセットアップ を開きます。以下の方法で、ガイド付きセットアップに自分で移動することもできます：

    1. ナビゲーションメニューで、Data Management を選択します。

    2. Available integrations タブに移動するか、Add Integration タブで Deployed integrations を選択します。

    3. インテグレーションのフィルターメニューで、All を選択します。

    4. Search フィールドで Splunk platform を検索し、選択します。

    5. 新規インテグレーション を選択すると、設定オプションが表示されます。

  3. 概要 ページで、Next を選択します。

  4. 接続の設定 ページで、以下のフィールドに情報を入力します：

    フィールド

    説明

    名前

    インテグレーションに一意の記述名を付けます。この名前がダウンストリームでどのように使用されるかについては、インテグレーションの命名について を参照してください。

    URL

    SplunkプラットフォームインスタンスのHTTP Event Collector（HEC）のURI を入力します。URIのポート番号より後の部分は含めないでください。例えば、<protocol>://http-inputs-<host>.splunkcloud.com:<port> のようなHEC URIを入力します。詳細については、Splunk Cloud Platformのドキュメント の「 HTTP Event Collectorへのデータ送信 」セクションを参照してください。

    HECトークン

    Splunkプラットフォームインスタンスへのアクセスを許可するためのHTTP Event Collectorトークンを入力します。詳細は、Splunk Webで HTTP Event Collectorの設定と使用 を参照してください。

    注釈

    Splunk Observability Cloudは、HECインデクサー確認応答に対応していません。Splunkプラットフォームインテグレーションを使用する場合は、Splunk EnterpriseインスタンスでHECトークンのインデクサー確認応答をアクティブ化しないでください。

  5. Next を選択します。

  6. メッセージのカスタマイズ ページでは、Splunkプラットフォームインテグレーションのデフォルトテンプレートが表示されます。ペイロードをカスタマイズすることで、対応者が問題を解決するために必要なコンテキストを確保することができます。詳細は、Splunkプラットフォームインテグレーションのカスタムペイロードでサポートされる変数 を参照してください。

  7. Next を選択します。

  8. インテグレーションを確認し、Save を選択します。

ステップ2：Splunk Observability Cloudのディテクターのアラート受信者としてSplunkプラットフォームインテグレーションを追加する 🔗

Splunk Observability Cloudのディテクターのアラート受信者としてSplunkプラットフォームインテグレーションを追加するには、以下の手順に従います：

  1. Splunkプラットフォームインテグレーションを使用してアラート通知を送信するように設定したいディテクターを作成または編集します。

    ディテクターに関する作業の詳細は、アラートをトリガーするディテクターを作成する および 「ディテクター」メニューを使用してアラートの受信登録をする を参照してください。

  2. アラート受信者 のステップで、受信者の追加 を選択します。

  3. Splunkプラットフォーム を選択し、アラート通知の送信に使用するSplunkプラットフォームインテグレーションの名前を選択します。これは、ステップ1：Splunk Observability CloudでSplunkプラットフォームインテグレーションを作成する で作成したインテグレーション名です。

  4. ディテクターをアクティブ化し、保存します。

Splunk Observability Cloudは、ディテクターがアラートをトリガーまたは解除したときに、Splunkプラットフォームにアラート通知を送信します。

Splunkプラットフォームインテグレーションのカスタムペイロードでサポートされる変数 🔗

以下の表は、カスタマイズする際の変数の全リストです。

注釈

  • 説明で特に断りのない限り、すべての変数は文字列型です。

  • 変数がオプションとなっている場合は、常に利用可能であるとは限らないという意味です。ペイロードを構築するために、現状で利用できないオプションの変数を使用した場合、Handlebarsはそれを空の文字列に変換します。

変数

説明

detector

ディテクターの名前。

detectorUrl

この特定のインシデントを選択するためのパラメータを含む、ディテクターのURL。

detectorId

ディテクターのID。

description

（オプション）ディテクターのルールの説明。

dimensions

入力MTS内のディメンションのマップ。

imageUrl

（オプション）アラートのプレビュー画像のURL。

incidentId

このアラート通知の一意の識別子。

eventType

通知を送信したディテクターのバージョンの一意の識別子。

rule

アラートをトリガーしたディテクタールールの名前。

severity

Splunk Observability Cloudが決定するルールの重大度レベル。カスタムペイロードでこの変数を使用します。

runbookUrl

このルール内に記述されたランブックのURL。

tip

このルール内に記述されたヒント。

messageTitle

このルールの通知タイトル。

messageBody

このルールの通知メッセージ。

detectOnCondition

（オプション）SignalFlow形式で記述された、メトリクスデータの基準とディテクタールールの検出基準。

detectOffCondition

（オプション）SignalFlow形式で記述された、このルールの明確なメトリクスデータと検出基準。

status

後方互換性のために保持される、インシデントのステータス。より詳細な情報には、statusExtended を使用します。有効な値には以下が含まれます：

  • anomalous：検出条件が満たされているために、アラートが起動しています。

  • ok：検出条件が満たされなくなったか、解除条件（存在する場合）が満たされているために、アラートが解除されています。

statusExtended

インシデントのステータスの新しい変数。status の代わりに使用します。有効な値には以下が含まれます：

  • anomalous：検出条件が満たされているために、アラートが起動しています。

  • ok：検出条件が満たされなくなったか、解除条件（存在する場合）が満たされているために、アラートが解除されています。

  • manually resolved：ユーザーがUIまたはAPIを介してアラートを解決した場合。

  • stopped：アラートをトリガーしたディテクターが編集または削除された場合。

timestamp

ISO 8601形式で記述された、イベントの発生時刻。

inputs

このルールに関係する入力のマップ。この変数は、配列型です。詳細は、inputs 配列 を参照してください。

sf_schema

このイベントのスキーマのバージョン。この値は常に 2 に設定されます。

orgId

アラートの発生元のSplunk Observability Cloud組織の組織ID。

originatingMetric

アラートをトリガーしたメトリクスの名前。

src

以下のディメンションで定義されるアラートのソース。使用可能な最初のディメンション値が、アラートのソースとして設定されます。

  • k8s.pod.name

  • k8s.cluster.name

  • k8s.node.name

  • k8s.container.name

  • host

  • host.name

  • aws_arn

  • gcp_standard_id

  • azure_resource_id

  • sf_service

  • sf_workflow

  • sf_operation

  • test

inputs 配列 🔗

inputs 配列の各オブジェクトは、それを支配するプログラム変数の名前によって命名されます。支配するプログラム変数がないオブジェクトには、_S0 や _S1 などの名前が使用されます。

各入力オブジェクトには以下の要素が含まれます：

要素

説明

key

（オプション）入力シグナルのディメンションのマップ。ディメンションがない場合、この要素は空白になる可能性があります（例：入力が静的な値で、スカラー値との比較ではなかった場合）。

value

アラートのトリガー時または解除時の入力の値。

fragment

（オプション）これは、入力を表すSignalFlowプログラムのフラグメントです。一部のディテクター、あるいは静的な匿名の入力では、この要素は存在しない可能性があります。

ヘルパー関数 🔗

テンプレート変数を使用してペイロードをカスタマイズする以外に、以下のヘルパー関数を使用して、送信アラートに正しい値が設定されることを保証することもできます。

関数

説明

例

coalesce

空でない最初の値を返します。この関数を使用して、src 変数のディメンションの順序を指定できます。
{{{coalesce dimensions.host dimensions.aws_arn ‘No ID Found!’}}}
この例では、dimensions.host （存在する場合）をアラートに設定し、2つ目のオプションとして dimensions.aws_arn を設定し、ホストもAWS IDも存在しない場合は文字列 “No ID Found!” を設定します。

severityDecoder

ステータス変数が ok の場合、2 を返します。そうでない場合、この関数は重大度変数をチェックしデコードします：

  • 1：情報

  • 3：警告

  • 4：マイナー

  • 5：メジャー

  • 6：クリティカル

  • empty：重大度不明
{{{severityDecoder ok='ok' Major='not_ok' default='empty'}}}
この例は、デフォルトの戻り値をオーバーライドしてカスタマイズしています。

encodeString

文字列内の引用符と改行文字をエスケープします。

{{{encodeString messageTitle}}}

notEmpty

指定された値が空のマップでない場合にのみ、ペイロードにテキストを追加します。この関数は、inputs と dimensions の変数でのみ機能します。
この例は、ディメンションが空でない場合のみ表示されます：{{#notEmpty dimensions}}
{{/notEmpty}}

json

文字列を生のJSON値に変換します。この関数を使用して、ディテクターからのテキストを、サードパーティのインテグレーションで評価できるJSONペイロードに変換します。

{{{json dimensions}}}

substring

このシーケンスのサブシーケンスである新しい文字シーケンスを返します。このサブシーケンスは、指定したインデックスの文字で始まり、最後から2番目のインデックスの文字で終わります。
{{substring var 1}}
{{substring var 1 3}}

abbreviate

指定された文字数より長い場合に、文字列を切り詰めます。省略の最小幅は4です。

{{abbreviate long_str 5}}

replace

文字のターゲットシーケンスにマッチするこの文字列の各部分文字列を、指定された文字の置換シーケンスで置き換えます。

{{replace abbreviated '...' ''}}

eq

2つの要素が等しいかどうかをチェックします。
{{#eq a b}}yes{{else}}no{{/eq}}
{{#eq a 2}}yes{{else}}no{{/eq}}

このページは 2024年11月25日 に最終更新されました。