サポート zip 解説 ～ Jira 編～

Owned by Hanayo Minamisawa [Ricksoft]
2022/04/10

ここでは、Jira から取得できるサポート zip について解説します。
サポート zip では現在の環境の構成内容の確認や、アプリケーションに不具合が起きたときの原因調査を行うことができます。

サポート zip の取得方法については以下のドキュメントをご参照ください。

目次

サポート zip ファイルの構成

サポート zip を展開すると、以下のようなフォルダとファイルの構成に分かれています。この他に、アプリ（アドオン）による設定ファイル・ログファイルが追加されることもあります。

フォルダ名ファイル名内容
application-configdbconfig.xml

データベース接続設定ファイル。
このファイルは通常、Jira の新規インストールで Jira セットアップウィザードを実行するか、Jira 設定ツール を使用してデータベース接続を設定することで作成されます。データベース接続のチューニングは Jira 設定ツール でも行えますが、直接 dbconfig.xml を修正することでも反映されます。

(情報)参考ドキュメント：データベース接続のチューニング

entityengine.xml

Jira が永続的データをデータベースに保存する際に利用する、パラメータが定義されているファイル。

jira-config.properties

カスタム値が格納されているファイル。
Jira の 詳細設定 オプションのうち、データベースに保存されていないカスタム値が格納されます。
このファイルで定義されているプロパティは、Jira アプリケーションインストールディレクトリに保存されている jpm.xml ファイルで定義されている既定値よりも優先されます。

新しい Jira インストールの場合、初期段階ではこのファイルは存在しないことがあります。その場合は、手動で作成する必要があります。このファイルは通常、詳細設定オプションで既定値からのカスタマイズが行われた、バージョン 4.3 以前からアップグレードした Jira インストールに存在します。

(情報)参考ドキュメント：高度な Jira 設定

log4j.properties

ログ構成ファイル。
ログファイルの場所を変更したり、ログレベルを恒久的に変更することができます。

(情報)参考ドキュメント：ロギングとプロファイリング

application-logs


atlassian-greenhopper.logJira Software のボード・カンバン機能に関するログ。
atlassian-jira.logJira アプリケーションログ。
atlassian-jira-apdex.log

Apdex メトリックログ。
Apdex メトリックをチェックして、Jira サーバーとデータセンターのパフォーマンスを監視できます。メトリックは1時間ごとに収集されます。

(情報)参考ドキュメント：How to monitor Jira performance with Apdex（英語）

atlassian-jira-incoming-mail.log

受信メールログ。

受信メールサーバーを設定している場合に存在します。既定ではエラーログのみ記録され、管理画面 > システム > ログとプロファイルの作成 でデバッグを有効にすることが可能です。

atlassian-jira-outgoing-mail.log

送信メールログ。

送信メールサーバーを設定している場合に存在します。既定ではエラーログのみ記録され、管理画面 > システム > ログとプロファイルの作成 でデバッグを有効にすることが可能です。

atlassian-jira-security.log

セキュリティ関連ログ。
ログイン、ログアウト、セッション作成 / 破棄、セキュリティ拒否などが書き込まれます。

atlassian-jira-slow-queries.log

スロークエリログ。

400 ミリ秒以上かかる JQL クエリが実行された場合に書き込まれます。

 サンプル
2016-11-21 09:08:49,068
http-nio-8080-exec-16 INFO username 548x103721x5 11nnyad /url/ [issue.search.providers.LuceneSearchProvider_SLOW] JQL query '{filter in ("Release actual ")} ' produced lucene query redacted_query' and took '561' ms to run.


Timestamp thread? type? Username log_id ??? url query_info query duration
atlassian-servicedesk.logJira Service Desk に関するログ。
jira-diagnostics.log

Jira 診断ログ。

