JAGS

Cross Product Knowledge

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

The steps outlined on this article are provided AS-IS. This means we've had reports of them working for some customers — under certain circumstances — yet are not officially supported, nor can we guarantee they'll work for your specific scenario.

You may follow through and validate them on your own non-prod environments prior to production or fall back to supported alternatives if they don't work out.

We also invite you to reach out to our Community for matters that fall beyond Atlassian's scope of support!

What is JAGS

JAGS is an internal tool developed and used by Atlassian Support to visualize data from a Support Zip file.

JAGS runs using Docker Compose and is built on top of Open Source tools:

JAGS is able to parse Support Zip files from the following Data Center products:


Here's an example of a few built-in dashboards available after starting JAGS stack.

Click here to expand...



When to use

The primary use for JAGS is when Support Engineers are investigating a performance problem with Data Center products and Support Zip files are available.

The built-in Grafana dashboards help identifying areas of interest for further investigation.

JAGS is not a replacement to standard observability stack, but may be helpful when one is not available. It may also be useful to have an idea of possible dashboards to be built on top of your stack, based on what support engineers usually rely on.

JAGS was designed as a disposable stack, meaning it can be completely removed (containers and data) after one finishes analyzing the data.

How to run

Below is a step-by-step procedure to run JAGS stack on a computer (your own computer or a server).

Check here a sample video while running these steps

1

Make sure Docker Engine and Docker Compose are installed and running.

Many processes on JAGS rely on multi-threaded tasks, so make sure to give a reasonable amount of resources available to the Docker Engine.

2

Create a directory to hold the JAGS source-code and data to be used by the containers.

Example
cd ~
mkdir jira-investigation
3

Download the Support Zip files you want to inspect and place them in the directory you created.

The structure of the Support Zip file is important to JAGS, so you are recommended to not make any changes to the file name nor its internal directory structure.

4Download JAGS source code from here and unzip it within the directory you created on a previous step.


Expand to download JAGS...

jags.zip

JAGS is continuously under development.

The available file was last updated on .

To download this file through curl
curl -v -k -L \
  'https://confluence.atlassian.com/download/attachments/1456180211/jags.zip?api=v2&download=true' \
  -o jags.zip


After uncompressing the file you may have a directory structure as below.

Example
~/jira-investigation/jags
5

Create additional needed directories and apply read and write permissions to the jags directory.

mkdir ./jags/postgresdata ./jags/grafanadata
sudo chmod -R o+rw ./jags
6

Copy or move the target Support Zip files to the jags/SupportZip directory.

If copying all the files within the current folder
cp *_support_*.zip ./jags/SupportZip/
7

Start the stack.

cd ./jags
docker-compose -f stack.yml up

The only port exposed by the stack is 3333 to access Grafana.

The above command will stream the stack logs to the terminal.

Expand if you don't want to start the stack on interactive mode
cd jags
docker-compose -f stack.yml up -d

To see logs:

cd jags
docker compose -f stack.yml logs --follow
8

Give it 5~10 minutes to process the Support Zip files.

The time to complete may change depending on:

  • The number of Support Zip files.
  • The number and size of log files on each Support Zip.
  • The resources (RAM and vCPU) available to the Docker Engine.


9

Access Grafana through the link below.

Running on local computer
http://localhost:3333/
Running on remote computer
http://<remote-ip>:3333/
10

To stop the stack:

  • control + c  – if you started in interactive mode.
  • cd jags; docker compose -f stack.yml stop  – if you started on detached mode.


11

Data cleanup.

If you know you won’t use JAGS data anymore, simply remove the jags directory and all related data is gone.


The steps outlined on this article are provided AS-IS. This means we've had reports of them working for some customers — under certain circumstances — yet are not officially supported, nor can we guarantee they'll work for your specific scenario.

You may follow through and validate them on your own non-prod environments prior to production or fall back to supported alternatives if they don't work out.

We also invite you to reach out to our Community for matters that fall beyond Atlassian's scope of support!



Last modified on Nov 26, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.