IBM Z ChatOps Integration (public preview)
To send alert notifications for Instana events to IBM Z ChatOps in real time, create an IBM Z ChatOps alert channel.
Creating an IBM Z ChatOps alert channel
To create an IBM Z ChatOps alert channel, click Settings > Team Settings > Events & Alerts > Alert Channels > Add Alert Channel in the Instana UI.
-
The Z ChatOps Incidents URL field needs to point to the IBM Z ChatOps instance to make a post request for incidents, such as
https://your_microservice_server:your_port_number/ibm/bnz/v1/incident
. For more information, see Integrating with IBM Z Chatops. -
The Token field needs to be a JWT bearer token, which can be extracted from the IBM Z ChatOps Microservice.
-
The Channel field needs to contain the channel name from where you wish to receive alerts in your channel service (that is, the channel name in
**Mattermost**
, which is a communication tool that is used to integrate with IBM Z ChatOps).
Alert payload details
The alerts are received when an event is triggered in the Instana UI. A URL endpoint is provided when you create an IBM Z ChatOps alert channel. The alert payload that is received is sent to this URL endpoint.
When an IBM z/OS entity triggers an alert within Instana, a payload corresponding to the specific entity is sent to IBM Z ChatOps. Instana supports the following IBM z/OS entities:
- CICS
- Db2
- IMS
The alert payload contains the following information:
- Id: ID of the event.
- Summary: Title of the event.
- Description: Description of the event.
- Priority: Instana events that have a critical severity are mapped to
high
priority, and all other events are mapped tolow
priority. - Severity: Instana events that have a critical severity are mapped to
critical
severity, events with warning severity are mapped tominor
severity, and rest of the events are mapped tolow
severity. - Category: Alert.
- DateTime: Provides the reported and occurred timestamp in UTC (Coordinated Universal Time) format.
- Location: The Resource Name contains the name of the entity for which the event is triggered. Additional information is included for events on IBM Z entities as follows:
- CICS: Sysplex Name, System Name, SMF ID.
- Db2: SMF ID.
- IMS: SMF ID.
- Status:
New
orClosed
event. - ReportedBy: Instana.
- ChatTool Posted: Includes the name of the Mattermost channel that is provided by the user.
- Links: Link to the Instana event is attached.
- Customized Fields: Based on the type of event, the following data is attached in the alert:
- CICS: Component, CICS Region and Cicsplex Name.
- IMS: Component and IMS ID.
- Db2: Component and Db2 ID.
Alerting example
On open issues or incidents (CICS)
See the following example of the alert payload of an IBM CICS event with the type as Issue
and the status as Open
: