Jira Service Management の管理者向けの利用開始ガイド
最初に、Jira Service Management の使用を開始する方法を確認します。
この記事では、Jira Service Management Cloud の一部のお客様に段階的に展開されている、Jira Service Management でネイティブに利用できる新しいアラート機能を取り上げています。ご利用のサイトにはまだ表示されていないか、利用できない可能性があります。
Splunk アラートは、特定のイベントの監視と応答に使用できます。アラートは、保存された検索を使用して、リアルタイムまたはスケジュールに従ってイベントを検索します。検索結果が特定の条件を満たすと、アラートがトリガーされます。アラート アクションは、アラートがトリガーされたときに応答するために使用できます。
Jira Service Management は Splunk との強力な双方向統合を提供します。Splunk の検索およびレポート・アプリでは、ユーザーはデータの検索、データ・モデルとピボットの作成、検索およびピボットのレポートとしての保存、アラートの設定、ダッシュボードの作成を行えます。Jira Service Management アラート・アプリを通じて、Splunk アラートを Jira Service Management に転送します。Splunk 統合において、Jira Service Management はこれらのアラートのディスパッチャーとして機能して、オンコール・スケジュールに基づいて通知する適切な担当者を決定します。メール、テキスト・メッセージ(SMS)、電話、iOS と Android のプッシュ通知によって通知し、アラートが確認されるかクローズされるまでアラートをエスカレートします。JEC(Jira Edge Connector)を通じて、Jira Service Management のアラートをイベントとして Splunk に転送し、追加のインデックス作成や検索を行うことができます。
Jira Service Management には、Splunk のアラートを Jira Service Management に送信する Splunk 専用のアラート・アプリがあります。Jira Service Management には Splunk 統合用の専用 API もあり、Splunk は Jira Service Management アラート・アプリを介して Jira Service Management にアラートを送信し、Jira Service Management はアラートの自動作成を処理します。
Jira Service Management アラートの Splunk イベントの作成が有効になっている場合、アラート固有のアクション(「アラートの作成」、「アラートの承認」など)が JEC を通じてイベントとして Splunk に送信されます。
Splunk は統合です。設定は次の手順で行います。
Jira Service Management に Splunk 統合を追加する
Splunk で統合を設定する
双方向統合は Free プランと Standard プランではサポートされていません。他のすべての統合は Free と Standard でチーム レベルでサポートされています。ただし、送信統合を機能させるには、上位のプランにアップグレードする必要があります。Settings (歯車アイコン) > Products (Jira 設定の下) > OPERATIONS からサイト レベルで統合を追加できるのは、Premium プランと Enterprise プランのみです。
統合をチームの運用ページから追加すると、そのチームが統合の所有者になります。つまり、Jira Service Management は、この統合を通じて受信したアラートをチームにのみ割り当てます。
Jira Service Management に Splunk 統合を追加するには、次の手順を実行します。
チームの運用ページに移動します。
左側のナビゲーション パネルで、[統合]、[統合を追加] の順に選択します。
検索を実行して「Splunk」を選択します。
次の画面で、統合の名前を入力します。
オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。
[続行] を選択します。
この時点で、統合が保存されます。
[統合を設定するステップ] セクションを展開して、API URL と API キーの両方をコピーします。
これらのキーは、後ほど Splunk で統合を設定する際に使用します。
[統合をオンにする] を選択します。
統合のために作成したルールは、統合をオンにした場合にのみ機能します。
Splunk で統合を設定するには、次の手順を実行します。
1. Splunkで、Splunkbase から Jira Service Management アプリをインストールします。
2. インストール後、「アプリ」に移動し、「セットアップ」を選択して Jira Service Management アプリを設定します。
3. 先ほど Jira Service Management からコピーした API URL と API キーを、それぞれ [JSM Base URL (JSM ベース URL)] と [API キー] に貼り付けます。
Splunk Cloud を使用していて、この手順で設定した API キーをアップデートする必要がある場合は、Splunk サポート・ケースを提出してアプリをアンインストールしてください。アプリのアンインストールの詳細をご確認ください。
4. Splunk で検索を実行して、アラートを作成します。
5. 「名前を付けて保存」を選択し、ドロップダウン リストから「アラート」を選択します。
6. アラートのタイトルを入力し、条件を指定します。
7. 「+アクションを追加」ボタンを選択してドロップダウン リストにアクセスし、「Jira Service Management」を選択します。
8. [保存] を選択します。
JEC(Jira Edge Connector)と Splunk スクリプトを使用して、Splunk のアラートをアップデートします。これによって、独自のスクリプトや機能をデプロイして提供された機能を変更し、カスタマイズしたアクションを Splunk 上で実行できます。Splunk 統合パッケージを使用するには、次のセクションで説明されている手順に従います。
パッケージをインストールします。
RedHat ベースのディストリビューションの場合
次のコマンドを実行します。rpm -i jsm-splunk-<your_version>.rpm
Debian ベースのディストリビューションの場合
次のコマンドを実行します。dpkg -i jsm-splunk-<your_version>.deb
Windows の場合
JEC パッケージを含む Jira Service Management 統合 zip ファイルをディレクトリ内に解凍します(C:\jsm\jec が推奨パス)。Windows への JEC のインストールに関する詳細をご確認ください。
JEC の実行に関する詳細をご確認ください。
Splunk でアクションを実行するために、JEC は設定ファイルから設定パラメーターを取得します。設定ファイルは、/home/jsm/jec/conf/config.json の下にあります。Windows の場合は C:\jsm\jec\conf\config.json です
Splunk 統合に JEC ユーティリティを使用するには、統合設定で「JEC 経由で送信」を使用します。JEC 経由での送信を選択する場合、Splunk に関する設定はオプションです。JEC 設定ファイルで設定できます。
Splunk Cloud を使用している場合、Jira Service Management はイベントを Splunk Cloud インスタンスに配信できます。「JEC 経由で送信」を選択しないでください。代わりに、Splunk Cloud の URL と Splunk トークンを対応するフィールドに入力します。Splunk Cloud の URL とポートを入力してください。
Splunk に管理者としてログインします。
ホーム ページから、[Add Data (データの追加)] を選択します。
ページの下部から、「モニター」を選択します。
データ入力オプションから、「HTTP イベント コレクター」を選択して新しいイベント・コレクターに名前を付けます。
必要がなければ、変更せずに残りの手順を完了します。最後の手順で、Splunk によって提供されたトークン値を書き留めます。
HTTP 経由のデータ入力を有効にするには、上部バーから「設定」>「データ入力」の順に選択し、「HTTP イベント コレクター」に移動します。その後、「グローバル設定」メニューで「すべてのトークン」が有効に設定されていることを確認します。
これでコレクターが設定されました。Jira Service Management がアラート関連のアクションを発行するたびに、Splunk がイベントを作成します。
Splunk でイベントを作成できるように、JEC は統合設定から設定パラメーターを取得します。
設定パラメーター | 説明 | 場所 |
---|---|---|
Splunk URL | ポートを含む Splunk HTTP イベント・コレクター・サーバーの URL。例:http://<splunk_server>: | /home/jsm/jec/conf/config.json |
Splunk トークン | Splunk HTTP イベント・コレクターのデータ入力のトークン | /home/jsm/jec/conf/config.json |
SSL の検証 | SSL 証明書の検証に失敗すると、Splunk サーバーへのリクエストが失敗することがあります。SSL 証明書を検証しないことを選択できます。既定は false です。 | /home/jsm/jec/conf/config.json |
JEC の実行方法についてはこちらをご確認ください。
以下の内容の結果フィールドは、検索条件に一致する行のフィールドによって異なります。そのため、Jira Service Management では利用可能なフィールドに結果オブジェクトの一般的なフィールドを提供します。一般的なフィールドの例には、Raw、Index、Serial、Source Type などがあります。
また、結果オブジェクトからカスタム フィールドを抽出できるようにするために、使用可能なフィールドに [結果オブジェクト] も追加しました。
たとえば、結果オブジェクトの date_month フィールドをアラートに配置するには、{{result.date_month}} で問題が解決されます。
アラートのペイロードを作成する
JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"session_key": "r41vK7psTN9iIp1HQXqgNxTHPz2AW_Ee3ELbdYM4FBqiBbI7L6f82o6f6IENt6Q_Xdq2V4jBSkjkyIfXIm56xbbcFcpWlcJNB0ZUZaezsImsTQ2lGWH26yiZ8l854Or8SPETrWuVgTKVeC",
"search_name": "fail",
"results_link": "http://Tuba-MacBook-Pro.local:8000/app/search/search?q=%7Cloadjob%20rt_scheduler__admin__search__fail_at_1464802733_32.0%20%7C%20head%201%20%7C%20tail%201&earliest=0&latest=now",
"app": "search",
"sid": "rt_scheduler__admin__search__fail_at_1464802733_32.0",
"configuration": {
"api_url": "http://4kmm916oxm9m.runscope.net"
},
"server_host": "Tuba-MacBook-Pro.local",
"owner": "admin",
"results_file": "/Applications/Splunk/var/run/splunk/dispatch/rt_scheduler__admin__search__fail_at_1464802733_32.0/per_result_alert/tmp_0.csv.gz",
"server_uri": "https://127.0.0.1:8089",
"result": {
"date_month": "may",
"index": "main",
"_indextime": "1464802756",
"date_minute": "15",
"date_hour": "0",
"splunk_server": "Tuba-MacBook-Pro.local",
"date_mday": "11",
"sourcetype": "secure",
"source": "tutorialdata copy 2.zip:./www1/secure.log",
"date_second": "2",
"_serial": "0",
"_sourcetype": "secure",
"date_year": "2016",
"eventtype": "",
"_kv": "1",
"timeendpos": "25",
"timestartpos": "4",
"linecount": "1",
"date_zone": "local",
"date_wday": "wednesday",
"punct": "____::__[]:________...___",
"_raw": "Thu May 11 2016 00:15:02 www1 sshd[4747]: Failed password for invalid user jabber from 118.142.68.222 port 3187 ssh2",
"_eventtype_color": "",
"_confstr": "source::tutorialdata copy 2.zip:./www1/secure.log|host::Tuba-MacBook-Pro.local|secure",
"_time": "1462914902",
"host": "Tuba-MacBook-Pro.local"
}
}
JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"alertDetails":{
},
"customerDomain":"jiraservicemannagement",
"alertId":"2ce35c31-a8e1-4be5-a781-110564a45e75-1568102450408",
"url":"http://localhost:8088",
"type":"Splunk",
"alert":{
"alertId":"2ce35c31-a8e1-4be5-a781-110564a45e75-1568102450408"
},
"source":null,
"token":"4c40855d-a361-4a9b-984f-0ab46c91a35f",
"params":{
"alertDetails":{
},
"customerDomain":"jiraservicemannagement",
"alertId":"2ce35c31-a8e1-4be5-a781-110564a45e75-1568102450408",
"source":null,
"url":"http://localhost:8088",
"integrationName":"Splunk",
"alert":{
"alertId":"2ce35c31-a8e1-4be5-a781-110564a45e75-1568102450408"
},
"integrationId":"c345dce0-50e3-4498-9433-1fddd3f4f1fd",
"token":"4c40855d-a361-4a9b-984f-0ab46c91a35f",
"integrationType":"Splunk",
"action":"Create",
"mappedActionV2":{
"extraField":"",
"name":"createEvent"
},
"type":"Splunk",
"customerId":"5035e5cd-4791-4995-9154-037027f8e0b6"
},
"action":"Create",
"mappedActionV2":{
"extraField":"",
"name":"createEvent"
},
"integrationId":"c345dce0-50e3-4498-9433-1fddd3f4f1fd",
"integrationType":"Splunk",
"integrationName":"Splunk",
"customerId":"5035e5cd-4791-4995-9154-037027f8e0b6"
}
この内容はお役に立ちましたか?