Skip to main content

Jira Cloud

Thumbnail icon

The Sumo Logic App for Jira Cloud provides insights into how your Jira projects and issues are being managed so as to enable you to be more effective and manage work across multiple teams. This guide provides instructions for installing and configuring the Jira Cloud App, as well as offering examples and descriptions of the app pre-configured dashboards.

Log Types

The Jira Cloud App uses the following types of logs:

  • Issue related events
  • Project-related events
  • User related events
  • Jira configuration related events
  • Jira Software related events

For more information, see Webhooks in Jira help

Sample Log Messages

For more information about log messages, see Sample Log for Jira Cloud.

Sample Query

This section provides a sample query from the Unassigned Issues panel on the Jira Cloud - Issue Details dashboard.

Parameters

  • Issue:*
  • Issue_Summary:*
Query String
_sourceCategory="jira_cloud" *issue*
| json field=_raw "webhookEvent", "issue_event_type_name", "changelog", "issue.fields.creator.displayName", "issue.self", "issue.key", "timestamp", "issue.fields.issuetype.name", "issue.fields.status.name", "issue.fields.resolution.name", "issue.fields.project.name", "issue.fields.status.statusCategory.name", "user.active", "issue.fields.assignee.displayName", "issue.fields.summary", "issue.fields.priority.name", "issue.fields.components", "issue.fields.labels" as event_name, event_type, change_log, issue_creator, jira_self, issue_key, timestamp, type, status, resolution, project_name, status_category, is_active, issue_assignee, issue_summary, priority, components, labels nodrop
| where project_name matches "*" AND issue_key matches "*" AND type matches "*" AND priority matches "*" AND status_category matches "*" AND status matches "*"
| isNull(issue_assignee) ? "Unassigned" : issue_assignee as issue_assignee
| parse regex field=labels "\"(?<label>[\S]+?)\"" multi nodrop
| parse regex field=components "\"name\":\"(?<component>[\S]+?)\"" multi nodrop
| where component matches "*" and label matches "*"
| json field=change_log "items" as changes nodrop
| formatDate(fromMillis(timestamp), "MM-dd-yyyy HH:mm:ss", "UTC") as date_time
| parse regex field=jira_self "https:\/\/(?<base_url>.*?)\/"
| concat("https://",base_url,"/browse/", issue_key) as issue_url
| tourl(issue_url, issue_key) as issue
| withtime issue_assignee
| most_recent(issue_assignee_withtime) as user by issue, issue_summary
| where user="Unassigned"
| count as count by issue, issue_summary
| fields - count

Collecting Logs for the Jira Cloud App

This section provides instructions for configuring log collection for the Jira Cloud App.

Configuring log collection consists of the following tasks:

  • Configuring a Hosted Collector in Sumo Logic to receive Jira Cloud Events: A Hosted Collector is installed to receive the Webhooks from Jira. The Webhooks configuration helps to notify the app or web application when certain events occur in Jira. Using the Webhooks the remote applications do not have to monitor whether changes have occurred
  • Registering a Webhook in Jira Cloud: Webhooks are registered in Jira for various events by Jira administration console or Jira REST API methods. These Webhooks can be used as an alert to the remote application when the issues are updated or sprints are started.

For more information, please see the documentation for Webhooks in Jira Cloud.

Step 1: Configure Hosted Collector to Receive Webhooks

In this step, you create a host collector to receive Webhooks from Jira and set up an HTTP source on it.

  1. Configure a Hosted Collector, or select an existing hosted collector for the HTTP source.
  2. Configure an HTTP source on the hosted collector.
    • For Source Category, specify jira_cloud/events.
    • Make a note of the HTTP address for the source. You will supply it when you configure a Jira Webhook in the next step.

Step 2: Register Webhook in Jira

