Application Real-Time Monitoring Service:Integrate Jira with ARMS alert management by using a Jira account

How it works

ARMS Alert Management connects to a Jira instance through a Jira account. When an alert fires, ARMS creates an issue in the specified Jira project and maps alert severity levels to Jira priorities.

Each sync direction requires its own setup:

• ARMS to Jira -- Configured during integration setup. Alert operations (claim, comment, resolve) automatically sync to linked Jira issues.

• Jira to ARMS -- Requires a Jira webhook that sends issue updates (reassignment, comments) back to ARMS.

User matching: ARMS matches users between the two systems by email address or username. If no matching Jira user is found, the alert cannot be pushed to Jira.

Prerequisites

Before you begin, make sure that you have:

• Access to the ARMS console with Alert Management permissions

• A Jira instance URL, username, and password with permissions to create issues

Step 1: Create the Jira integration

1. Log on to the ARMS console. In the left-side navigation pane, choose Alert Management > Integrations.

2. On the Integrations page, click the Notification Integrations tab, and then click JIRA.

3. In the Add Integration wizard, complete the following steps:

   1. In the Basic Information step, configure the connection:

      • Enter the integration name and Jira instance URL.

      • Set Verification Method to Log On with Jira Account.

      • Enter the username and password of the Jira instance.

      • (Optional) Add a description.

      • Click Test Connection.

   2. After the Connection Succeeded message appears, click Next.

      Note

      If the connection fails, verify the URL, username, and password, then click Test Connection again.

   3. In the Alert Source Configuration step, configure the alert-to-issue mapping:

      Parameter	Description	Example
      Project	The Jira project where ARMS creates issues for alerts.	Monitoring Project
      Type	The Jira issue type. Valid values: Task, Subtask, Improvement, New feature, Bug, Epic, Story.	Bug
      Issue status when the alert is disabled	The Jira status that marks an issue as resolved. When a Jira issue reaches this status, ARMS stops syncing further alert operations to the issue. Valid values: To Do, In Progress, In Review, Done.	Done
      Priority	Maps ARMS alert severity levels to Jira issue priorities.	P1: Highest, P2: High, P3: Medium, P4: Low, P5: Lowest

      Important

      • If an alert severity level is not mapped to a Jira priority, alerts at that level are not pushed to Jira.

      • Severity-to-priority mapping is applied only on the first push. Subsequent changes to alert severity alone do not update the Jira issue priority.

      • We recommend selecting Done as the resolved status. If you select a different value and the issue later transitions to Done, ARMS continues syncing alert operations to the issue.

   4. Click Save.

Step 2: Push alerts to Jira

After you create the integration, push alerts to Jira in any of the following ways.

Option A: Automatic push through a notification policy

Set up a notification policy to automatically create a Jira issue whenever a matching alert fires.

1. In the left-side navigation pane, choose Alert Management > Notification Policies.

2. On the Notification Policy page, click Create Notification Policy, or edit an existing policy.

3. In the When an alert is triggered, section, specify at least one contact or contact group for the Contacts parameter.

   Important

   • ARMS matches the first contact in the policy to a Jira user by email address or username, and assigns that user as the issue handler.

   • If no matching Jira user is found, the alert is not pushed to Jira.

4. Select the Jira integration you created for Ticket System. Configure other parameters as needed. For more information, see Create and manage a notification policy.

5. Click Save.

   Alerts that match the notification policy are now automatically pushed to Jira.

Option B: Manual push from the alert sending history page

Push an individual alert to Jira from its detail page.

1. In the left-side navigation pane, choose Alert Management > Alert Sending History.

2. On the Alert Sending History page, in the upper-right corner, associate a handler with the alert, then click the alert name.

   Important

   • ARMS matches the operator to a Jira user by email address or username, and assigns that user as the issue handler.

   • If no matching Jira user is found, the alert is not pushed to Jira.

3. On the alert details page, click the icon in the upper-right corner, then click Push Alerts.

4. In the dialog box, select the Jira integration from the Ticket System drop-down list, and click OK.

After the alert is pushed, a link to the corresponding Jira issue appears on the alert details page.

Option C: Push from a DingTalk alert card

Push an alert to Jira directly from a DingTalk group alert card.

Use either of the following methods:

• On the alert card, click Push Alerts and select the Jira integration.

• Click the alert name on the card. In the details panel, click Settings > Push Alerts, and select the Jira integration.

After the alert is pushed, a link to the corresponding Jira issue appears on the alert details page.

Operations synced from ARMS to Jira

After you push an alert to Jira, the following ARMS operations automatically sync to the linked issue:

Step 3: Set up Jira-to-ARMS sync

To sync Jira issue updates (reassignment, comments) back to ARMS, create a webhook in Jira.

1. On the Integrations page in ARMS, click the Notification Integrations tab and copy the integration key for the Jira integration.

   

2. Log on to your Jira instance. In the upper-right corner, click the Settings icon, then click System.

   

3. Enter the administrator password and click OK.

4. In the left-side navigation pane of the System page, click Webhooks.

5. Click + Create a webhook.

   

6. Set the URL to the following value, replacing {token} with the integration key you copied in step 1:

   http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}

   

7. Configure other webhook parameters as needed. For details, see the Jira webhooks documentation. Click Create.

After the webhook is active, the following Jira operations sync to ARMS: