Installation Guide

システム要件

Insight is an add-on to Jira which means you need to ensure that Jira is configured to handle the amount of data you plan to import into Insight. We recommend you to read this article from Atlassian about how to setup Jira and recommended hardware requirements: 

https://confluence.atlassian.com/jira/jira-requirements-185729596.html#JIRARequirements-JIRAServerHardwareRecommendations

If you plan to use a lot of scheduling tasks and import a large amount of data we recommend to follow the table below.

膨大なデータ セットに対するテスト環境では、必ずメモリ消費量をテストしてください。これは、オブジェクトの数だけでなくオブジェクト属性のコンテンツも関係しているためです。 

パフォーマンスのチューニング

Insight の大規模なインストールでは、パフォーマンスを向上させるために微調整できるオプションがいくつかあります。 

ガベージ コレクション

To decrease the pause time we recommend that you switch the garbage collection (GC) algorithm to G1 from the default. You can configure it by adding the following JVM argument to your Jira setenv script.

Based on your environment, other options to tune the G1 may be required. Check out the information from Oracle (http://www.oracle.com/technetwork/tutorials/tutorials-1876574.html) and tune your JVM based on your requirements. 

Insight の並列処理

Insight executes tasks in parallel (e.g. reindex, imports). On a large instance, you can increase the number of threads that perform the tasks. You can see this here: Insight Server and Data Center configuration. By default, the parallelism is configured to be equal to the amount of cores available to the JVM. 

データベース プール

スレッド数を増やした場合は (Insight の並列処理)、データベース接続プール モニターをご確認のうえ、接続プールを増やす必要があるかを判断することをお勧めします。

Jira のシャットダウン

Jira のシャットダウン時に、Insight はインデックスをディスク上に保持して起動を高速化します。大規模なインスタンスでは、強制シャットダウン コマンドが送信される際にインデックス ファイルをディスクに保存できません。これによって、Insight は起動のたびにデータベースの再インデックスを実行します。この変更を防ぐには、stop-jira スクリプトで強制シャットダウンのタイムアウトを変更する必要があります。

Change the value 20 (the unit is seconds) to a value that is more reasonable based on the amount of data in your installation. Below is a snippet from the standard Jira stop-jira.sh and it is the value 20 that should be changed at two places.

if [ -z "$JIRA_USER" ] || [ $(id -un) == "$JIRA_USER" ]; then
    echo executing as current user
 
    exec $PRGDIR/shutdown.sh 20 -force $@
 
elif [ $UID -ne 0 ]; then
 
    echo JIRA has been installed to run as $JIRA_USER so please sudo run this to enable switching to that user
    exit 1
 
else
 
    echo executing using dedicated user
    if [ -x "/sbin/runuser" ]; then
        sucmd="/sbin/runuser"
    else
        sucmd="su"
    fi
    $sucmd -m $JIRA_USER -c "$PRGDIR/shutdown.sh 20 -force $@"
 
fi

Tomcat の考慮事項

If you have configured your heap with the CATALINA_OPTS in setenv,  make sure that the JVM configuration (JVM_MAXIMUM_MEMORY) is not the same value as the max heap configured in CATALINA_OPTS. 

Using Insight Imports with a large number of objects

If you are using Insight to accommodate millions of objects and plan to use importers heavily, (e.g, with the Insight Discovery product),  then we recommend that you move to Data Center version if you are not already using it. This will offer you the possibility to isolate the importers to only one import node with the other nodes being the user nodes. With one import node, the import process will have less impact on user interaction . It will also be more robust since any failing import or any over consumption of memory will only affect the import node and not any of your user nodes.

オブジェクトに保存されているデータやインポートの頻度に関係するため、正確なオブジェクト サイズやインポート サイズの推奨事項を設定することは困難です。ただし、一般に数百万個のオブジェクトがある、メモリ使用量が 32GB を超える、またはユーザー操作に絶対に影響を与えたくない場合は、Data Center バージョンの Insight の使用をご検討ください。  

Data Center によってインポートと再インデックス化中に、インデックスの更新のためにメッセージを他のノードに送信する必要があります。これは、提供されているアトラシアンの機能によって行われます。clustermessage テーブルは、すべてのノードがプッシュ/プルする DB テーブルです。これまでに確認された問題は、このテーブルのアトラシアンでの保持期間が 30 日であることです。これは少し長すぎると考えられるため、独自の保持スクリプトによって 24 時間より古い Insight 関連のすべてのデータ行を削除することをお勧めします。 

Install Insight

Before you install Insight, go through or revisit the basic concepts if needed.

To install Insight, execute the following steps:

1. Log in to your Jira instance as a Jira Administrator. You will need Jira Administrator permission to disable Insight. For more information on global permissions, see this link.
2. Click the cog wheel at the far right and choose the Manage apps option. This will open the Manage apps tab.
3. Click on Find new apps on the left side panel and search for "Insight" using the Search the marketplace search box. Insight - Asset Management will get listed in search results.
   
   
4. Click Free trial to begin a new trial or Buy now to purchase a license for Insight.
 You will be prompted to log in to https://my.atlassian.com/ to get a trial license.
   
5. On the redirected page, enter your information and click Generate license.
   

Once the installation is completed, you should be able to see Insight as a menu option in the horizontal bar at the top of your Jira instance screen.

Update Insight

Follow the steps as described in the Jira documentation on Updating Add-ons. 

Additionally, when you upgrade Insight to certain versions, they may require some preparation. We mention this in our release notes. Ensure that you follow our preparation guides for such versions. They contain all the vital information that help you in a smooth upgrade.

Disable Insight

1. Log in to your Jira instance as a Jira Administrator. You will need Jira Administrator permission to disable Insight. For more information on global permissions, see this link.
2. Click the cog wheel at the far right and choose the Manage apps option. This will open the Manage apps tab.
3. Expand Insight in the User-installed Add-ons.
4. Click the Disable button.
 For more information: Disabling and Enabling add-ons.

Insight をアンインストールします

1. Log in to your Jira instance as a Jira Administrator. You will need Jira Administrator permission to uninstall Insight. For more information on global permissions, see this link.
2. Click the cog wheel at the far right and choose the Manage apps option. This will open the Manage apps tab.
3. Expand Insight in the User-installed Add-ons.
4. [アンインストール] ボタンをクリックします。