サポート zip ファイルの作成
プラットフォームについて: サーバーと Data Center のみ。この記事は、サーバーおよび Data Center プラットフォームのアトラシアン製品にのみ適用されます。
アトラシアン アプリケーションで問題が発生した場合、サポート zip を作成してアトラシアン株式会社に提供すると解決に役立つ場合があります。zip ファイルにはインスタンスのログ、診断および構成情報が含まれます。サポート zip は、ご利用のアプリケーションの構成内容をアトラシアン サポートが理解し、お客様の問題を解決するうえで役立ちます。サポート zip の提供は必須ではありませんが、アトラシアン サポートに有益な情報を提供します。
The Atlassian Troubleshooting and support tools app (add-on) simplifies the process of gathering your log and configuration files. It sanitizes any usernames and passwords it finds in your configuration files, but does not sanitise usernames and content present in the log files. It's bundled with all Atlassian products, and can also be downloaded from the Atlassian Marketplace.
このページの情報は、アトラシアンのトラブルシューティングとサポート ツールの最新バージョンに基づきます。ご利用のバージョンによっては外観が異なる場合がありますが、基本的な機能は同様となります。
サポート zip ファイルを作成する
Troubleshooting and Support Tools はアプリケーションの管理コンソールにあります。使用するには、管理者としてログインする必要があります。
- Bamboo の場合、
> [Overview] > [Support Tools] ([System] の配下) に移動します。 - For Bitbucket go to
> Administration > Troubleshooting and support tools (under Support)
For Bitbucket Mirror go to > Administration > Troubleshooting and support tools - [Mirror] (under Support) - Confluence の場合、 > [全般設定] > [トラブルシューティングとサポート ツール] ([管理] の配下) に移動します。
- Crowd (2.11 以降) の場合、 > [Support Tools] に移動します。
- Fisheye / Crucible の場合、 > [Administration] > ]Support Tools] ([System Settings] 配下) に移動します。
- Jira アプリケーションの場合、 > [システム] > [Troubleshooting and support tools] ([システム サポート] の配下) に移動します。
サポート zip を作成するには、[サポートZIPを作成する] タブに移動して [作成する] を選択します。
アプリケーションがクラスタ化されている場合、利用可能なすべてのクラスタ ノードが一覧表示されます。1 つのノードで zip を作成することも、複数のノードで作成することもできます。
- zip ファイルのコンテンツをカスタマイズします
- このノードで新しいサポート zip を作成します
- 作成された zip ファイルをダウンロードします
You can also create a support zip using the REST API. Find out how to do this in Server applications or Data Center applications.
zip ファイルのコンテンツをカスタマイズする
You can choose what to include in each support zip you create. By default, everything is included, except for thread dumps and access logs.
zip ファイルをカスタマイズするには、次の手順を実行します。
- [カスタマイズ] を選択します。
- zip に含めない項目の選択を解除します。
- [Save] を選択し、[作成する] をクリックします。
(Customize page from Confluence 8.2.0)
ここでの設定内容は、このセッション中に作成されるすべての zip に影響します (つまり、ここでの選択は複数のノードに影響します)。設定内容の保存や、次回の作成時の再利用は行われません。
Here's a summary of what is included in the support zip, which will vary slightly from product to product.
| 項目 | アプリケーション | 概要 |
|---|---|---|
アプリケーション プロパティ
| すべて | メモリの統計情報、システム設定、その他の構成内容が含まれます。この情報はすべてのサポート zip で必須です。 |
<アプリケーション> 環境設定ファイル
| すべて |
|
<アプリケーション> ログ
| すべて | ホーム ディレクトリに格納されているすべてのログが含まれます。 |
Tomcat 環境設定ファイル
| Bamboo |
|
Tomcat ログ
| Bamboo | catalina.out や GC ログなどの、インストール ディレクトリに保管されているログ ファイルが含まれます。 |
| Tomcat access logs | Bamboo | Includes HTTP Access logs from Tomcat's log folder. These are not included by default.
|
| コンソールの出力ログ | Fisheye | fisheye.out ログ ファイルが含まれます。 |
認証設定ファイル
| Bamboo | atlassian-user.xml、osuser.xml、crowd.properties などの認証設定ファイルが含まれます。 |
キャッシュ環境設定ファイル
| Confluence | すべてのキャッシュ環境設定プロパティ ファイルが含まれます。 |
ヘルス チェック
| Confluence | 前回のヘルス チェックの結果が含まれます。 |
Confluence のカスタマイズ
| Confluence | Velocity テンプレート、カスタム HTML、カスタム CSS が含まれます。 |
Synchrony 設定
| Confluence | synchrony-args.properties ファイルが含まれます。 |
| プラグイン環境設定ファイル | Crucible | プラグインの環境設定ファイルが含まれます。 |
| 変更済みファイル | Crucible | ローカルで変更されたすべてのファイルが含まれます。 |
プラグイン状態プロパティ
| Crucible | pluginstate.properties ファイルが含まれます。 |
スレッド ダンプ
| すべて | パフォーマンス分析のため、5 秒間隔で 3 つのスレッド ダンプを生成します。 このスレッド ダンプの生成処理には、すべての情報が含まれる可能性があります。ほかにも情報が必要な場合、サポート チームにより、外部でのスレッド ダンプの生成を依頼させていただく場合があります。 |
| ファイル サイズの制限 | すべて | ファイルのサイズを 25 Mb に制限します。これによってログ ファイルなどの容量の大きいファイルは切り捨てられます。 |
| Include runtime diagnostics data | Bitbucket | Includes data saved by the Java Flight Recorder (JFR) and extracted thread dumps. For more information on this, please refer to Diagnosing runtime issues using the Java Flight Recorder.
|
In Bitbucket, Access logs are included by default as part of Application Logs.Note: If you've changed the location of your log files, they will not be included when you generate a support zip. You'll need to attach your logs to any support requests manually.