[FAQ] Jira Server / Data Center で Webhook が正常にポストされているかのログを確認したい

[#1]

よくあるお問い合わせ

Q. Jira Server / Data Center で Webhook の機能を利用しています。Webhook が正常に実行されたか、または失敗しているか、及び期待通りのパラメータでポストされているかどうか、確認する方法を教えてください。

解決策・回答

A. 大変恐縮ながら、2023/11/29時点での Jira Server / Data Center において、Webhook の履歴をGUI上で確認する機能は提供されておりません。下記の機能リクエストが起案されておりますが、まだ実現されておりません。

JRASERVER-41463 Webhook logging for JIRA

リンク先にて Vote for this issue(この課題に投票) していただくと機能が実現する可能性が高くなります。よろしければご検討ください

また、上記の機能リクエスト内に Workaround（回避策） として、Webhookの関連クラスのデバッグログを有効化し、アプリケーションログ上で確認する方法が紹介されております。

・Webhook 関連のデバッグログの有効化する方法

ロギングとプロファイリング 内の “ログ レベルを一時的に変更する“ の記載のように、一時的に特定のパッケージのログレベルを変更することが可能です。手順は下記になります。

1.Jiraシステム管理画面 ＞ システム ＞ ログとプロファイルの作成
2.パッケージ "com.atlassian.webhooks" を、既定のロガー "別のパッケージのログ レベルを設定する" からログレベル DEBUG に追加

上記のデバッグログ設定を行うと、Jiraアプリケーションログ atlassian-jira.log に下記のような Webhook のログが出力されるようになり、Webhook がポストされていることが確認可能です（下記のサンプルログはJRASERVER-41463 Webhook logging for JIRA に記載を引用しています）。

2021-04-09 09:50:10,432+1000 Web-Hook-Publisher-1 DEBUG admin 590x289x1 19qeghr 127.0.0.1 /rest/api/2/issue/SCR-5/comment [c.a.webhooks.plugin.PublishTaskFactoryImpl$PublishTaskImpl] Posting to web hook at 'https://webhook.site/testwebhook, body is:
SNIP_JSON_BODY_HERE

2021-04-09 09:50:12,039+1000 httpclient-callbacks:thread-1 DEBUG anonymous [c.a.webhooks.plugin.PublishTaskFactoryImpl$PublishTaskImpl] WebHook successfully sent

特に “WebHook successfully sent“ の記載が Webhook のポストに成功したことを示すログになります。この出力が確認出来ていない場合、対象のURLに対しての Webhook のポストが成功していない可能性がございます。

また、Webhook に関するトラブルシューティングのドキュメントがございますので、こちらもご活用いただけますと幸いです。

Jira で webhook に失敗する問題のトラブルシューティングのためにデータを集める方法

※本記事は Jira Data Center v9.4.12 の環境にて検証を行っています。