Jira

The Bigeye integration with Jira allows teams to track their most important data quality issues using the flexibility of the Jira interface. This integration is bi-directional, meaning that you can update the status of issues through Jira or Bigeye, and your updates are reflected in both systems. Once a Jira ticket is created from the Bigeye UI, any subsequent issue status changes and/or comments are posted in both places so that everyone can stay informed on the status of this issue.

Setup

Enabling a Jira integration for a Bigeye instance can be done with the following steps:

1. Install the Bigeye Issues Integration application through the Jira Marketplace.
   1. This application creates custom fields and automation rules to sync issues between Bigeye and Jira.
2. Create a new blank Jira Project and make the following modifications to the project:
   1. Delete the three default status options (To Do, In Progress, and Done) and create four new statuses: Triage, Acknowledged, Monitoring, and Closed. Alternatively, you can create a new Monitoring status option in Jira and rename the other three default options.
      Ensure to map these renamed statuses to the default statuses of Jira as stated below:
      1. To do -> Triage
      2. In Progress -> Acknowledged
      3. Done -> Closed
   2. Add custom Bigeye fields to the Task screen.
      1. Bigeye Issue ID
      2. Bigeye Workspace ID
      3. Bigeye Threshold Feedback
3. Send your credentials to your Bigeye Customer Success Representative. You can utilize services like OneTimeSecret to share the following:

{
	"jira_email": "[email protected]",
	"jira_api_token": "1234sometoken1234",
	"jira_host": "https://myorg.atlassian.net",
	"jira_project_key": "BI",
	"bigeye_username": "[email protected]",
	"bigeye_password": "myserviceaccountpasswordisfake",
	"bigeye_base_url": "https://app.bigeye.com",
	"bigeye_workspace_id": 123
}

1. Bigeye configures the integration and responds with your unique integration URL. (i.e. https://8qg8xukim9.execute-api.us-west-2.amazonaws.com/jira/<company_name>
2. In Jira, go to Apps → Manage Apps and find Bigeye on the left sidebar. Update your Bigeye Jira app configuration with the URL provided by Bigeye and the list of Jira project keys where the integration needs to be supported.
   1. For every project you want to enable this integration, you must tell Bigeye the project keys and the associated Bigeye workspace.
3. Use the integration!

Using the Integration

Walkthrough Video

Create a Jira ticket

Once the integration is enabled, you can see a new “External ticket” option in the right-hand pane for all your issues. To create a new Jira ticket, click the Create Ticket button in the right-hand pane.

Once the ticket is created, you get a success message in the bottom right-hand of your screen, and the linked Jira ticket now shows in the right-hand pane of this issue. That button now links directly to the new ticket in your Jira instance. The ticket in Jira contains the information relevant to the latest run of when the ticket was created, the configuration of the metric with an issue present, and a remote link back to the Bigeye issue. If available, it also provides the debug query you can use to troubleshoot the issue. If unavailable, it provides you with the metric query used.

Updating an Issue/Jira Ticket

Once the Bigeye issue is linked to a Jira ticket, all status changes and comments are synced between the two platforms. Depending upon your desired workflow, you can change the status of an issue to Acknowledged to indicate that work has begun on either platform, and the update must be reflected on the other.

Similarly, if you wanted to leave a comment to tell others that you are looking into the problem and maybe what your hunch on what the problem is, then that comment is reflected in both places.