Atlassian サポート ツール の使い方
- Hanayo Minamisawa [Ricksoft]
はじめに
弊社ヘルプデスクにお問い合わせいただいたときに、ログファイルをお送りくださいとお願いさせていただくことがあります。
Atlassian 製品には、ログファイルをはじめサポートに必要な情報を収集するための Atlassian サポート ツールが用意されています。これを利用すると必要な情報を簡単に用意できます。
ここでは、製品別に Atlassian サポート ツールの使い方をご説明します。
Jira
Atlassian サポート ツール (JIRA6.4以降）
Jira に管理者ユーザーとしてログインし、管理画面を開きます。
Jira トップバー歯車アイコンから、「システム」→「トラブルシューティングとサポートツール」を選択してください。
Atlassian サポート ツール画面が開きます。画面右側のタブから「サポートZipを作成」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのアイテムを含め、ファイルサイズの制限はしないでください。
画面下側の「ZIPを作成」ボタンをクリックすると、チェックのついたファイルを含む ZIP ファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
この ZIP ファイルをヘルプデスクの課題に添付してください。 「別のZIPを作成」ボタンをクリックすると、「サポートZipを作成」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux(JIRA) | (データディレクトリ)/log/atlassian-jira.log |
|---|---|
| Linux(catalina) | (プログラムディレクトリ)/logs/catalina.out |
| Windows(JIRA) | (データディレクトリ)\log\atlassian-jira.log |
| Windows(catalina) | (プログラムディレクトリ)\logs\catalina.yyyy-mm-dd.log |
Confluence
Atlassian サポート ツール (Confluence 5.7以降）
ご参考
Atlassian サポート ツールをご利用いただけるのは、Confluence 3.1以降です。これよりも前のバージョンをお使いの場合は、手動でログファイルを収集してください。
バージョンにより、イメージに違いがございますので、ご了承ください。
Confluence に管理者ユーザーとしてログインし、管理画面を開きます。
画面左側のメニューの一番下、「管理」→「トラブルシューティングとサポートツール」を選択します。
Atlassian サポート ツールが開きます。画面上部のタブから「サポートZIPを作成する」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのファイルを含め、ファイルサイズの制限はしないでください。
画面下側の「zipを作成する」ボタンをクリックすると、チェックのついたファイルを含む ZIP ファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
このファイルをヘルプデスクの課題に添付してください。 「新たなZIPを作成する」ボタンをクリックすると、「サポートZIPを作成する」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux | (データディレクトリ)/logs/atlassian-confluence.log |
|---|---|
| Windows | (データディレクトリ)\logs\atlassian-confluence.log |
Fisheye
Atlassian サポート ツール (Fisheye2.1以降）
Fisheye に管理者ユーザーとしてログインし、管理画面を開きます。画面左側のメニューの一番下、「System Settings」→「Troubleshooting and support tools」を選択します。
Atlassian サポート ツールが開きます。画面右側のタブから「Create support zip」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのファイルを含め、ファイルサイズの制限はしないでください。
画面下側の「Create zip」ボタンをクリックすると、チェックのついたファイルを含むZIPファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
このファイルをヘルプデスクの課題に添付してください。 「Create another zip」ボタンをクリックすると、「Create support zip」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux | (データディレクトリ)/var/log/fisheye.out |
|---|---|
| Windows | (データディレクトリ)\var\log\fisheye-debug-yyyy-mm-dd.log |
Bitbucket (Stash)
Atlassian サポートツール
Bitbucket (Stash) に管理者ユーザーとしてログインし、管理画面を開きます。
画面上のメニューから、「サポート」→「トラブルシューティングとサポートツール」を選択します。
Atlassian サポート ツールが開きます。画面右側のタブから「サポートzipを作成」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのファイルを含め、ファイルサイズの制限はしないでください。
画面下側の「zipを生成する」ボタンをクリックすると、チェックのついたファイルを含む ZIP ファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
このファイルをヘルプデスクの課題に添付してください。 「別のzipを生成する」ボタンをクリックすると、「サポートzipを作成」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux | (データディレクトリ)/log/atlassian-bitbucket.log |
|---|---|
| Windows | (データディレクトリ)\log\atlassian-bitbucket.log |
Bamboo
Atlassian サポートツール
Bamboo に管理者としてログインします。
Bamboo トップバー 歯車アイコンから管理画面を開き、
左側に表示されるメニューの一番下にある「Troubleshooting and support tools」をクリックします。
Atlassian サポート ツールが開きます。画面右側のタブから「Create support zip」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのファイルを含め、ファイルサイズの制限はしないでください。
画面下側の「Create zip」ボタンをクリックすると、チェックのついたファイルを含む ZIP ファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
このファイルをヘルプデスクの課題に添付してください。 「Create another zip」ボタンをクリックすると、「Create support zip」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux | (データディレクトリ)/logs/atlassian-bamboo.log |
|---|---|
| Windows | (データディレクトリ)\log\atlassian-bamboo.log |
Crowd
Atlassian サポートツール
Crowd に管理者としてログインします。画面右上の歯車アイコンから「Troubleshooting and support tools」を選択し、管理画面を開き、
表示されたタブの中で、「Create support zip」を選択します。
Atlassian サポート ツールが開きます。画面右側のタブから「Create support zip」を選択します。
ZIP ファイルに含めるファイルをチェックボックスで選択できます。
通常はすべてのファイルを含め、ファイルサイズの制限はしないでください。
画面下側の「Create zip」ボタンをクリックすると、チェックのついたファイルを含む ZIP ファイルが作成されます。
ZIP ファイルができあがると、ファイルが格納されたサーバー上のパスが表示されます(下の画面の赤枠の部分)。
「Support Tool Plugin Ver. 3.9.4」以降の support tool plugin をご利用の場合は、画面上からサポート ZIP ファイルのダウンロードが可能です。
このファイルをヘルプデスクの課題に添付してください。 「Create another zip」ボタンをクリックすると、「Create support zip」の最初の画面に戻ります。
手動でログを収集する
Atlassian サポート ツールを利用できないときは、以下のファイルをヘルプデスクの課題に添付してください。
| Linux | (データディレクトリ)/logs/atlassian-crowd.log |
|---|---|
| Windows | (データディレクトリ)\log\atlassian-crowd.log
|
Gliffy
Gliffy は、Web ブラウザからネットワーク図、フロアレイアウト、フローチャートや、UML などのダイアグラムを編集することができるツールで、Confluence と Jira にアドオンできるプラグインも提供されています。Gliffy の特徴については弊社のホームページをご参照ください。
Confluence でログを収集する
Gliffy をプラグインとして追加しても、標準設定のままでは Gliffy の動作ログは出力されていません。Confluence の設定を変更して、Gliffy のログが出力されるようにする必要があります。
Confluenceの 管理画面を開き、左下の方に表示されている「管理」の「ログとプロファイルの作成」を選択します。
「ログとプロファイルの作成」画面が開くので「Log4j ログ作成」の「新規エントリの追加」に Gliffy のログを収集するための設定を行います。「クラス／パッケージ名」に「com.gliffy」、「新しいレベル」を「DEBUG」にして「エントリの追加」ボタンをクリックします。
ご参考
クラス／パッケージ名は Java のパッケージ名、新しいレベルは log4j のログレベルを指定します。
既存のレベルリストに新しい設定が追加されたことを確認してください。
ご注意ください
ここで追加したログの設定は、Confluence またはサーバーを再起動すると破棄されます。
Gliffy のログは、/var/atlassian/application-data/confluence/logs/atlassian-confluence.log にその他の Confluence のログと一緒に出力されます。以下は出力されたログの例です。
2012-10-31 09:48:18,758 DEBUG [http-8090-6] [plugin.confluence.util.Html5Helper] display Request Type=VIEWER
2012-10-31 09:48:18,762 DEBUG [http-8090-6] [plugin.confluence.util.Html5Helper] isUnsupportedBrowser User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.94 Safari/537.4
2012-10-31 09:48:18,768 DEBUG [http-8090-6] [plugin.confluence.util.Html5Helper] isUnsupportedBrowser browser=CHROME version=22
2012-10-31 09:48:18,774 DEBUG [http-8090-6] [plugin.confluence.macro.GliffyMacro] isOutputType pageContext outputType=display
2012-10-31 09:48:18,778 DEBUG [http-8090-6] [plugin.confluence.macro.GliffyMacro] isHtml5Capable isDisplayContext=true
2012-10-31 09:48:18,779 DEBUG [http-8090-6] [plugin.confluence.macro.GliffyMacro] renderTemplate Rendering template=templates/html/gliffy-macro-html5-200.html.vm
2012-10-31 09:48:18,786 DEBUG [http-8090-6] [plugin.confluence.macro.GliffyMacro] renderTemplate Macro output:
<span id="gliffy-container-1802241-6177"
class="gliffy-container"
data-fullwidth="340"
data-ceoid="1409028"
data-filename="BasicFlowchart">
<span class="gliffy-chrome " style="display:none;">
<span class="gliffy-item gliffy-first">
<img class="gliffy-logo" src="/confluence/download/resources/com.gliffy.integration.confluence:gliffy-macro-key/icons/gliffy-logo-20px.png" title="Gliffy" alt="Gliffy" />
Gliffy </span>
<span class="gliffy-item gliffy-start-button">
<a href="/confluence/plugins/gliffy/launchGliffyHtml5.action?name=BasicFlowchart&ceoid=1409028&key=FREE&lastPage=%2Fpages%2Fviewpage.action%3FpageId%3D1409028&pageId=1409028&inline=false" target="">
<span>
<img src="/confluence/download/resources/com.gliffy.integration.confluence:gliffy-macro-key/icons/gliffy_macro_icon_edit.png" class="gliffy-icon-edit" alt="Edit" title="Edit" />
Edit </span>
</a>
</span>
<span class="gliffy-item gliffy-zoom gliffy-end-button ">
<a href="/confluence/download/attachments/1409028/BasicFlowchart.png?version=1&modificationDate=1351644338090" target="_self">
<span>
<img src="/confluence/download/resources/com.gliffy.integration.confluence:gliffy-macro-key/icons/gliffy_macro_icon_zoom.png" class="gliffy-icon-full" alt="Zoom" title="Zoom" />
Zoom </span>
</a>
</span>
</span>
<iframe class="gliffy-html5-container" id="gliffy-html5-1802241-6177" src="/confluence/plugins/gliffy/viewer.action" width="340" height="630" data-id="1802241" data-scale="1.0" frameborder="0" style="position:relative;overflow:hidden;background:#FFFFFF;"></iframe>
<img class="gliffy-container-icon" src="/confluence/download/resources/com.gliffy.integration.confluence:gliffy-macro-key/icons/gliffy-logo-20px.png" title="Gliffy" alt="Gliffy" />
<span class="gliffy-error-fallback">
<map id="gliffy-map-1802241-9072" name="gliffy-map-1802241-9072"/>
<img id="gliffy-image-1802241-6177"
class="gliffy-image "
width="340"
height="630"
data-full-width="340"
data-full-height="630"
src="/confluence/download/attachments/1409028/BasicFlowchart.png?version=1&modificationDate=1351644338090"
usemap="#gliffy-map-1802241-9072"
/>
<map id="gliffy-dynamic-map-1802241-6177" class="gliffy-dynamic" name="gliffy-dynamic-map-1802241-6177"></map>
</span>
</span>
ヘルプデスクの課題にログファイルを添付していただける際にサイズが大きいときは、問題が発生したと思われる時間帯前後のログを抜き出して貼り付けてください。
ご参考
Gliffy のログを収集する必要がなくなったときは、既存のレベルリストの「Remove」リンクをクリックして設定を削除してください。または、Confluence またはサーバーを再起動したときにログ収集は終了します。
Jira でログを収集する
Gliffy をプラグインとして追加しても、標準設定のままでは Gliffy の動作ログは出力されていません。Jira の設定を変更して、Gliffy のログが出力されるようにする必要があります。
Jira の管理画面を開き、「システム」の「ログとプロファイルの作成」を選択します。
「トラブルシューティングとサポート」ページが開くので、画面の下の方にある「既定のロガー」の「別のパッケージのログレベルを設定する」リンクをクリックします。
「別のパッケージのログレベルを設定する」ダイアログが開くので、パッケージ名の単位でログを収集したい機能とそのレベルを指定します。今回は Gliffy のログを収集したいので、「パッケージ名」に「com.gliffy」、「ログレベル」に「DEBUG」を指定して「追加」ボタンをクリックします。
ご参考
パッケージ名は Java のパッケージ名、ログレベルは log4j のログレベルを指定します。
「トラブルシューティングとサポート」の画面に戻りますので、「既定のロガー」のリストに「com.gliffy」の行が追加されており、ログレベルが「DEBUG」に設定されていることを確認してください。
ご注意ください
ここで追加したログの設定は、Jira またはサーバーを再起動すると破棄されます。
Gliffy のログは、/var/atlassian/application-data/jira/log/atlassian-jira.log にその他の Jira のログと一緒に出力されます。以下は出力されたログの例です。
2012-10-31 10:47:36,812 http-8080-8 DEBUG admin 647x2417x8 r2jih9 192.168.235.1,192.168.235.170 /plugins/servlet/gliffyapi/clientresource [gliffy.core.clientapi.ClientAPIServlet]
Method: GET
Request path: /jira/plugins/servlet/gliffyapi/clientresource
Action: class com.gliffy.core.clientapi.action.ClientResourceAction
Request params:
'package' = 'com.gliffy.symbols.basic'
'name' = 'symbol-definition.xml'
'__lzbc__' = '1351648057422'
QueryString: package=com.gliffy.symbols.basic&name=symbol-definition.xml&__lzbc__=1351648057422
UserAgent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.94 Safari/537.4
IP: 192.168.235.170
2012-10-31 10:47:36,815 http-8080-6 DEBUG admin 647x2416x7 r2jih9 192.168.235.1,192.168.235.170 /plugins/servlet/gliffyapi/clientresource [gliffy.core.clientapi.ClientAPIServlet]
Method: GET
Request path: /jira/plugins/servlet/gliffyapi/clientresource
Action: class com.gliffy.core.clientapi.action.ClientResourceAction
Request params:
'package' = 'com.gliffy.templates'
'name' = 'TemplateCategories.xml'
'__lzbc__' = '1351648057415'
QueryString: package=com.gliffy.templates&name=TemplateCategories.xml&__lzbc__=1351648057415
UserAgent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.94 Safari/537.4
IP: 192.168.235.170
2012-10-31 10:47:36,839 http-8080-1 DEBUG admin 647x2418x6 r2jih9 192.168.235.1,192.168.235.170 /plugins/servlet/gliffyapi/clientuserpreferences [gliffy.core.clientapi.ClientAPIServlet]
Method: POST
Request path: /jira/plugins/servlet/gliffyapi/clientuserpreferences
Action: class com.gliffy.core.clientapi.action.ClientUserPreferencesAction
Request params:
'action' = 'get'
QueryString: null
UserAgent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.94 Safari/537.4
IP: 192.168.235.170
2012-10-31 10:47:36,859 http-8080-1 DEBUG admin 647x2418x6 r2jih9 192.168.235.1,192.168.235.170 /plugins/servlet/gliffyapi/clientuserpreferences [plugin.jira.dao.UserDAOImpl] preferenceKeyIndex=null
2012-10-31 10:47:36,860 http-8080-1 DEBUG admin 647x2418x6 r2jih9 192.168.235.1,192.168.235.170 /plugins/servlet/gliffyapi/clientuserpreferences [gliffy.core.clientapi.ClientAPIServlet] Response:
<response status="0" errorcode="" ><preferences></preferences></response>
2012-10-31 10:47:37,128 http-8080-5 DEBUG admin 647x2422x1 r2jih9 192.168.235.1,192.168.235.170 /secure/ShowGliffyEditorAction.jspa [jira.web.action.ShowGliffyEditorAction] pid: null
id: null
fixfor: null
type: null
nextPageURL: null
2012-10-31 10:47:37,133 http-8080-5 DEBUG admin 647x2422x1 r2jih9 192.168.235.1,192.168.235.170 /secure/ShowGliffyEditorAction.jspa [gliffy.core.license.AbstractLicenseManager] cached status: 0 lastTimeStatusChecked: 1351645288058 (now: 1351648057133 difference: 2769075 time to next check: 83630925)
ヘルプデスクの課題にログファイルを添付していただける際にサイズが大きいときは、問題が発生したと思われる時間帯前後のログを抜き出して貼り付けてください。
ご参考
Gliffy のログを収集する必要がなくなったときは、「ログレベルの設定」で「OFF」を選択してください。または、Jira またはサーバーを再起動したときにログ収集は終了します。
リックソフト株式会社 は、日本でトップレベルのAtlassian Platinum Solution Partnerです。
大規模ユーザーへの対応実績が認められたEnterpriseの認定をうけ、高度なトレーニング要件をクリアし、小規模から大規模のお客様まで対応可能な実績を示したパートナー企業です。
Copyright © Ricksoft Co., Ltd. プライバシーポリシー お問い合わせ