これは現在 Atlassian で取り組んでいる、新しい診断情報に関係するものです。最初のステップとして、JQL に関する追加情報が書き込まれます。複雑な JQL、重い JQL、および遅い JQL は、Jira の安定性に影響を与えることがもっとも多い要素の 1 つです。この診断情報は問題のある JQL を素早く検出し、ダウンタイムを回避するのに役立ちます。現時点では、これらのメッセージに対するアクションは不要です。

今後の Jira リリースでしきい値を微調整し、この診断情報に対応した UI を提供する予定です。

atlassian-jira-perf.logパフォーマンス診断についてのログ。
application-propertiesapplication.xml

内部システムのパラメーターからサポート zip 用に生成した XML ファイル。
Jira の システム情報 ページの データベース統計 セクションには、インスタンスのデータ情報が表示されますが、同様の情報がapplication.xml に出力されます。

 サンプル

<database-statistics>
<Attachments>0</Attachments>
<Comments>0</Comments>
<Components>3</Components>
<Custom-Fields>12</Custom-Fields>
<Groups>6</Groups>
<Issue-Security-Levels>0</Issue-Security-Levels>
<Issue-Types>11</Issue-Types>
<Issues>3</Issues>
<Priorities>5</Priorities>
<Projects>4</Projects>
<Resolutions>4</Resolutions>
<Screen-Schemes>11</Screen-Schemes>
<Screens>30</Screens>
<Statuses>10</Statuses>
<Users>1</Users>
<Versions>2</Versions>
<Workflows>5</Workflows>
</database-statistics>

auth-cfgcrowd.properties

Crowd と連携していると作成されるファイル。
(情報)参考ドキュメント：crowd.propertiesファイル


directoryConfigurationSummary.txtユーザーディレクトリ情報。
cache-cfgcache.propertiesアプリケーションのキャッシュ設定に関するファイル。
oscache.propertiesアプリケーションのキャッシュの振る舞いに関する設定ファイル。
healthcheckshealthcheckResults.txt

Jira アプリケーションで行われているヘルスチェックの結果。

(情報)参考ドキュメント：インスタンスの健全性

tomcat-configcatalina.policy

Tomcat の起動時のオプション (catalina.bat run -security) で起動するセキュリティ・マネージャーが管理する Java に対するセキュリティ制御の設定ファイル。
本設定ファイルを設定することで悪意のある applet 、サーバーサイド Java のプログラムの抑制を行います。

catalina.properties

Tomcat に特化したプロパティファイル。
サーバーサイド Java から System.getProperty ("ファイル内で定義された値") で取得可能です。

context.xml

Tomcat の各アプリケーション(コンテキスト)の動作を設定するファイル。
server.xml の設定を上書きして適用されます。

jaspic-providers.xml

JavaTM Authentication Service Provider Interface for Containers 用の設定ファイル。
Web コンテナに対してサードパーティの認証システムを連携する機能です。
例えば Google OAuth を利用して Google アカウント所有者のみシステムを利用可能とする場合には、本設定ファイルに Google OAuth の設定を明記し、lib 配下に対応する jar ファイルを格納します。
デフォルトでは、何も指定されていません。

logging.propertiesTomcat の起動、エラー、アクセスログの設定ファイル。
server.xml

Tomcat の実行ポート番号、Apache の連携設定、バーチャルホスト設定など Tomcat の動作を決める主設定ファイル。

