Setup and configuration - Jira Cloud
What this integration does
The Jira Cloud integration lets you create a Bug ticket directly from an error's detail screen in DockRay, without copying the message, stack trace or request path by hand. Creating a ticket saves a permanent link: one DockRay error to one Jira ticket. Once that ticket reaches the Done status category in Jira, DockRay marks the error as resolved on its own - reading the status is periodic, not instant: the thor:sync-jira command checks linked tickets every five minutes.
What you need on the Jira side
- a Jira Cloud instance on the
*.atlassian.netdomain - the integration only accepts public HTTPS addresses on that domain, - the e-mail address of the Atlassian account that will act on the integration's behalf,
- an API token generated for that account (Atlassian account settings → Security → API tokens),
- a Jira project to receive the tickets - the integration maps to a project, not a board, since a board is only a view onto a project.
Account-level connection
In the DockRay panel go to Settings → Jira and enter the instance address, the Atlassian account e-mail and the API token. This connection is shared by every project on the account that has no credentials of its own - a single project can override it later.
Per-project configuration
In Project settings → Jira, pick the Jira project that should receive tickets, a default assignee and an optional starting status. A DockRay project can use the account's credentials or get its own - useful when different teams in the company run separate Jira instances or separate service accounts.
What goes into the ticket content
The ticket description is an Atlassian Document Format document: a quote with the error type and message, a list of facts (project, environment, request, occurrence count, first and last occurrence for that day, client SDK), the failing location with a few lines of code around the broken line, a trimmed stack trace and a link back to the DockRay panel. What is deliberately left out of that description is covered in the next article.
The first test
Open any existing error in a project and create a Jira ticket from it. In Jira, check that the ticket landed in the expected project, with a description containing the error message, the failing location and a link to the DockRay panel. The error in DockRay should now show a link to the created ticket - visible proof that the link was saved.