Jira

Jira

Crawler Crawler

Overview

Jira is an issue and project tracking system for software teams. This integration allows you to create issues from triggered alerts in Datadog, and update existing issues with new information as it arises. Additionally, Jira issue creations are added as events within Datadog to overlay with your metrics.

Setup

Installation

  1. Navigate to your Jira account.

  2. Click the settings gear icon (upper right), then Products.

  3. Under INTEGRATIONS in left side menu, select Application links.

  4. Enter the URL https://app.datadoghq.com/ and click Create new link. Note: If you see the warning No response was received from the URL you entered, ignore this and click Continue.

  5. Fill in the form as follows, then click Continue.

    FieldInput
    Application NameAny name (used for identification)
    Application TypeGeneric Application
    Service Provider Name[leave blank]
    Consumer key[leave blank]
    Shared secret[leave blank]
    Request Token URL[leave blank]
    Access token URL[leave blank]
    Authorize URL[leave blank]
    Create incoming linkCheck the box
  6. Fill in the next form with the information from the Datadog Jira integration tile, then click Continue.

    FieldInput
    Consumer Keydatadog
    Consumer NameDatadog
    Public KeySee the Datadog Jira integration tile.

Configuration

  1. In the Datadog Jira integration tile, enter the URL of your Jira account under step 2, for example:
    https://your-jira.atlassian.net
    
  2. Then, click the Setup OAuth1 button.

Add issues

After installing the Jira integration, create a custom issue within Datadog.

  1. To begin, click the Add Issue button.
  2. Enter a Project Key and Issue Type for your issue. Note: Each issue has a unique Project ID—Issue Type combination.
  3. Optionally, add Datadog tags in the form of <KEY:VALUE>.
  4. Optionally, the Assignee field can be made to automatically populate when the Jira issue is created by placing the Jira account ID of the user to be assigned the issue.
  5. When the Required fields display for this issue, each of these fields must be filled out.
  6. Other fields listed are optional.
  7. Click the Save button.

Note: If you have the required field Severity (as shown above), Jira restricts the values allowed to:

  • 1 - Critical
  • 2 - Major
  • 3 - Minor

Raw values and variables from the alert event can be used to fill in the issue fields. A full list of variables can be seen below:

VariableDescription
$IDID of the event (ex: 1234567)
$EVENT_TITLETitle of the event (ex: [Triggered] [Memory Alert])
$EVENT_MSGText of the event (ex: @webhook-url Sending to the webhook)
$EVENT_TYPEType of the event (ex: metric_alert_monitor)
$LAST_UPDATEDDate when the event was last updated
$DATEDate (epoch) where the event happened (ex: 1406662672000)
$AGGREG_KEYID to aggregate events belonging together (ex: 9bd4ac313a4d1e8fae2482df7b77628)
$ORG_IDID of your organization (ex: 11023)
$ORG_NAMEName of your organization (ex: Datadog)
$USERUser posting the event that triggered the webhook (ex: rudy)
$SNAPSHOTUrl of the image if the event contains a snapshot (ex: https://url.to.snpashot.com/)
$LINKUrl of the event (ex: https://app.datadoghq.com/event/jump_to?event_id=123456)
$PRIORITYPriority of the event (ex: normal)
$TAGSComma-separated list of the event tags (ex: monitor, name:myService, role:computing-node)
$TEXT_ONLY_MSGText of the event without markdown formatting
$ALERT_IDID of alert (ex: 1234)
$ALERT_METRICName of the metric if it’s an alert (ex: system.load.1)
$ALERT_QUERYQuery of the monitor that triggered the webhook
$ALERT_STATUSSummary of the alert status (ex: system.load.1 over host:my-host was > 0 at least once during the last 1m)
$ALERT_TRANSITIONType of alert notification (ex: Triggered)
$HOSTNAMEThe hostname of the server associated with the event (if there is one).
$ALERT_CYCLE_KEYID to link events from the time an alert triggers until it resolves.
$LOGS_SAMPLELogs sample from log monitor alerts.

Use cases

Automatically create issues from Datadog alerts

To create Jira issues from within Datadog alerts, use the @jira-<PROJECT_NAME>-<ISSUE_TYPE> command within the “Say what’s happening” section of the new monitor creation process.

The first time an alert is triggered from the monitor, it creates a Jira ticket. If the same monitor alerts again it does not create another Jira ticket, but instead updates the existing ticket by adding a comment each time it alerts until the monitor goes into a recover state. After recovery, if the alert triggers again, it creates another Jira ticket.

The @jira-update command can be used to update existing issues. This command adds a comment to the Jira issue with the text followed by the @jira-update command.

Tip: You may find it helpful to use the @jira command within an #is_alert or #is_warning variable.

Data Collected

Metrics

The Jira integration does not include any metrics.

Events

All created Jira issues appear as events within Datadog.

Service Checks

The Jira integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.