JIRA Integration

Follow

JIRA Integration is an advanced feature allowing you to synchronize the errors it tracks on your application with your JIRA tickets. You can create JIRA tickets using the error information, e.g. a stack trace, directly from Countly Dashboard and work on the bug ticket with JIRA and its resolution status, e.g. In Progress, will be synchronized both ways.

Availability

The JIRA Integration plugin is available only in the Enterprise Edition.

Setting Up the JIRA Integration

Generating the OAuth Key Pair

1. Generate a private key.

openssl genrsa -out jira_privatekey.pem 1024

2. Generate a certificate from the private key.

openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365

3. Extract the public key from the certificate.

openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

Setting Up the JIRA Application Link

As an admin of your JIRA site, navigate to the site top bar > cog icon > Products. In the next screen, navigate to Application links in the left sidebar.

Start creating a new application link by entering your Countly instance's URL in the text box and clicking Create new link. There will be an alert notifying you that no response was received from the URL you entered and that it may not be valid, disregard it and click Continue.

In the next step, fill in the Application Name field with anything you like, but we recommend "Countly". Leave Application Type as "Generic Application". Click Continue and the application link should be created successfully.

Now configure OAuth by editing your newly created application link, clicking the pencil icon on its far right side.

  1. Navigate to Incoming Authentication. Fill the following fields and click Save.
  2. Consumer Key: Any string will do, we recommend something like a password, e.g aec070645fe53ee3b37630.
  3. Consumer Name: A short name to identify your Countly instance.
  4. Description (optional): A short description to identify your Countly instance.
  5. Public Key: The contents of the file jira_publickey.pem between but not including the lines starting with hyphens.

Setting Up the Countly JIRA Integration Plugin

Now, as a global admin of your Countly instance, go to Management > Settings and then scroll to Plugins > JIRA For Crashes.

JIRA_Int.png

Fill all the fields:

  • Consumer Key: The arbitrary string you chose while setting up the application link on JIRA.
  • JIRA API URL: URL of the JIRA server, e.g. "https://foobar.atlassian.net".
  • Callback URL: Fully qualified URL of the API server of your Countly instance, e.g. "https://foobar.count.ly".
  • Private Key: The contents of the file jira_privatekey.pem between but not including the lines starting with hyphens.

Authorize Countly to use your account to synchronize crashes by clicking Login . This should take you to your JIRA instance, asking if you want to authorize your Countly application with the current logged-in JIRA account.

Note that you must create corresponding JIRA projects for your Countly applications. To do this for each application-project pair go to Management > Applications > Select your application > App Settings pannel > JIRA for Crashes.

JIRA_Int2.png

Fill all the fields, keeping in mind that they are case-sensitive with JIRA, so for example "To do" will not work if the JIRA workflow state is "To Do".

  • Project: JIRA project key/slug to create issue in, e.g. If your project is "Test Project" then your key/slug will probably be "TP".
  • Issue Type: JIRA issue name to create issues with, e.g. Bug.
  • To Do States: JIRA issue status names corresponding to unresolved crashes, e.g. To Do.
  • Done States: JIRA issue status names corresponding to resolved crashes, e.g. Done.
How does Countly choose a JIRA status to synchronize if there are multiple?

When a crash resolution change is made on the Countly side and needs to be synchronized with JIRA, the first state on the corresponding configuration will be chosen. For example, "Done" will be chosen if the crash is marked as resolved and Done states are "Done" and "Cancelled", in that order.

Creating a JIRA Task for a Countly Crash

Having set JIRA integration up, you can create a JIRA task for any crash or error on Countly by clicking Create JIRA Task in a crash manipulation menu.

This will open a pop up in which you can edit the JIRA task's title and body.

Once you are satisfied with the task's title and body, click Create JIRA Issue and you should see a notification informing you that the task has been successfully created.

From now on, the issue will be synchronized both ways. It will be set to resolved, resolving, or unresolved when it is marked accordingly on JIRA, and vice versa.

Was this article helpful?
0 out of 0 found this helpful

Looking for help?