Redmine Integration

Redmine is an open-source project management web application.

Use Opsgenie's Redmine integration to forward Opsgenie alert activity to Redmine as issues. Opsgenie creates new issues in a Redmine project when an alert is created, add notes to the issue when a note is added to the alert, and changes the issue state when the alert is acknowledged by someone etc.

Installation

The steps below describe how to integrate Opsgenie and Redmine using Opsgenie Redmine integration plugin. Note that alteration of these instructions may be necessary depending on distribution.

Download Opsgenie Redmine Plugin

For Windows

  1. Download Opsgenie Redmine (zip)
  2. Unzip opsgenie integration zip file which contains OEC package into a directory (C:\opsgenie-integration is the preferred path.)
  3. Install OEC by following steps in OEC installation page

For Red Hat Based Distributions

  1. Download Opsgenie Redmine (Linux RPM)
  2. Run following command : rpm -i opsgenie-redmine-<your_version>.rpm

🚧

During upgrades, the rpm package does not overwrite your existing configurations. It saves the new default configuration file as opsgenie-integration.conf.rpmnew. You can find more information about rpm upgrade config file handling from here.

🚧

If you want to update from version 201X-XX-XX to 2.X.X, you must add --force parameter. E.g.: rpm -U --force opsgenie-integration-<your_version>.rpm

We suggest that you backup your configuration files before update!

For Debian Based Distributions

  1. Download Opsgenie Redmine (Linux DEB)
  2. Run following command : dpkg -i opsgenie-redmine-<your_version>.deb

Add a OEC Integration in Opsgenie

  1. Please create an Opsgenie account if you haven't done so already.
  2. Go to Opsgenie's OEC Integration page.
  3. Click Save Integration. An "API Key" is generated for the integration. This key is used by OEC to authenticate with Opsgenie.

Plugin Configuration

OEC application configuration file is located in:

  • For Windows: <OEC_HOME>/../conf/opsgenie-integration.conf
  • For Linux: /etc/opsgenie/conf/opsgenie-integration.conf

Configuration Parameters

apiKey

Copy the API key from the OEC integration you've created above.

redmine.url

The url to the host that Redmine is running on.

redmine.projectId

The id of the Redmine project. Opsgenie creates the issues on this project.

redmine.apiKey

The API access key that can be found on the Redmine account page (/my/account). Note that you need to "enable REST web service" from Redmine Administration settings.

redmine.customFieldId

Optional. Needed by Opsgenie for updating issues: adding notes; acknowledging or closing an issue. If you want to benefit from these functionalities, create a custom field with the name alert_id in Redmine Administration settings. Uncomment redmine.customFieldId in the configuration file and set it to the custom field's id.

redmine.inProgressStatusId

Optional. Opsgenie uses the status_id to change the issue status when an alert is acknowledged at Opsgenie. Create an "Issue status" in Redmine Administration Settings to hold for acknowledged state; then set the id of the status to redmine.inProgressStatusId in the configuration file.

redmine.closedStatusId

Optional. Opsgenie uses the status_id to change the issue status when an alert is closed at Opsgenie. Create an "Issue status" in Redmine Administration Settings to hold for closed state; then set the id of the status to redmine.closedStatusId in the configuration file.

🚧

Redmine integration package does not support SSL v1.0. If the Redmine Server has SSL v1.0, we suggest upgrading the SSL server.

Updated 10 months ago


Redmine Integration


Redmine is an open-source project management web application.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.