This documentation is for Insight for Server/Data Center only.

Summary

Understand system requirements and other options that you should have in place before you install Insight.

Understand how to install Insight on a Jira instance. Learn how to update an existing version of Insight.

Learn how to uninstall and disable a running instance of Insight.

Summary






System Requirements

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.

Remember to always test the memory consumption in a test environment for a huge data set, because it's not always the number of objects, but the content of the object attributes as well at play. 

Objects in InsightJVM memory
~10.0004Gb
~100.0008Gb
~500.00016Gb
~1.000.00032Gb
~2.000.00064Gb
~5.000.000128Gb






Performance tuning

On large installations of Insight, there are some options you can tweak to increase performance. 

Garbage collection

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.

-XX:+UseG1GC

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 parallelism

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. 

Database pool

If you have increased the number of threads(Insight parallelism), it is recommended to check the database connection pool monitor and determine if an increased connection pool is required as well.

Jira shutdown

On Jira shutdown Insight persists the index on disk for faster startup. In large instances, the index file fails to be saved on disk in time before the force shutdown command is sent. This will cause Insight to do a database reindex on each startup. To prevent this change, you need to change the timeout on force shutdown in the stop-jira script.

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 considerations

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.

It is difficult for us to set any exact object size or import size recommendation since it's about the data stored on your objects, as well as how often the imports occur. But in general, when reaching millions of objects or memory usage over 32 Gb or if you don't ever want to impact any user interaction, then you should consider using the Data Center version of Insight.  

During imports and re-index with Data Center, we need to send messages to other nodes to update the index. This is done through provided Atlasssian functionality and the clustermessage table is the DB table where all nodes push and pull. The problem we have seen is that Atlasssian have a retention period of 30 days for this table. We think this is a bit too much and recommend that you should remove all Insight related data rows which are older than 24 hours with your own retention scripts. 






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.

If you don't want to click to navigate to Manage apps, you can type "gg" or "." which opens up a dialog box. You can then start typing whatever you want to look for.In this case, search: "Manage apps"





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.

If you are upgrading your version of Jira, your current version of Insight may not be compatible with the new Jira version. In that case, do the following:

  1. Upgrade your Jira version
  2. Upgrade to a new compatible version of Insight





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.






Uninstall 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. Click the Uninstall button.