HTTP Listener plugin
The HTTP Listener plugin receives arbitrary JSON data at a specified address and forwards it to an existing Create Your Own Integration (CYOI) endpoint. The HTTP Listener plugin must be configured and enabled to begin collecting event data.
When to use the HTTP Listener plugin
Use the APEX AIOps Incident Management HTTP Listener plugin with the APEX AIOps Incident Management Collector, when you:
Do not want to make direct outbound calls from your environment.
Can install an APEX AIOps Incident Management Collector on a host in your environment to act as a proxy.
Configure a Create Your Own Integration
To ingest data using the HTTP Listener plugin, you also need to configure a Create Your Own Integration (CYOI) to send data to the plugin. You can do this before or after you enable the plugin. For more help about configuring using CYOI, see Create Your Own Integration (CYOI).
In your Incident Management instance, click Integrations > Ingestion Services > Create Your Own Integration.
Click Add New Integration.
Go to Initial Setup. Skip the Before You Begin instructions as the plugin does not use authentication. Specify the following information:
Incident Management Endpoint - Enter a name for the Endpoint (API). You will be able to select this name from a menu, as the HTTP Listener Plugin configuration panel is populated with this name.
API Description - Enter a description for the Endpoint (API) that you named.
Data Type - Select Events as tje data type.
Click Save.
Configure and enable the HTTP Listener plugin
You must have a collector installed to use the HTTP Listener plugin. See Install a Linux or MacOS collector or Install a Windows OS collector for instructions on setting up a new collector.
When you select the HTTP Listener plugin in the Plugins tab, the pop-up panel provides links to install a collector or configure the HTTP Listener plugin.
Parameter configuration:
From the HTTP Listener plugin > Configuration tab, define the following HTTP Listener Plugin parameters:
Address — Provide the IP Address where you want the plugin to receive data from the HTTP Listener. Use the IP address of the host where you installed your Incident Management Collector. The default is
0.0.0.0.Port — Provide the port number where you want the plugin to receive alerts from the HTTP Listener. The default is set to port
8084.Create Your Own Integration URL — When you set up a CYOI in Incident Management, the HTTP Listener Configuration > Create Your Own Integration URL menu is pre-populated with the name of your CYOI URL. Select the name to use that integration.
Toggle the Enable option on when you are ready to start plugin data ingestion.
Map your CYOI Data
To map your data sources to Incident Management targets for the plugin to deliver event incidents or alerts:
Click Integrations > Ingestion Services > Create Your Own Integration (CYOI).
Click the integration name that you specified when you created your CYOI.
In the Map Your Data section, go to Payload Fields and APEX AIOps Incident Management Target Fields.
Click + Add a Mapping to add an additional mappings.
You can also delete the source and target row that does not apply to your data payload by clicking the trash icon next to the row.
Validate the HTTP Listener plugin integration
To validate the integration, you have the following options:
Test to see if the plugin is working by sending a curl command with JSON data to the IP address that you specified on the plugin configuration tab.
Go to Integrations > Ingestion Services > Create Your Own Integration.
Click your named Create Your Own Integration (CYOI) integration and go to Map Your Data.
In Incident Management, check Incidents > Incidents or Alerts to see if the HTTP Listener data is flowing into the plugin.
Go to Incident Management Integrations > Ingestion Services > Collectors and click your HTTP Listener Collector > Collector Logs to help troubleshoot your installation and configuration.