New Relicで検知したアラートは、メールやSlack、Jira、PagerDuty 等に連携することができます。今回はアラートの情報を Jira へ連携する際の Tips を紹介します。
今回のポイント
この記事で紹介しているポイントは、次の２つです。
-
アラートの情報をカスタマイズする方法を知る
通知するアラートの詳細情報をカスタマイズして連携する方法を紹介します。 -
Jira連携でアラート内のURLをリンクとして認識させる方法がわかる
デフォルトで連携すると文字列そして認識される URL を Jira 上でリンクとして認識させる方法を紹介します。
最新のアップデートの詳細はこちら
New Relic アップデート一覧
無料のアカウントで試してみよう！
New Relic フリープランで始めるオブザーバビリティ！
アラート情報のカスタマイズ方法
New Relic で検知したアラートの通知先や通知情報の設定は、New Relic Alerts の Workflows で設定が可能です。詳細な設定の手順はこちらのブログを参考にしてください。
Workflow の設定で通知メッセージのカスタマイズで使用するのが通知メッセージのテンプレートです。カスタマイズできるのは大きく2点で、アラートに関連している情報を設定できる変数と条件に合わせて表示内容を切り替えたり、値を置き換えたりできるヘルパー機能があります。
Workflowで利用できる変数は、下記のドキュメントをご確認ください。
変数とヘルパー機能を使ったカスタマイズの例としてアラートが発生した時刻を指定したタイムゾーンで表示する方法があります。こちらの記事で詳細を紹介しているので参考にしてください。
Jira連携でアラート内のURLをリンクとして認識させる方法
問題点
New Relic と Jira の連携は、アラートの通知先としてあらかじめ用意されているため設定は簡単でメッセージテンプレートを使ったカスタマイズにも対応しています。しかし、連携した Issue URL の情報を Jira 上で確認すると文字列で認識されてしまい、リンクとして機能しないためアラートの詳細ページへ飛ぶことができません。これは、Issue URL 限らず、Runbook の URL でも発生する問題です。
解決策
Jira の機能を使った簡単な解決策があるため今回はその方法を紹介します。それはカスタムフィールドを使う方法です。使用できる標準のカスタムフィールドの中に URL フィールド というタイプがあり、設定された URL をリンクとして表示してくれます。
実践
Jira の設定_カスタムフィールドの作成
まず前述のカスタムフィールドを作成していきます。設定から課題を選択し、表示された画面の左側のメニューにあるフィールドからカスタムフィールドを選択します。
表示された画面でカスタムフィールドを作成を選択して新しいカスタムフィールドを作成します。
フィールドタイプは、前述の通りURLフィールドを選択します。
フィールド名と説明を入力してカスタムフィールドの作成は完了です。
作成したカスタムフィールドをどの画面に表示するのか選択する必要があります。表示する画面にチェックをつけて更新してください。
Jira の設定_カスタムフィールドの配置
カスタムフィールドの配置は、下記のように変更が可能です。使いやすい位置に配置してください。
Jira側の設定はこれで完了です。
New Relic の設定
New Relic のメッセージテンプレートで新しく追加したカスタムフィールドに対してURLがマッピングされるように設定していきます。Jira の Workflow 設定画面でメッセージテンプレートの編集を行います。デフォルトでは説明のみが表示されていますが、+ Add another field で連携するフィールドを新しく追加できます。ここでJiraで作成したカスタムフィールド(Issue URL)を選択します。
今回は追加した Issue URL に変数 {{issuePageUrl}} を設定してテスト実行を行います。
画面右下の Send test notification からテスト送信が可能です。
確認
では連携された内容を Jira の画面上で確認してみましょう。下記のように説明に記載していたURLはリンクとして任視されていませんが、 Issue URL のカスタムフィールドではリンクとして表示されています。これでクリックするだけで New Relic の Issue 詳細画面を開くことができるようになりました。
最後に
New Relic で検知したアラートを管理して対応していくことはシステムの運用上大変重要です。通知内容をカスタマイズしたJira等のツールの設定を見直すことでより運用効率を向上させることができます。小さなストレスを減らしてチーム全体の対応力を向上させていきましょう。
New Relicでは、新しい機能やその活用方法について、QiitaやXで発信しています！
無料でアカウント作成も可能なのでぜひお試しください！
New Relic株式会社のX(旧Twitter) や Qiita OrganizationOrganizationでは、
新機能を含む活用方法を公開していますので、ぜひフォローをお願いします。
無料のアカウントで試してみよう！
New Relic フリープランで始めるオブザーバビリティ！