WorkflowのWebhookでリッチな通知を作成する

Published 2022년 7월 22일 8분 소요

TL;DR 押さえるポイントはこれ！

新しい通知機能のWorkflowのWebhookでもNRQLのFACETで取得するタグ情報が利用できる！
タグの取得方法:
{{#each accumulations.tag}}{{#eq "タグ名" @key}}{{this.[0]}}{{/eq}}{{/each}}
現状この技が使えるのはWebhookのみ

はじめに

New Relicでは、柔軟なエスカレーションを実現するためにWorkflowという機能を提供しています。SlackやJira、Service NowなどIssueを通知、管理するためのサービスと簡単に連携でき、監視業務を充実させることができます。

WorkflowにはEnrichmentという情報を追加するための機能もありますが、追加データは画像に限定されています（2022/7/22現在）

「もっと自由に整形したい！」「Slackでメンションしたい！」という時にはWebhookを使いましょう。もっと柔軟な通知ができるようになります。

前提条件

NRQLを用いて作成するアラートが対象です
ライセンスキーやユーザーキーなどの説明はしません
参考として、Slackへの通知を取り扱います
ユーザーキーを作成しておいてください。

確認ステップ

お試し用のアラートを作成し、どのような通知を作ることができるか確認しましょう。

アラートポリシーの作成
確認用のデータ作成
ワークフローの作成

1. アラートポリシーの作成

サクッと作りたいので、お試し用のアラートポリシーと条件をGraphQLを使って作成したいと思います。

ユーザーキーを作成している前提です。こちらのリンクをクリックしてください。

赤くなっているアカウントIDを正しく入力し、三角ボタンで実行しましょう。以下のようなレスポンスが返ってきます。レスポンスで返ってきたIDは後ほど利用するのでコピーしてください。

次に、こちらのリンクをクリックしてください。

赤くなっているアカウントIDを入力し、先ほどレスポンスで返ってきたIDをポリシーIDに入力し、実行します。

エラーとなっていなければ成功です。

New Relicのポリシー画面を確認してみましょう。

https://one.newrelic.com/nrai/alerts-classic/policies

リッチ通知テストポリシーがConditionsの数１で作成されていれば成功です。

2. 確認用のデータ作成

このアラートが動くことを確認しましょう。以下のcurlコマンドを利用してください。ライセンスキーとアカウントIDを書き換えて、実行しましょう。他のアトリビュートも変更いただいても大丈夫です。

authoridは後ほどslackのメンションで利用します。実際のauthoridに書き変えておいてください。

curl -H 'Content-Type: application/json' -H 'API-Key: ライセンスキー' https://insights-collector.newrelic.com/v1/accounts/アカウントID/events -d '[{"eventType": "TestEvent", "title": "テストアラート", "body": "*テスト* アラートです", "state": "published", "author": "Azumax", "authorid": "tazuma", "date": "2022-07-22"}]'

Open incidentが１となったら成功です。

3. ワークフローの作成

ポリシーのNotification settingsのタブを開き、Create workflowボタンをクリックしてください。

ここで、Webhookを選択します。

Slack用のWebhook URLを登録します。

Payload templateに以下の設定をコピペします。

{
	"blocks": [
		{
			"type": "header",
			"text": {
				"type": "plain_text",
				"text": "{{#each accumulations.tag}}{{#eq "title" @key}}{{this.[0]}}{{/eq}}{{/each}}",
				"emoji": true
			}
		},
		{
			"type": "section",
			"text": {
				"type": "plain_text",
				"emoji": true,
				"text": "Author: {{#each accumulations.tag}}{{#eq "author" @key}}{{this.[0]}}{{/eq}}{{/each}} <@{{#each accumulations.tag}}{{#eq "authorid" @key}}{{this.[0]}}{{/eq}}{{/each}}>"
			}
		},
		{
			"type": "section",
			"fields": [
				{
					"type": "mrkdwn",
					"text": "{{#each accumulations.tag}}{{#eq "body" @key}}{{this.[0]}}{{/eq}}{{/each}}\n<https://docs.newrelic.com/jp/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/|ワークフロー>"
				}
			]
		}
	]
}

設定を保存します。

冒頭にも書きましたが、このペイロードで見るポイントは、

{{#each accumulations.tag}}{{#eq "title" @key}}{{this.[0]}}{{/eq}}{{/each}}

このような書き方をしているところです。例えばこれは、アラートのNRQLを設定したときにFACETしていたtitleを引っ張ってくる記法です。

改めてテストデータを流してみましょう。以下のようにSlackに通知が来れば成功です。

まとめ

単にアラートが発砲されたことを知るだけでなく、デザインを変えるだけで、利便性の向上や、「よし見よう！」というモチベーションにもつながってきます。

このWebhookで使える技を利用して、効果的な監視業務を行いましょう！

다음 단계

サインアップ

東卓弥, Principal Technical Account Manager

New Relic プリンシパルテクニカルアカウントマネージャー。ERPパッケージベンダーにてSaaS製品を開発。SREも担当し運用自動化に励む。その後総合系コンサルティングファームに転職し、BtoCサービスの構築支援としてモバイルアプリを主としたサービスの開発リーダーを担当。アーキテクチャの設計からCICD、バックエンド・フロントエンド開発という全領域の開発に加え、SREで経験した運用も踏まえたアプリケーションを中心としたパフォーマンス管理・チューニングを得意とする。業務上経験が多いのはJava、Javascript。

이 블로그에 표현된 견해는 저자의 견해이며 반드시 New Relic의 견해를 반영하는 것은 아닙니다. 저자가 제공하는 모든 솔루션은 환경에 따라 다르며 New Relic에서 제공하는 상용 솔루션이나 지원의 일부가 아닙니다. 이 블로그 게시물과 관련된 질문 및 지원이 필요한 경우 Explorers Hub(discuss.newrelic.com)에서만 참여하십시오. 이 블로그에는 타사 사이트의 콘텐츠에 대한 링크가 포함될 수 있습니다. 이러한 링크를 제공함으로써 New Relic은 해당 사이트에서 사용할 수 있는 정보, 보기 또는 제품을 채택, 보증, 승인 또는 보증하지 않습니다.

WorkflowのWebhookでリッチな通知を作成する

780+ 개 통합을 사용해 무료로 스택 모니터링

모든 통합 보기

In this article

WorkflowのWebhookでリッチな通知を作成する

TL;DR 押さえるポイントはこれ！

はじめに

前提条件

確認ステップ

1. アラートポリシーの作成

2. 確認用のデータ作成

3. ワークフローの作成

まとめ

다음 단계

Tags

관련