The Service Map for APM is here!

Jira

Crawler Crawler
Jira Events

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. Go to settings (gear icon) –> Applications:

    Jira Navigation
  3. Under INTEGRATIONS in left menu, select Application links:

    Jira Navigation
  4. Enter https://app.datadoghq.com/ as the URL and click Create new link. Note: You may see a warning “No response was received from the URL you entered.” Ignore this and press Continue.)

    Configure App Links
  5. Fill in Application Name with any name (used for identification).

  6. Leave Generic Application selected.

  7. Check Create incoming link.

  8. Click Continue.

    Link Applications
  9. For the next box, obtain the Consumer Key, Consumer Name, and Public Key from the Datadog Jira integration tile.

  10. Click Continue.

    Link Applications

Configuration

  1. In the Datadog Jira integration tile, enter the URL of your Jira account under step 2.

  2. Click the Setup OAuth1 button:

    Setup Jira Account

Add issues

After installing the JIRA integration, create 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. When the Required fields display for this issue, each of these fields must be filled out.
  5. Other fields listed are optional.
  6. Click the Save button.
Jira Issue

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:

Variable Description
$ID ID of the event (ex: 1234567)
$EVENT_TITLE Title of the event (ex: [Triggered] [Memory Alert])
$EVENT_MSG Text of the event (ex: @webhook-url Sending to the webhook)
$EVENT_TYPE Type of the event (ex: metric_alert_monitor)
$LAST_UPDATED Date when the event was last updated
$DATE Date (epoch) where the event happened (ex: 1406662672000)
$AGGREG_KEY ID to aggregate events belonging together (ex: 9bd4ac313a4d1e8fae2482df7b77628)
$ORG_ID ID of your organization (ex: 11023)
$ORG_NAME Name of your organization (ex: Datadog)
$USER User posting the event that triggered the webhook (ex: rudy)
$SNAPSHOT Url of the image if the event contains a snapshot (ex: https://url.to.snpashot.com/)
$LINK Url of the event (ex: https://app.datadoghq.com/event/jump_to?event_id=123456)
$PRIORITY Priority of the event (ex: normal)
$TAGS Comma-separated list of the event tags (ex: monitor, name:myService, role:computing-node)
$TEXT_ONLY_MSG Text of the event without markdown formatting
$ALERT_ID ID of alert (ex: 1234)
$ALERT_METRIC Name of the metric if it’s an alert (ex: system.load.1)
$ALERT_QUERY Query of the monitor that triggered the webhook
$ALERT_STATUS Summary of the alert status (ex: system.load.1 over host:my-host was > 0 at least once during the last 1m)
$ALERT_TRANSITION Type of alert notification (ex: Triggered)
$HOSTNAME The hostname of the server associated with the event (if there is one).
$ALERT_CYCLE_KEY ID to link events from the time an alert triggers until it resolves.

Use cases

Automatically create issues from Datadog alerts

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

A new issue is created when this alert is triggered.

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.

Monitor Settings

Data Collected

Metrics

The JIRA integration does not include any metrics.

Events

All JIRA issue creations appear as events within Datadog.

Service Checks

The JIRA integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.