サポート zip 解説 ～ Confluence 編～
- Hanayo Minamisawa [Ricksoft]
ここでは、Confluence から取得できるサポート zip について解説します。
サポート zip では現在の環境の構成内容の確認や、アプリケーションに不具合が起きたときの原因調査を行うことができます。
サポート zip の取得方法については以下のドキュメントをご参照ください。
目次
サポート zip ファイルの構成
サポート zip を展開すると、以下のようなフォルダとファイルの構成に分かれています。この他に、アプリ（アドオン）による設定ファイル・ログファイルが追加されることもあります。
| フォルダ名 | ファイル名 | 内容 |
|---|---|---|
| application-config | confluence.cfg.xml | データベース接続設定ファイル。 このファイルは通常、Confluence の新規インストールでセットアップウィザードを実行することで作成されます。
attachments.dir プロパティを設定することで、添付ファイルの保存場所の代替ディレクトリを指定できます。 |
| confluence-init.properties | Confluence のホームディレクトリの場所が記録されます。 Windows Linux / Solaris | |
| log4j.properties | ログ構成ファイル。 ログファイルの場所を変更したり、ログレベルを恒久的に変更することができます。
| |
| log4j-diagnostic.properties | 診断用ログ構成ファイル。 ログとプロファイルの作成 > Log4j ログ作成 で 診断用 を選択したときに利用するファイルです。 | |
| logging.properties | java.util.logging 用ログ構成ファイル。 Confluence によって使用される少数のライブラリは、log4j または slf4j ではなく、java.util.logging を使用します。該当するライブラリは以下のとおりです。
| |
| アプリケーション起動時のプログラムファイル。 | |
| web.xml | Web アプリケーションを動かすために関係する環境 (サーブレット、HTML ファイルなど) を設定するためのファイル。 セッションタイムアウト値は web.xml 内の以下の箇所で変更が可能です。 <session-config> <session-timeout>60</session-timeout> </session-config> | |
| application-logs | atlassian-confluence.log | Confluence アプリケーションログ。 |
| atlassian-diagnostics.log | Confluence 診断ログ。 これは現在 Atlassian で取り組んでいる、新しい診断情報に関係するものです。サイトに問題を引き起こす可能性があることがわかっている症状や動作を継続的に確認します。
| |
| atlassian-synchrony.log | 共同編集に関するログ。 | |
| application-properties | application.xml | 内部システムのパラメーターからサポート zip 用に生成した XML ファイル。 |
| auth-cfg | crowd.properties | Crowd と連携していると作成されるファイル。
|
| directoryConfigurationSummary.txt | ユーザーディレクトリ情報。 | |
| Seraph を構成するための xml ファイル。
| |
| confluence-customisations | layouts | サイトレイアウトの変更情報。 サイトレイアウトに変更が加えられている場合、変更されているデコレーターの vmd ファイルが格納されます。 |
| customHtml.txt | カスタム HTML の設定情報。 | |
| customStylesheet.txt | グローバル スタイルシートの設定情報。 | |
| healthchecks | healthcheckResults.txt | Confluence アプリケーションで行われているヘルスチェックの結果。
|
| synchrony-config | synchrony-args.properties | Synchrony システムプロパティファイル。 Confluence ホームディレクトリ内に作成されるファイルで、システム プロパティで提供されていない追加の引数を Synchrony の JVM へ直接渡す必要がある場合に、1行に1つずつ入力します。 property1=value1 property2=value2
|
| tomcat-config | catalina.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 コンテナに対してサードパーティの認証システムを連携する機能です。 | |
| logging.properties | Tomcat の起動、エラー、アクセスログの設定ファイル。 | |
server.xml | Tomcat の実行ポート番号、Apache の連携設定、バーチャルホスト設定など Tomcat の動作を決める主設定ファイル。 | |
| tomcat-users.xml | Tomcat Web アプリケーションマネージャー (http://localhost:8080/manager) の管理者アカウント管理用ファイル。
| |
| web.xml | サーブレット定義、セッション定義、認証設定、ウェルカム・エラーページ設定など Webアプリケーションの動作を規定する設定ファイル。 | |
| tomcat-logs | gc-<日時>.log.0.current | Confluence アプリケーションのパフォーマンス監視に使用できるガベージ コレクション (GC) が含まれます。ログの記述では、Java がガベージ コレクションを行うタイミング、このプロセスの所要時間、開放されたリソースの量を確認できます。このファイルは自動的に作成され、ファイルの最大数 (5) に到達すると上書きされます。タイムスタンプは、ログに関する Confluence セッションがいつ開始されたかを示します。
|
catalina.out | Tomcat の起動/停止ログ。 標準出力 (catalina.log の内容を含む)＋標準エラー出力を含みます。catalina.sh で設定します。 | |
catalina.<日時>.log | Tomcat の起動/停止ログ。 標準出力を記録します。logging.properties で設定します。 | |
host-manager.<日時>.log | ホスト共通の ServletContext#log。 logging.properties で設定します。 | |
| localhost.<日時>.log | manager webapp の ServletContext#log。 logging.properties で設定します。 | |
| manager.<日時>.log | host-manager webapp の ServletContext#log。 logging.properties で設定します。 | |
| synchrony-proxy-watchdog.log | synchrony-proxy が設定されているかを確認するログ。 <Confluence インストールディレクトリ>/conf/server.xml に synchrony-proxy の設定がされているかをチェックして、設定がない場合、設定を追加しています。 | |
| zip-stats.json | サポート zip ファイルの生成にかかった時間。 | |
atlassian-confluence.log の確認方法
Confluence アプリケーションのログが記録される atlassian-confluence.log を確認することで、アプリケーションでの不具合の原因を調べることができます。
ログレベルについては以下の通りです。FATAL が一番重大なエラーを表します。
| ログレベル | 内容 | |
|---|---|---|
 | DEBUG | アプリケーションのデバッグに最も役立つ細分化された情報イベント (何が起きているか) を指定します。 |
| INFO | システムの通常の稼働 (スケジュールされたジョブの実行、サービスの開始と停止、ユーザーがトリガーしたプロセスとアクション) に関するお知らせ。 |
 | WARN | システム自体のエラーではないのに、システムが最適水準を下回る状態で稼働していることを示している可能性がある状態。 |
| ERROR | システムで何らかの問題が生じたことを示す状態。 |
| FATAL | 重大な障害が発生したため、システムが復旧できない事を示す状態。 |
アプリケーションで不具合が起きたら、事象発生時刻付近の WARN 以上のログを検索します。
以下はログのサンプルです。
2021-01-17 11:04:09,598 WARN [http-nio-8090-exec-5] [common.security.jersey.XsrfResourceFilter] passesAdditionalBrowserChecks Additional XSRF checks failed for request: ricksoft-test/wiki/rest/api/content , origin: https://192.168.56.xxx , referrer: https://192.168.56.xxx/wiki/pages/createpage.action , credentials in request: true , allowed via CORS: false -- referer: https://192.168.56.xxx/wiki/pages/createpage.action?spaceKey=RICKMA&fromPageId=1000000 | url: /wiki/rest/api/content | traceId: 400709a8f4ca4206 | userName: <username>
ログの構成
ログは以下のような構成になっています。どのユーザーが何を実行したときに、何に関するエラーが発生したのかを大まかに確認することができます。
| 出力例 | 内容 |
|---|---|
| 2021-01-17 11:04:09,598 | タイムスタンプ |
| WARN | ログレベル |
| http-nio-8090-exec-5 | スレッド |
| [common.security.jersey.XsrfResourceFilter] | ロガー名 |
| url: | URL |
| userName: | ユーザー名 |
先程のサンプルで確認すると、
2021-01-17 11:04:09 頃、<username> が RICKMA スペースへのページの作成（https://192.168.56.xxx/wiki/pages/createpage.action?spaceKey=RICKMA&fromPageId=1000000）に関するリクエストを送ったときに発生したエラーのようです。
"Additional XSRF checks failed for request" とあり、Atlassian 社の ナレッジベース に記載されている事象に当てはまります。
アクセスした URL (ricksoft-test/wiki) と、返ってきた URL (https://192.168.56.xxx/wiki) が異なるため、この事象が発生しています。
ロガー名の後のメッセージなどで Google 検索して、トラブルシューティングを行うことができます。
リックソフト株式会社 は、日本でトップレベルのAtlassian Platinum Solution Partnerです。
大規模ユーザーへの対応実績が認められたEnterpriseの認定をうけ、高度なトレーニング要件をクリアし、小規模から大規模のお客様まで対応可能な実績を示したパートナー企業です。
Copyright © Ricksoft Co., Ltd. プライバシーポリシー お問い合わせ