Follow the instructions on Webhooks in Jira help to register a Webhook for the following events:

  • Issue
    • created
    • updated
    • deleted
  • Comment
    • created
    • updated
    • deleted
  • Attachment
    • created
    • deleted
  • Worklog
    • created
    • updated
    • deleted
  • Entity property
    • created or updated
    • deleted
  • Issue link
    • created
    • deleted
  • Version
    • released
    • unreleased
    • created
    • moved
    • updated
    • merged
    • deleted
  • Project
    • created
    • updated
    • deleted
  • User
    • created
    • deleted
    • updated
  • Features status change (enabled/disabled)
    • voting
    • watching
    • unassigned issues
    • subtasks
    • attachments
    • issue links
    • time tracking
    • time tracking provider
  • Board
    • created
    • deleted
    • updated
    • configuration changed

Sprint Events

  • Sprint
    • created
    • deleted
    • updated
    • started
    • closed

When you configure the Webhook, enter the URL for the HTTP source you created in Step 2 as the endpoint for the Webhook.

Installing the Jira Cloud App

This section demonstrates how to install the Jira Cloud App.

To install the app:

  1. From the Sumo Logic navigation, select App Catalog.
  2. In the Search Apps field, search for and then select your app.
    App_Catalog.png
  3. Optionally, you can scroll down to preview the dashboards included with the app. Then, click Install App (sometimes this button says Add Integration).
    note

    If your app has multiple versions, you'll need to select the version of the service you're using before installation.

  4. On the next configuration page, under Select Data Source for your App, complete the following fields:
    • Data Source. Select one of the following options:
      • Choose Source Category and select a source category from the list; or
      • Choose Enter a Custom Data Filter, and enter a custom source category beginning with an underscore. For example, _sourceCategory=MyCategory.
    • Folder Name. You can retain the existing name or enter a custom name of your choice for the app.
    • All Folders (optional). Default location is the Personal folder in your Library. If desired, you can choose a different location and/or click New Folder to add it to a new folder.
  5. Click Next.
  6. Look for the dialog confirming that your app was installed successfully.
    app-success.png

Once an app is installed, it will appear in your Personal folder or the folder that you specified. From here, you can share it with other users in your organization. Dashboard panels will automatically start to fill with data matching the time range query received since you created the panel. Results won't be available immediately, but within about 20 minutes, you'll see completed graphs and maps.

Viewing Jira Cloud Dashboards

Filter with template variables

Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see Filter with template variables.

Issue Overview

The Jira Cloud - Issue Overview dashboard provides users with a high-level view of activities such as issues created, closed, reopened, and in progress.

Use this dashboard to:

  • Understand how issues are being created, closed and reopened.
  • Quickly identify issue types, components, and projects that need the most attention.
  • Identify how work in progress could affect your development and delivery lifecycle.
jira cloud

Issue Details

The Jira Cloud - Issue Details dashboard provides a visual overview of issues in Jira. The analytics help you visually examine critical information related to issues created compared to issues closed. The panels also provide details on open and closed issues, issue assignments and escalations. a list of issues escalated, unassigned, or reopened, and the average time is taken to close issues.

Use this dashboard to:

  • Identifying issues, components, teams, and initiatives that require the most attention.
  • Get insight into the time taken to close Jira issues by projects, types, and users.
jira cloud

Recent Issues Changes

The Jira Cloud - Recent Issues Changes dashboard tracks the recent progress of Jira issues. The panels provide information about the type of issue, the timestamp when it was created, issue status, category, assignee, and issue summary.

Use this dashboard to:

  • Identify the recent progress of Issues. This dashboard gives the progress of your software delivery processes in chronological order. You can use filters to drill down to a more detailed view.

Following drill down, filters are available: Components, Project Name, Status, Label, Issue Key, Issue Type, Priority, and Status Category.

jira cloud

Sprint Events

The Jira Cloud - Sprint Events dashboard provides an at-a-glance view of sprint events. The panels also provide tabular representations of all sprint events spread over a week, sprints created, sprints started, and sprints closed.

Use this dashboard to:

  • Monitor the progress of sprints in your development cycle. You can track active sprints and their start and end dates.
jira cloud

User Events

The Jira Cloud - User Events dashboard provides an overview of user profiles. The analytics allow you to closely monitor the unusual activity related to users created, updated, and deleted.

Use this dashboard to:

  • Monitor and audit all administrative activities related to the creation and modification of Jira Cloud users.
jira cloud
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.