Performance Data Collector の使用方法

概要

このページでは、Performance Data Collection ツールを使用して、スレッド ダンプ、ディスク速度、および CPU 使用率などのパフォーマンス データの情報を収集する方法について説明します。

コレクターはツールキットとグラフィカル ユーザー インターフェイス (GUI) で構成されています。ツールキットはご利用のアトラシアン製品と同じ製品にインストールする必要があります。ツールキットには外部からアクセスできるため、GUI をローカル マシンで使用してリモートで接続することができます。

Windows でのツールキットのインストール手順

1. Java 8 JDK がインストールされていない場合は、インストールします。
2. Add the JDK 8 directory to the windows %PATH% at the beginning (e.g.: C:\Program Files\Java\jdk1.8.0_181\bin) as per the How do I set or change the PATH system variable? Oracle documentation. For example:
   
   
   This is required, due to a limit in the installer.
3. Using the download section of the Bitbucket repository, download the archive and expand it to where you want it to be installed, e.g.: C:\Program Files\Atlassian.

4. Install it with InstallAsService.bat - this must be run as an Administrator user. It will put it into the standard Windows services along with the other Atlassian products, for example:
   
   It must be run by the same user that the Atlassian products are run by, otherwise it won't be able to connect to them - this is due to restrictions in the Java JDK. For all products except Bitbucket Server, this will work with the defaults.

   Account utilization caveat (Windows)

   In order to be able to properly utilize the Data Collector Tool, Jira must not be running with the 'Network Service' account (which is the default 'Log On As' when Jira is installed on Windows), due to its iterative login not allowing the data collector to correctly bind to the Jira service.

   If this is your case, you can change the account that Jira is using to the Local System Account, with the below steps:
   - Open the Windows Services.
   - Right-click the Atlassian Jira service and select properties.
   - Select the Log On tab
   - Mark the Local System Account option and Apply.
   

   - Hit Ok to close the service Properties windows.
   - Restart the Jira service so that the changes can be picked up.

   Ensure that the Data Collector is also running with the same 'Log On As', if it is not, you can use the same steps to adjust its service.

5. If you need to change the user (say the Atlassian product is run as a specific user, such as in BitBucket Server), uncommenting below in <INSTALL_DIR>\windows-service\service.xml and uninstalling / reinstalling will set it as that user:

   <!-- If you need the service to be run as a particular user, add the details in below. Otherwise it will use the default account.
   <serviceaccount>
       <domain>YOURDOMAIN</domain>
       <user>useraccount</user>
       <password>Pa55w0rd</password>
       <allowservicelogon>true</allowservicelogon>
   </serviceaccount>
   -->

6. これで、http://localhost:4242 または対象のドメイン名でツールにアクセスできるようになりました。後述のように、GUI を使用することをおすすめします。

Linux でのツールキットのインストール手順

1. Oracle Java 8 JDK がインストールされていない場合は、インストールします。Ubuntu の場合、サードパーティ製の Oracle Java (JDK) 8 Installer PPA を使用できます。
2. Due to restrictions in the Oracle Java JDK APIs that are used, the app must be run by the same user that is used to run the application (e.g.: jira).
3. Using the download section of the Bitbucket repository, locate the appropriate file and download it to the product home directory to install it, e.g.: /var/atlassian/application-data/jira.

4. Linux を使用している場合、jar を実行できます。次のように (またはバージョンに応じたファイル名を指定して) 実行します。

   ./data-collector-1.0.jar

   次のようにすることで、バックグラウンドで実行することもできます。

   ./data-collector-1.0.jar &

5. これで、http://localhost:4242 または対象のドメイン名でツールにアクセスできるようになりました。後述のように、GUI を使用することをおすすめします。
6. If you want to set it up as a init.d or systemd service it can be done as per the Installing Spring Boot Applications documentation.

GUI のインストール手順

Bitbucket リポジトリのダウンロード セクションからプラットフォームに応じたアプリをダウンロードし、ダウンロードしたファイルを実行します。

GUI でのデータ収集

1. Start it up and point it to the appropriate instance URL. For example, we're going to connect to http://jira.atlassian.com:4242 and use the default user / pass of collector / changeit



2. [Continue] をクリックします。
3. 対象の製品 (この場合は Jira) を選択し、製品にパフォーマンスの問題が発生している状態で [Run Data Collection] をクリックします。
   
   記載されている frequency は、データの収集頻度です。たとえば、6 snaps in a minute の場合、10 秒ごとにデータのスナップショットが作成されます。
   
   
4. 収集が完了されるまで待ちます。既定の設定の場合、これには 1 分程度かかります。設定した頻度でデータが定期的に収集されます。
   
5. 結果が収集されたら、ディスク速度の結果と、収集データをダウンロードできるリンクが提供されます。
   
6. zip をダウンロードしてサポート チケットに添付します。

ツールキットでのデータの収集

一連の REST API を使用を使用することで、さまざまなデータを収集できます。http://<app_url>:4242/v2/api-docs (例: http://localhost:4242/v2/api-docs) からダウンロード可能な Swagger 仕様書が用意されています。また、http://<app_url>:4242/ (例: http://localhost:4242) からコレクターに直接アクセスして、Swagger の UI を表示することもできます。

Postman などのクライアントを使用すると、API 仕様をインポートして、ツールキットへの呼び出しを簡単に行うことができます。例:

ツールキットの構成方法

All settings are located in the <INSTALL_DIR>/config/application.properties file.

資格情報の変更

The default login / pass is collector / changeit. These can be changed by modifying the application.properties file as per the example below:

# Basic auth for application. Changing this requires a restart.
security.user.name=collector
security.user.password=securepassword!

ポートの変更

In the above example, the login / pass will now be collector / securepassword! next time it is started.

This can be done by modifying server.port in the application.properties file as per the example below:

# Tomcat config.
server.port=8962
server.context-path=/

この例では、ツールキットは次回の開始時にポート 8962 で実行されるようになります。

ツールキットのトラブルシューティング

There are logs written to <INSTALL_DIR>/logs/atlassian-perftools.log which can be used to review what the toolkit is doing. If the collector isn't working, please provide the log on the support case and we can take a look to see what's going on.

製品が見つからない場合

The most common issue here is the product is being run as a different user. Due to limitations in the Java JDK API the toolkit must be installed as the user that is running the service. E.g.: JIRA by default, on Linux, runs as user jira. This means the toolkit must run as user jira too.

バグや新機能について

バグや機能リクエストを起票したい場合、Bitbucket の課題トラッカーをご利用ください。