Get started with Opsgenie as a user
Learn how to configure your profile, get notifications from Opsgenie and view on-call schedules.
Integrate Opsgenie with XMPP/Jabber
What does Opsgenie offer XMPP/Jabber users?
The Opsgenie XMPP/Jabber integration plugin utilizes full capabilities of Opsgenie and provides chat integration with XMPP/Jabber. The integration leverages Opsgenie’s xmpp-specific executable and OEC utility so that Opsgenie alerts and alert actions go into XMPP/Jabber rooms.
Functionality of the integration
When an alert is created in Opsgenie, information saying that an alert is created in Opsgenie goes into your XMPP/Jabber room.
When users acknowledge an alert from their mobile devices using the Opsgenie app, this info is sent to XMPP/Jabber rooms.
When users add comments to alerts in Opsgenie, add note info is sent as well.
OEC subscribes to alert actions in Opsgenie and reflects these actions on your XMPP/Jabber rooms so that you will be notified for Opsgenie alerts.
Installation
The steps below describe how to integrate Opsgenie and XMPP/Jabber using Opsgenie XMPP/Jabber integration plugin. Note that slight alteration to these instructions may be necessary depending on the exact Linux distribution being used and XMPP/Jabber configuration.
Prerequisites
Packages provided support the following systems:
Red Hat based Linux distributions
Debian based Linux distributions
Windows
Download Opsgenie XMPP/Jabber Plugin
Download the latest version of OEC
To download the latest version of XMPP/Jabber package, please use readme file of oec-scripts repository.
For Red Hat Based Distributions
Run the following command : rpm -i opsgenie-xmpp-<your_version>.rpm
During upgrades, rpm package does not overwrite your existing configurations. It saves the new default configuration file as opsgenie-integration.conf.rpmnew. Find more information about rpm upgrade config file handling from here.
To update from version 201X-XX-XX to 2.X.X, add --force parameter.
For example:
rpm -U --force opsgenie-integration-<your_version>.rpm
We suggest backing up configuration files before updating!
If while installing the rpm package you get an error saying that the package is obsoleted, you need to use "rpm -i opsgenie-xmpp-<your_version>.rpm --nodeps" instead.
If you get "is already installed" error, use "rpm -i opsgenie-xmpp-<your_version>.rpm --force" instead.
For Debian Based Distributions
Run the following command : dpkg -i opsgenie-xmpp-<your_version>.deb
For Windows
Unzip Opsgenie integration zip file
Install OEC by following steps in OEC installation page
Add XMPP/Jabber integration in Opsgenie
This integration is only available with Standard and Enterprise plans in Opsgenie, and Premium and Enterprise plans in Jira Service Management.
Adding the integration from your team dashboard will make your team the owner of the integration. This means Opsgenie will assign the alerts received through this integration to your team only. Follow the rest of the steps in this section to set up the integration.
Go to Settings > Integrations. Search for XMPP/Jabber and select Add.
Copy the API Key.
Select Save Integration.
Configure Opsgenie to XMPP/Jabber Integration
Use Opsgenie’s OEC and the XMPP script to send alert actions to XMPP/Jabber rooms. This enables deployment of your own scripts/ability to modify the ones provided and execute customized actions on XMPP.
To use the XMPP integration package, follow the steps in the sections below through the end.
The package that you downloaded also includes OEC utility and the script that is need to be run by OEC.
In order to learn more about how to run OEC you can refer to the Running OEC documentation.
To be able to execute actions in XMPP, OEC gets the configuration parameters from the configuration file. The configuration file can be found under /home/opsgenie/oec/conf/config.json
In order to use this feature "Send Alert Actions To XMPP" checkbox should be enabled in Opsgenie XMPP/Jabber Integration.
Configuration Parameters |
| Location |
|---|---|---|
apiKey | XMPP/Jabber integration API Key. Copy the API Key from XMPP/Jabber Integration page and paste it to apiKey field in conf file. | /home/opsgenie/oec/conf/config.json |
hostUrl | Service name for the XMPP/Jabber server you are using. This hostUrl is used to create a connection with your XMPP/Jabber server. | /home/opsgenie/oec/conf/config.json |
username | Username used during login to the XMPP/Jabber server. | /home/opsgenie/oec/conf/config.json |
password | Password that used during login to the XMPP/Jabber server. | /home/opsgenie/oec/conf/config.json |
room | Room name which alert actions are sent right into. | /home/opsgenie/oec/conf/config.json |
Was this helpful?