Jira で webhook に失敗する問題のトラブルシューティングのためにデータを集める方法
プラットフォームについて: Server および Data Center のみ。この記事は、Server および Data Center プラットフォームのアトラシアン製品にのみ適用されます。
Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Fisheye および Crucible は除く
要約
Webhook がエラーを出さずに失敗することがあります。これには次のような原因が考えられます。
- リクエストが宛先に届かない
- リクエストが宛先に到達したが宛先でサポートされていない (例: サポートされないイベント)
- リクエストが宛先に到達したが予期せぬコンテンツだったために宛先で拒否された
このような場合は Webhook のデバッグを行うと同時に、Jira からの Webhook の受信有無やその方法を確認するためのテスト宛先をセットアップする必要があります。
環境
Jira Core 7.x と 8.x のすべてのバージョン
ソリューション
1) データを集める手順
Go to https://requestbin.com/ → Create a Request Bin → Copy the endpoint URL e.g. https://en6a8q2j1l64.x.pipedream.net
Make sure you uncheck Private (requires log in) before you hit the create button.問題が発生している Webhook と同じ設定 (JQL、イベント、本文を含めるかどうか) で新しい Webhook を作成し、Webhook の URL は上記のエンドポイント URL に設定します。
Jira Service Management の自動化の Webhook の場合、同じ設定 (空/Jira/カスタム ペイロード) で新しい Webhook を追加し、同じ THEN 条件を設定し、Webhook の URL を上記のエンドポイント URL に設定します。
[Jira 管理] > [システム] > [ロギングとプロファイリング] > [別のパッケージのロギング レベルを設定] に移動します
パッケージ名として com.atlassian.webhooks を入力し、ロギング レベルを DEBUG に設定して [追加] を選択します
- より詳細なログについては、パッケージ名として org.apache.http を入力し、ロギング レベルを DEBUG に設定して [Add] を選択します
- 「トラブルシューティングのために Jira ログをマークする」に従い、ログにマークしてレプリケーションの開始を示します。
Webhook をトリガーします (1 つのイベントで両方の Webhook をトリガーできるはずです)
リクエストが Request Bin ページ (エンドポイントの URL の提供元) に到達するかどうかを確認します
- ログを再びマークしてレプリケーションの終了を示します。
- パッケージのデバッグを無効化します (ロギング レベルを一時的に None に設定)
2) アトラシアン サポートにデータを送信する
次のデータをサポート チケットに添付します。
- Webhook の設定のスクリーンショット
- Jira のサポート zip
- Request Bin ページのリクエスト詳細のスクリーンショット
Jira Service Management の自動化の Webhook の場合は次の情報も添付してください。
- 自動化設定の完全なスクリーンショット
- 自動化のログ