Confluence がダウンしているときにコマンド ラインからサポート zip を作成する方法
プラットフォームについて: 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 は除く
要約
Confluence の web インターフェイスで UI が適切に動作しておらず、サポート zip の生成や取得が困難である場合、Confluence またはシステム管理者は、Confluence ノードが実行されているサーバーにログインし、ログおよび構成ファイルを手動で取得する必要があります。このソリューションはこのようなプロセスを促進するため、ログ/データ検索を自動化し、サポート zip が提供している構造と同じものを利用したパッケージ化などのメリットを提供します。
環境と要件
このソリューションは次の要素を持つ Linux ベースのオペレーティング システムで実行できます。
/bin/bash
zip や gzip のアプリケーション
管理者は次のことが行える必要があります。
オペレーティング システムのコマンド ライン インターフェイスの利用
- Confluence のホームおよびインストール フォルダの読み取り権限を持つオペレーティング システム ユーザーの利用 (root または Confluence user が推奨)
Confluence Home と Confluence Application フォルダの認識
注意: 複数のノードを持つ Confluence Data Center をご利用の場合、スクリプトは各ノードで個別に実行する必要があります。
スクリプトとその用途
以降では、スクリプト、利用方法、期待される出力をまとめています。
スクリプト
ファイル: supportzip_connie.sh
用途
# ./supportzip_connie.sh -h
Usage: ./supportzip_connie.sh [-h <Confluence home path>] [-a <Confluence app path>] -t
-h: obligatory, absolute path of Confluence home directory
-a: obligatory, absolute path of Confluence application directory
-t: optional, to run and collect thread dumps
The support.zip file will be placed at <confluence-home>/export.
Output
# ./supportzip_connie.sh -h /opt/atlassian/confluence/confluence-home -a /opt/atlassian/confluence/atlassian-confluence-7.13.4
__ ------------------------------------------
_(\ |@@| | Beep - Generating Atlassian Support Zip |
(__/\__ \--/ __ /_------------------------------------------
\___|----| | __
\ }{ /\ )_ / _\
/\__/\ \__O (__
(--/\--) \__/
_)( )(_
`------`
##############################
# Atlassian support zip tool #
##############################
User = confluence
Confluence Home = /opt/atlassian/confluence/confluence-home
Confluence App Directory = /opt/atlassian/confluence/atlassian-confluence-7.13.4
Hit CTRL+C (10s wait) if any path or user is incorrect.
- Packing application logs
cp: /opt/atlassian/confluence/confluence-home/logs/support is a directory (not copied).
- Packing application config files
- Packing configuration summary, if any available
- Packing the last directoryConfigurationSummary available.
- Packing seraph and crowd configuration files
- Packing confluence customisations files
cp: /opt/atlassian/confluence/confluence-home/logs/support/customHtml.txt}: No such file or directory
cp: /opt/atlassian/confluence/confluence-home/logs/support/customStylesheet.txt}: No such file or directory
- Packing custom layouts files
- Packing synchrony configuration file
- Packing cache configuration files
cp: /cache-settings-overrides.properties: No such file or directory
- Packing tomcat configuration files
- Packing healthcheckResults, if any available
- Packing Tomcat logs
- Packing the application.xml, if any available
- Thread dump will not be collected
Creating zip file...
The support zip file can be found in /opt/atlassian/confluence/confluence-home/export/Confluence_support_2022-05-19-14-07-25.zip, please upload this file to Atlassian.
.
Have a g'day =)
Zip ファイルの構造 (テスト環境の例。ご利用の環境では異なる可能性があります)
Confluence_support_2022-05-19-14-07-25
├── application-config
│ ├── confluence-init.properties
│ ├── confluence.cfg.xml
│ ├── log4j-diagnostic.properties
│ ├── log4j.properties
│ ├── logging.properties
│ ├── setclasspath-bat.txt
│ ├── setclasspath-sh.txt
│ ├── setenv-bat.txt
│ ├── setenv-sh.txt
│ ├── shutdown-bat.txt
│ ├── shutdown-sh.txt
│ ├── start-confluence-bat.txt
│ ├── start-confluence-sh.txt
│ ├── startup-bat.txt
│ ├── startup-sh.txt
│ ├── stop-confluence-bat.txt
│ ├── stop-confluence-sh.txt
│ └── web.xml
├── application-logs
│ ├── atlassian-confluence-index.log
│ ├── atlassian-confluence-index.log.1
│ ├── atlassian-confluence-jmx.log
│ ├── atlassian-confluence-outgoing-mail.log
│ ├── atlassian-confluence-profiler.log
│ ├── atlassian-confluence-security.log
│ ├── atlassian-confluence-sql.log
│ ├── atlassian-confluence.log
│ ├── atlassian-confluence.log.1
│ ├── atlassian-confluence.log.2
│ ├── atlassian-confluence.log.3
│ ├── atlassian-confluence.log.4
│ ├── atlassian-confluence.log.5
│ ├── atlassian-diagnostics.log
│ ├── atlassian-synchrony.log
│ └── atlassian-synchrony.log.1
├── application-properties
│ └── application.xml
├── auth-cfg
│ ├── May-16.directoryConfigurationSummary.txt
│ ├── crowd.properties
│ ├── seraph-config.xml
│ └── seraph-paths.xml
├── cache-cfg
├── confluence-customisations
│ └── layouts
│ ├── Space FirsSpace customised layout - decorators-main.vmd
│ ├── Space FirsSpace customised layout - decorators-page.vmd
│ ├── Space FirsSpace customised layout - decorators-space.vmd
│ └── customLayouts.txt
├── healthchecks
│ └── healthcheckResults.txt
├── synchrony-config
│ └── synchrony-args.properties
├── thread-dump
├── tomcat-config
│ ├── catalina.policy
│ ├── catalina.properties
│ ├── context.xml
│ ├── jaspic-providers.xml
│ ├── logging.properties
│ ├── server.xml
│ ├── tomcat-users.xml
│ └── web.xml
└── tomcat-logs
├── atlassian-synchrony-proxy.log
├── catalina.2022-04-01.log
├── catalina.2022-04-04.log
├── catalina.2022-04-05.log
├── catalina.2022-04-06.log
├── catalina.2022-04-07.log
├── catalina.2022-04-09.log
├── catalina.2022-04-11.log
├── catalina.2022-04-17.log
├── catalina.2022-04-18.log
├── catalina.2022-04-25.log
├── catalina.2022-04-29.log
├── catalina.2022-05-02.log
├── catalina.2022-05-04.log
├── catalina.2022-05-05.log
├── catalina.2022-05-06.log
├── catalina.2022-05-07.log
├── catalina.2022-05-11.log
├── catalina.2022-05-16.log
├── catalina.2022-05-18.log
├── catalina.out
├── conf_access_log.2022-04-19.log
├── conf_access_log.2022-04-20.log
├── conf_access_log.2022-04-21.log
├── conf_access_log.2022-04-22.log
├── conf_access_log.2022-04-23.log
├── conf_access_log.2022-04-24.log
├── conf_access_log.2022-04-25.log
├── conf_access_log.2022-04-29.log
├── conf_access_log.2022-05-02.log
├── conf_access_log.2022-05-03.log
├── conf_access_log.2022-05-04.log
├── conf_access_log.2022-05-05.log
├── conf_access_log.2022-05-06.log
├── conf_access_log.2022-05-07.log
├── conf_access_log.2022-05-08.log
├── conf_access_log.2022-05-09.log
├── conf_access_log.2022-05-10.log
├── conf_access_log.2022-05-11.log
├── conf_access_log.2022-05-12.log
├── conf_access_log.2022-05-13.log
├── conf_access_log.2022-05-14.log
├── conf_access_log.2022-05-15.log
├── conf_access_log.2022-05-16.log
├── conf_access_log.2022-05-17.log
├── conf_access_log.2022-05-18.log
├── conf_access_log.2022-05-19.log
├── gc-2022-04-01_14-54-55.log.0.current
├── gc-2022-04-01_15-00-44.log.0.current
├── gc-2022-04-01_15-28-07.log.0.current
├── gc-2022-04-01_15-41-19.log.0.current
├── gc-2022-04-01_15-46-34.log.0.current
├── gc-2022-04-01_16-06-19.log.0.current
├── gc-2022-04-01_16-12-43.log.0.current
├── gc-2022-04-04_16-25-35.log.0.current
├── gc-2022-04-04_16-32-47.log.0.current
├── gc-2022-04-04_16-47-57.log.0.current
├── gc-2022-04-09_22-25-36.log.0.current
├── gc-2022-04-17_12-27-43.log.0.current
├── gc-2022-04-25_15-09-12.log.0.current
├── gc-2022-04-25_15-34-24.log.0.current
├── gc-2022-04-25_15-44-24.log.0.current
├── gc-2022-04-25_17-34-47.log.0.current
├── gc-2022-04-29_14-19-27.log.0.current
├── gc-2022-04-29_14-53-42.log.0.current
├── gc-2022-05-02_13-49-00.log.0.current
├── gc-2022-05-02_14-06-16.log.0.current
├── gc-2022-05-16_12-05-26.log.0.current
├── host-manager.2022-04-01.log
├── host-manager.2022-04-04.log
├── host-manager.2022-04-09.log
├── host-manager.2022-04-17.log
├── host-manager.2022-04-25.log
├── host-manager.2022-04-29.log
├── host-manager.2022-05-02.log
├── host-manager.2022-05-16.log
├── localhost.2022-04-01.log
├── localhost.2022-04-04.log
├── localhost.2022-04-09.log
├── localhost.2022-04-17.log
├── localhost.2022-04-25.log
├── localhost.2022-04-29.log
├── localhost.2022-05-02.log
├── localhost.2022-05-16.log
├── manager.2022-04-01.log
├── manager.2022-04-04.log
├── manager.2022-04-09.log
├── manager.2022-04-17.log
├── manager.2022-04-25.log
├── manager.2022-04-29.log
├── manager.2022-05-02.log
├── manager.2022-05-16.log
└── synchrony-proxy-watchdog.log
また、より詳細な出力を含むログが <confluence-home>/export に作成されます。
その他
- このソリューションは UI のサポート zip を代替するものではありません。
- confluence.cfg.xml、directoryConfigurationSummary (ディレクトリ) および server.xml/tomcat-users.xml (tomcat 構成) ではユーザー名とパスワードが匿名化されます。