Statuspage と統合する
この記事では、Jira Service Management Cloud の一部のお客様に段階的に展開されている、Jira Service Management でネイティブに利用できる新しいアラート機能を取り上げています。ご利用のサイトにはまだ表示されていないか、利用できない可能性があります。
統合でできるようになること
Statuspage によってサービス・プロバイダーは、サービスの個別のインフラストラクチャまたは機能部分ごとにコンポーネントを追加できます。Jira Service Management は Statuspage との強力な双方向統合を提供します。統合は次のように使用されます。
Statuspage は、インシデントのアップデート時に Webhook 通知を送信します。Statuspage の統合では、新しいインシデントごとに Jira Service Management でアラートが作成され、インシデントのすべてのアップデートが既存のアラートにメモとして追加されます。Jira Service Management はこれらのアラートのディスパッチャーとして機能し、オンコール スケジュールに基づいて通知すべき担当者を決定します。メール、テキスト・メッセージ（SMS）、電話、iOS や Android のプッシュ通知による通知を行い、アラートが承認またはクローズされるまでアラートをエスカレートします。
Jira Service Management アクションが「インシデントを作成する」または「インシデントを作成し、タグに従ってコンポーネント/インシデントのステータスをアップデートする」Statuspage アクションにマップされている場合、Jira Service Management は Statuspage にインシデントを作成します。
Jira Service Management アクションが「インシデントを解決する」または「インシデントを解決し、タグに従ってコンポーネントのステータスをアップデートする」Statuspage アクションにマップされている場合、Jira Service Management は Statuspage でインシデントを解決します。Jira Service Management アクションが「インシデントにメモを追加する」Statuspage アクションにマップされている場合、Jira Service Management は Statuspage のインシデントをアップデートします。
統合による機能
Statuspage でインシデントが作成されると、Jira Service Management で自動的にアラートが作成されます。
Statuspage でインシデントがクローズされると、Jira Service Management で関連するアラートが自動的にクローズされます。
統合をセットアップする
Statuspage は双方向の統合です。設定は次の手順で行います。
Jira Service Management で Statuspage 統合を追加する
アラート アクションをマッピングする
Statuspage で統合を設定する
Statuspage の統合を追加する
双方向統合は Free プランと Standard プランではサポートされていません。他のすべての統合は Free と Standard でチーム レベルでサポートされています。ただし、送信統合を機能させるには、上位のプランにアップグレードする必要があります。Settings (歯車アイコン) > Products (Jira 設定の下) > OPERATIONS からサイト レベルで統合を追加できるのは、Premium プランと Enterprise プランのみです。
統合をチームの運用ページから追加すると、そのチームが統合の所有者になります。つまり、Jira Service Management は、この統合を通じて受信したアラートをチームにのみ割り当てます。
Jira Service Management で Statuspage 統合を追加するには、次の手順を実行します。
チームの運用ページに移動します。
左側のナビゲーション パネルで、[統合] > [統合を追加] の順に選択します。
検索を実行して「Statuspage」を選択します。
次の画面で、統合の名前を入力します。
オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。
[Continue] を選択します。
この時点で、統合が保存されます。[統合を設定する手順] セクションを展開して、API URL をコピーします。
このキーは、後ほど Statuspage で統合を設定する際に使用します。[統合をオンにする] を選択します。
統合のために作成したルールは、統合をオンにした場合にのみ機能します。
Statuspage で統合を設定する
Statuspage と Jira Service Management の統合を設定するには、次の手順に従います。
[Subscribers (登録者)] インターフェイスで、[Options (オプション)] > [Settings (設定)] と選択します。
[Subscriber Notification Settings (登録者通知設定)] モーダルで、[Delivery types (配信タイプ)] に「Webhook」を選択します。
[変更を保存] を選択します。
ステータス ページに移動し、[Subscribe To Updates (アップデート通知へのサブスクライブ)] をクリックします。
登録のドロップダウンから [Webhook] タブを選択します。
さきほどコピーした URL を [URL] に貼り付けます。
API エンドポイントが失敗した場合にメールを受信するためのメール アドレスを入力します。
[Subscribe To Notifications (通知へのサブスクライブ)] を選択します。
Statuspage をアップデートするように統合を設定する
Statuspage をアップデートして戻すように統合を構成するには、次の手順を実行します。
Statuspage の画面の左下にあるアバターを選択します。
メニューから [API Info (API 情報)] を選択します。
インテグレーションを機能させるページのページ ID をコピーします。
Jira Service Management に戻り、Statuspage の統合ページに移動します。
必要に応じて、[Send Alert Updates Back to Statuspage（アラートのアップデートを Statuspage に送信）] または [Create Statuspage Incidents for Jira Service ManagementAlerts（Jira Service Management アラートの Statuspage インシデントを作成）] のチェックボックスを選択します。
このページ ID を [Statuspage Page Id (Statuspage ページ ID)] フィールドに貼り付けます。
さきほどコピーした API キーを [Statuspage API Key（Statuspage API キー）] に貼り付けます。
アラート フィルターを使用して、Statuspage に送信するアラートの種類を制御します。
統合を保存します。
Jira Service Management は、保存時に Statuspage を使用して設定を検証しようとします。
アラート アクションをマッピングする
Jira Service Management では、Jira Service Management アクションと StatusPage アクション間のアクション・マッピングを定義できます。
[Send alert updates back to Statuspage（アラートのアップデートを Statuspage に送信）] が選択されている場合、選択したアクションが Jira Service Management で実行されると、Statuspage のアクションが Statuspage で実行されます。
[Create Statuspage Incidents for Jira Service Management alerts（Jira Service Management アラートの Statuspage インシデントを作成）] が選択されている場合、Statuspage の統合以外のソースを持つアラートに対して選択したアクションが Jira Service Management で実行される際に、Statuspage に対するアクションが実行されます。
「追加されたタグに従ってコンポーネント/インシデントのステータスをアップデートする」Statuspage アクションが「アラートにタグが追加される」Jira Service Management アクションにマップされている場合、特別にフォーマットされたタグがアラートに追加されると、Statuspage 内のコンポーネント/インシデントのステータスが、指定されたステータスに変更されます。
「インシデントを解決し、タグに従ってコンポーネントのステータスをアップデートする」Statuspage アクションが Jira Service Management アクションにマップされている場合、タグで指定されたコンポーネントのステータスは、該当する場合には operational に変更されます。
Statuspage で作成されたアラートの場合
[アラートのアップデートを Statuspage に送信] セクションで、アラートのソースが Statuspage になっている場合（つまり、アラートが Statuspage の統合によって作成される場合）は、Jira Service Management のアクションを Statuspage のアクションにマップします。
Jira Service Management アクションを Statuspage アクションにマップします。たとえば、Jira Service Management アラートにメモが追加されたときに Statuspage インシデントをアップデートします。これを行うには、[アラートのアップデートを Statuspage に送信] セクションで、「Jira Service Management でアラートにメモが追加された場合は、Statuspage でインシデントにメモを追加する」というマッピングを定義します。
その他の Jira Service Management アラートの場合
[Jira Service Management アラートの Statuspage インシデントの作成] セクションで、アラートのソースが Statuspage ではない場合（つまり、アラートが別の統合によって作成された場合）に Jira Service Management アクションを Statuspage アクションにマッピングします。
1 つの Jira Service Management アクションを「インシデントを作成する」または「インシデントを作成し、タグに従ってコンポーネント/インシデントのステータスをアップデートする」Statuspage アクションにマップします。Jira Service Management アクションは「アラートが作成される」である必要はなく、その他のアクションにも設定できます。
「アラートにタグが追加される」アクションと「アラートでカスタム アクションが実行される」アクションは他のアクションと異なります。これらのアクションのいずれかを選択すると、このマッピングが機能するタグまたはカスタム アクションを入力するための追加のフィールドが表示されます。
タグをコンマで区切って、複数のタグを入力します。複数のタグを入力した場合、マッピングは、アラートが指定されたタグを 1 つ以上持っている場合に機能します。タグのフィールドを空のままにすると、どのタグでもマッピングが機能します。
カスタム マッピングのカスタム アクションの名前を指定します。空のままにすることはできません。
1 つの Jira Service Management アクションが複数の Statuspage アクションにマッピングされている場合、「アラートにタグが追加される」アクションと「アラートでカスタム アクションが実行される」アクションを除いて、エラーが発生します。これらのアクションは、指定されたタグ名やカスタム アクション名によって異なるため、複数のマッピングを保存します。
アラート タグを使用したコンポーネント/インシデント ステータスの変更
アラートに特別にフォーマットされたタグを追加して、Statuspage でコンポーネント/インシデントのステータスを変更します。
タグは、アラートの作成中または作成後に追加できます。Jira Service Management アクションが「インシデントを作成し、タグに従ってコンポーネント/インシデントのステータスをアップデートする」Statuspage アクションにマップされている場合、Jira Service Management で特別にフォーマットされたタグを含むアラートが作成されると、Statuspage でインシデントが作成され、コンポーネントおよびインシデントのステータスが特別にフォーマットされたタグに従って変更されます。または、「アラートにタグが追加される」アクションが「追加されたタグに従ってコンポーネント/インシデントのステータスをアップデートする」Statuspage アクションにマップされている場合、Jira Service Management で特別にフォーマットされたタグがアラートに追加されると、コンポーネント/インシデントのステータスが追加されたタグに従って変更されます。
コンポーネント名を使用するには:
タグの書式を cmp_ [コンポーネント名]:[ステータス] のようにします。[コンポーネント名] は、ステータスを変更するコンポーネントの名前です。例: cmp_API:degraded_performance。コンポーネント ID を使用するには:
タグの書式を cmpid_ [コンポーネント ID]:[ステータス] のようにします。[コンポーネント ID] は、ステータスを変更するコンポーネントの ID です。例: cmpid_componentId1:degraded_performance。[ステータス] は、コンポーネントに許可されるステータスの 1 つです。これらの許可されたステータスは、「許可されているコンポーネント ステータス」の下に一覧されています。
許可されているコンポーネントステータス
運用
degraded_performance
partial_outage
major_outage
許可されているインシデントステータス
investigating
identified
監視
resolved
例
cmp_API:degraded_performance
cmp_Database Server:partial_outage
cmp_Management Portal:operational
inc:monitoring
inc:identified
Statuspage から送信されるペイロードのサンプル
JSON
{
"meta":
{
"unsubscribe": "https://jsmtest.statuspage.io/?unsubscribe=8rx45n6txwh3",
"documentation": "http://doers.statuspage.io/customer-notifications/webhooks/"
},
"page":
{
"id": "1k9dvd5q1qlv",
"status_indicator": "none",
"status_description": "All Systems Operational"
},
"incident":
{
"name": "incident1",
"status": "investigating",
"created_at": "2015-10-08T13:13:53.303Z",
"updated_at": "2015-10-08T13:13:53.558Z",
"monitoring_at": null,
"resolved_at": null,
"impact": "none",
"shortlink": "http://stspg.io/1Z1G",
"postmortem_ignored": false,
"postmortem_body": null,
"postmortem_body_last_updated_at": null,
"postmortem_published_at": null,
"postmortem_notified_subscribers": false,
"postmortem_notified_twitter": false,
"backfilled": false,
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_reminded_at": null,
"impact_override": null,
"scheduled_auto_in_progress": false,
"scheduled_auto_completed": false,
"id": "hk801ps7x9x4",
"page_id": "1k9dvd5q1qlv",
"incident_updates":
[
{
"status": "investigating",
"body": "this is a test incident",
"created_at": "2015-10-08T13:13:53.556Z",
"wants_twitter_update": false,
"twitter_updated_at": null,
"updated_at": "2015-10-08T13:13:53.556Z",
"display_at": "2015-10-08T13:13:53.556Z",
"id": "7m0y35xlqh8j",
"incident_id": "hk801ps7x9x4"
}
]
}
}
この内容はお役に立ちましたか?