Action API

by Mahalya R | October 9, 2023

How Can We Help?

Last Updated On
Print

Heal generates events whenever anomalies or signals are created. These events can be used to launch healing actions or to create integrations with ITSM tools. Heal itself uses these events to provide out-of-box notifications for signals, and to provide out-of-the-box forensics. Action API can be used to trigger custom actions for these events.

Action APIs Listing

  • Anomaly_Forensic Event
  • Anomaly_Heal Event
  • Signal_Create Event
  • Signal_Update Event
  • Webhook

Anomaly_Forensic Event

When an anomaly is created for an instance in Enterprise, an “Anomaly_forensic event” gets generated. This helps in triggering the Forensics script that can collect additional diagnostic information on the instance for which the anomaly was created.

Use case: When the information collected by the Forensics script would be required as input or drive your heal script, you can choose to integrate your code with Anomaly_Forensic Event. This will display the Forensics output on the Signal screen.

Anomaly_Heal Event

Anomaly Heal Event is generated once the Anomaly_Forensic Event is generated on an anomaly in the Enterprise. This event can be used to trigger any healing script that can prevent the anomaly from snowballing into a bigger problem.

Usage: When you want only the Heal event to be executed with exposing the Forensic output in the Signals screen, you can choose to integrate your code with the Anomaly_Heal Event.

Signal_Created Event

You can integrate the Signal_Created Event with the ITSM in your Organisation. By this integration whenever a new signal is generated in the system, this event will create a ticket or incident in the ITSM.

Usage

The event handler library is exposed for you to create your own module or plugin in ‘.jar’ format. Your modules should be created for the event in which the integration is required. Once your module is ready for use, you can integrate the same with the Action APIs.

Integration

This section describes how you can integrate your module with Heal.

JAR Placement

  1. Log on to the Heal server, where the A1 Event Handler is present.
  2. Navigate to ‘plugins’ folder of A1 Event Handler
  3. Copy the “<shaded/uber>.jar” created in the plugins folder.

Configuration Steps

  1. Log on to the Heal server, where the A1 Event Handler is present.
  2. Navigate to ‘config’ folder of A1 Event Handler.
  3. Open the ‘plugin-details.json’ file.
  4. Make a copy of the json object as follows in the same file.

{

“name”: “<Name of the Plugin>”,

“className”: “<Class name of the Plugin Interface implemented >”,

“eventType”: [“FORENSIC_OUTPUT” or “NOTIFICATION_OUTPUT”], //till 5.0.6 & from 5.0.7 “eventType”: [“Anomaly_Forensic” or “Anomaly_Heal” or “Signal_Created” or “Signal_Updated],

“queueName”: “a1-event-messages”,

“eventName”: “<Name for your action>”,

“contextDetails”: {

“key”: “value”

}

  1. Update the details as required without changing the Queue name.
  2. Save the file.

Sample:

The JSON Sample to be added in the details-plugins.json for the XR Travels to create a ticket in the support system on the event of notification would be as follows.


					
{ 
“name”: “XRTravelsPlug”, 
“className”: “com.x.x.plugin.XRTPlugin”, 
“eventType”: [“NOTIFICATION_OUTPUT”], 
“queueName”: “a1-event-messages”, 
“eventName”: “Ticketing”, 
“contextDetails”: { “uri”: “https://xrtravels.support.com/ticket/create”, 
“username”: “xruser”, 
“connectionPoolSize”: “10”,
}
Table of Contents