IBM Cloud Logs でのアクションを使用したサード・パーティー・サービスとの統合

IBM Cloud Logs では、検索結果や値に基づいてサードパーティのサービスを起動し、それらのサービスにデータを送信することができます。 ビューやダッシュボードから管理アクションを作成できます。

アクションの作成

アクションを作成するには:

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. 「ログ」 ビューで、 「設定」アイコン 「設定」 をクリックします。 この設定アイコンは、左側のナビゲーションのアイコンと同じではありません。 設定アイコンは、ページの右上にあるログ・ビューに表示されます。

  3. 「アクションの管理」 をクリックします。

  4. **「新規アクションの追加 (Add new action)」**をクリックします。

  5. 「無題のアクション」 に、アクションの名前を指定します。

  6. URL TEMPLATEに、外部サービスの URL。 例えば、https://test-my-url.com?type={{ $m.subsystemName === "frontend" ? "Front" : "Back" }} です。 http:// 、 https:// のみ対応。

    JavaScript 構文がサポートされています。 例えば、 {{ condition ? "true value" : "false value" }} などの条件を指定できます。 ほとんどの JavaScript 関数がサポートされています。

    URL でデータを渡すために 変数を 含めることができます。 二重中括弧 ({{}}) を入力すると、使用可能な変数のリストが表示されます。

  7. アクションに関連付けられている データ型 を選択します。 選択したコンテキストにアクションが表示されます。

  8. オプション設定にアクセスするには、 「拡張」 をクリックします。

  9. アクションをパブリックにするには、 「保存時にパブリックにする」 を切り替えます。

  10. アクションを特定の 「アプリケーション」 または 「サブシステム」 に制限するには、リストから値を選択します。

  11. 「アクションの保存」 をクリックします

アクションの編集

既存のアクションを編集するには

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. 「ログ」 ビューで、 「設定」アイコン 「設定」 をクリックします。 この設定アイコンは、左側のナビゲーションのアイコンと同じではありません。 設定アイコンは、ページの右上にあるログ・ビューに表示されます。

  3. アクションのリストで、変更するアクションをクリックします。

  4. 変更を加えます。

  5. 「アクションの保存」 をクリックして変更を保存するか、 「リセット」 をクリックしてアクションを最後に保存したバージョンのアクションに戻します。

アクションの複製

既存のアクションに基づいて新規アクションを作成する場合は、アクションを複製できます。

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. 「ログ」 ビューで、 「設定」アイコン 「設定」 をクリックします。 この設定アイコンは、左側のナビゲーションのアイコンと同じではありません。 設定アイコンは、ページの右上にあるログ・ビューに表示されます。

  3. アクションのリストで、複製するアクションの上にカーソルを移動します。

  4. 「複製」 アイコンをクリックします。 アクションの複製が作成されます。

  5. 複製されたアクションを 編集 して、変更を行います。

  6. Save Actionをクリックして変更を保存します。

アクション・メニューでのアクションの表示と非表示

ユーザーがアクションを トリガー できるかどうかを構成できます。

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. 「ログ」 ビューで、 「設定」アイコン 「設定」 をクリックします。 この設定アイコンは、左側のナビゲーションのアイコンと同じではありません。 設定アイコンは、ページの右上にあるログ・ビューに表示されます。

  3. アクションのリストで、設定したいアクションをクリックします。

  4. 「アクション・メニューから非表示」 アイコンをクリックして、アクション・メニューにユーザーのアクションを含めないようにします。 「アクション・メニューに表示」 アイコンをクリックすると、アクションがアクション・メニューに組み込まれます。

アクションのトリガー

以下のステップを実行して、アクションをトリガーします。

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. ビューに表示されているデータをクリックします。 メニューが表示されます。

  3. アクション上にカーソルを移動します。 利用可能なアクションのリストが表示されます。

  4. アクションをトリガーするアクションをクリックします。

    アクション・メニューに表示 されるように構成されているアクションのみが、アクション・メニューにリストされます。

アクションの削除

  1. 左側のナビゲーションで、 「ログの探索」 アイコン 「ログの探索」アイコン > 「ログ」 をクリックします。

  2. 「ログ」 ビューで、 「設定」アイコン 「設定」 をクリックします。 この設定アイコンは、左側のナビゲーションのアイコンと同じではありません。 設定アイコンは、ページの右上にあるログ・ビューに表示されます。

  3. アクションのリストで、削除したいアクションをクリックします。

  4. **「削除」**をクリックします。

    削除は即時に実行されます。 アクションを削除するかどうかの確認は求められません。

アクションに含めることができる変数

URL テンプレートで変数を指定して、外部サービスに情報を渡すことができます。

以下の変数がサポートされている：

$m.<metadata>
メタデータ変数はログで使用可能です。 例えば、 $m.applicationName または $m.timestamp などです。
$d.<key>.<subkey>
ログ内で使用可能なデータ。 例えば、$d.kubernetes.labels.my_label です。
$p.start_time
Unix、ミリ秒単位のエポックタイムスタンプとして選択された時間範囲の開始。
$p.end_time
Unix、ミリ秒単位のエポック・タイムスタンプとして選択された時間範囲の終わり。
$p.selected_value
UI でユーザーによって選択された値。 キーをクリックしてアクティブ化すると、キーの値全体が含まれます。

アクションの例

以下のアクションにより、Jira の問題が生成されます。

http://<company_name>.atlassian.net//secure/CreateIssueDetails!init.jspa?pid=<Jira_PID>&issuetype=<Jira_issueType>&description={{$d.logRecord.body}}&summary={{$d.msg}}