tomcat-users.xmlTomcat Web アプリケーションマネージャー (http://localhost:8080/manager) の管理者アカウント管理用ファイル。
web.xml

サーブレット定義、セッション定義、認証設定、ウェルカム・エラーページ設定など Webアプリケーションの動作を規定する設定ファイル。

tomcat-logsatlassian-jira-gc-<日時>.log.0.current

Jira アプリケーションのパフォーマンス監視に使用できるガベージ コレクション (GC) が含まれます。ログの記述では、Java がガベージ コレクションを行うタイミング、このプロセスの所要時間、開放されたリソースの量を確認できます。このファイルは自動的に作成され、ファイルの最大数 (5) に到達すると上書きされます。タイムスタンプは、ログに関する Jira セッションがいつ開始されたかを示します。

(情報)参考ドキュメント：

catalina.out

Tomcat の起動/停止ログ。
標準出力(catalina.logの内容を含む)＋標準エラー出力を含みます。catalina.sh で設定します。

catalina.<日時>.log

Tomcat の起動/停止ログ。
標準出力を記録します。logging.properties で設定します。

host-manager.<日時>.log

ホスト共通の ServletContext#log。
logging.properties で設定します。

localhost.<日時>.logmanager webapp の ServletContext#log。
logging.properties で設定します。
manager.<日時>.loghost-manager webapp の ServletContext#log。
logging.properties で設定します。

zip-stats.jsonサポートzip ファイルの生成にかかった時間。


atlassian-jira.log の確認方法

Jira アプリケーションログが記録される atlassian-jira.log を確認することで、アプリケーションでの不具合の原因を調べることができます。

ログレベルについては以下の通りです。FATAL が一番重大なエラーを表します。


ログレベル内容
(情報)TRACEDEBUG よりもさらに詳細なログを出力します。
(情報)DEBUGアプリケーションのデバッグに最も役立つ細分化された情報イベント (何が起きているか) を指定します。
(情報)INFOシステムの通常の稼働 (スケジュールされたジョブの実行、サービスの開始と停止、ユーザーがトリガーしたプロセスとアクション) に関するお知らせ。
(警告)WARNシステム自体のエラーではないのに、システムが最適水準を下回る状態で稼働していることを示している可能性がある状態。
(警告)ERRORシステムで何らかの問題が生じたことを示す状態。
(警告)FATAL重大な障害が発生したため、システムが復旧できない事を示す状態。

TRACE ログレベルは Confluence では使用できません。


アプリケーションで不具合が起きたら、事象発生時刻付近の WARN 以上のログを検索します。


以下は ERROR ログのサンプルです。

2020-05-14 14:03:53,978+0900 https-jsse-nio-8443-exec-19 ERROR xxxxxxx 843x11312x1 w3lrg1 yyyyyyy /secure/ [c.a.g.r.internal.http.HttpClientFetcher] Unable to perform a request to: <Jira base URL>/rest/gadgets/1.0/g/messagebundle/und/gadget.common%2Cgadget.issuetable%2Cgadget.assignedtome%2Cgadget.issuetable.common
javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

ログの構成

ログは以下のような構成になっています。どのユーザーが何を実行したときに、何に関するエラーが発生したのかを大まかに確認することができます。

出力例内容
2016-11-21 09:08:49,068タイムスタンプ
http-nio-8080-exec-16スレッド
INFOログレベル
usernameユーザー名
548x103721x5jira.request.id
11nnyadjira.request.assession.id
/url/URL
[issue.search.providers.LuceneSearchProvider_SLOW]ロガー名


先程のサンプルで確認すると、
2020-05-14 14:03:53 頃、<username> が gadgets に関するリクエストを送ったときに発生したエラーのようです。
"SSLHandshakeException" とあり、Atlassian 社の ナレッジベース に記載されている事象に当てはまります。

2020-05-14 14:03:53,978+0900 https-jsse-nio-8443-exec-19 ERROR <username> 843x11312x1 w3lrg1 xxxxxxxx /secure/ [c.a.g.r.internal.http.HttpClientFetcher] Unable to perform a request to: <Jira base URL>/rest/gadgets/1.0/g/messagebundle/und/gadget.common%2Cgadget.issuetable%2Cgadget.assignedtome%2Cgadget.issuetable.common
javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target


ロガー名の後のメッセージなどで Google 検索して、トラブルシューティングを行うことができます。





リックソフト株式会社 は、日本でトップレベルのAtlassian Platinum Solution Partnerです。
大規模ユーザーへの対応実績が認められたEnterpriseの認定をうけ、高度なトレーニング要件をクリアし、小規模から大規模のお客様まで対応可能な実績を示したパートナー企業です。

Copyright © Ricksoft Co., Ltd. プライバシーポリシー お問い合わせ