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 creates an incident in Statuspage if an Jira Service Management action is mapped to a create an incident or create incident and update the components'/incident's statuses according to tags Statuspage action.
Jira Service Management resolves incidents in Statuspage if an Jira Service Management action is mapped to a resolve the incident or resolve the incident and update the components' statuses according to tags Statuspage action. Jira Service Management updates the incident in Statuspage if a Jira Service Management action is mapped to an add note to the incident Statuspage action.
統合による機能
Statuspage でインシデントが作成されると、Jira Service Management で自動的にアラートが作成されます。
Statuspage でインシデントがクローズされると、Jira Service Management で関連するアラートが自動的にクローズされます。
統合をセットアップする
Statuspage は双方向の統合です。設定は次の手順で行います。
Jira Service Management で Statuspage 統合を追加する
アラート アクションをマッピングする
Statuspage で統合を設定する
Statuspage の統合を追加する
Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings
(gear icon) > Products
(under JIRA SETTINGS) > OPERATIONS
, you need to be either on Premium or 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 内のコンポーネント/インシデントのステータスが、指定されたステータスに変更されます。
The statuses of the components given in the tags are changed to Operational when applicable if a resolve incident and update components' statuses according to tags Statuspage action is mapped to a Jira Service Management action.
Statuspage で作成されたアラートの場合
Map Jira Service Management actions to Statuspage actions when the source of the alert is StatusPage (that is, the alert is created by StatusPage integration) in the Send alert updates back to Statuspage section.
Map Jira Service Management actions to Statuspage actions. For example, update the Statuspage incident when a note is added to the Jira Service Management alert. To do this, define If a note is added to the alert in Jira Service Management, add note to the incident to the incident in Statuspage mapping in Send alert updates back to Statuspage section.
その他の Jira Service Management アラートの場合
Map Jira Service Management actions to Statuspage actions when the source of the alert is NOT Statuspage (that is when the alert is created by another integration) in the Create Statuspage Incidents for Jira Service Management Alerts section.
Map one Jira Service Management action to create an incident or create an incident and update the components'/incident's statuses according to tags Statuspage action. The Jira Service Management action doesn't have to be alert is created; it can be other actions as well.
a tag is added to the alert and a custom action is executed on alert actions differ from the other actions. When either action is selected, an extra field appears to enter which tags or for which custom action this mapping works.
タグをコンマで区切って、複数のタグを入力します。複数のタグを入力した場合、マッピングは、アラートが指定されたタグを 1 つ以上持っている場合に機能します。タグのフィールドを空のままにすると、どのタグでもマッピングが機能します。
カスタム マッピングのカスタム アクションの名前を指定します。空のままにすることはできません。
For mapping a Jira Service Management action to multiple Statuspage actions, an error occurs except for the a tag is added to the alert and a custom action is executed on alert actions. Save multiple mappings for these actions because they differ by the given tags and the given custom action names.
アラート タグを使用したコンポーネント/インシデント ステータスの変更
アラートに特別にフォーマットされたタグを追加して、Statuspage でコンポーネント/インシデントのステータスを変更します。
You can add tags while creating the alert or after. If a Jira Service Management action is mapped to create an incident and update the components'/incident's statuses according to tags Statuspage action, when an alert with specially formatted tags is created in Jira Service Management, an incident is created in Statuspage and the statuses of the components and the incident are changed according to the specially formatted tags. Or if a tag is added to the alert action is mapped to update the components'/incident's statuses according to added tags Statuspage action, when a specially formatted tag is added to the alert in Jira Service Management, the statuses of the components/incident is changed according to the added tags.
To use component name:
Format the tags as cmp_[component name]:[status] where [component name] is the name of the component to have a status change. For example, cmp_API:degraded_performance.To use component id:
Format the tags as cmpid_[component id]:[status] where [component id] is the id of the component to have a status change. For example, 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"
}
]
}
}
この内容はお役に立ちましたか?