Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.
Versions
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store
Close

Configure the MID WebService Event Collector Context

Configure the MID WebService Event Collector Context

Configure the MID WebService Event Collector Context to provide a URL method to push event messages from an external source to the MID Server.

Before you begin

Role required: evt_mgmt_admin

About this task

The default format of the URL to push event messages from an external source to the MID Server is http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform=jsonv2 This URL provides good performance.

To push event messages from an external source that are not in jsonv2 format, the URL is http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event/Transform={Transform_script_name}, where the {Transform_script_name} variable is the full name of the script. For example, assume that the script name is IncomingEvents, then the URL is: http://10.118.69.27:8097/api/mid/em/inbound_event/Transform_IncomingEvents

Note: The URL in the format http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name}is also supported.
Note: The date format for events is yyyy-MM-dd HH:mm:ss.

Procedure

  1. Navigate to Event Management > Event Listener (Push) > MID WebService Event Listener.
  2. In the MID WebService Event Collector Contexts list, click New.
  3. Fill in the fields, as appropriate.
    Table 1. Fields in the MID WebService Event Collectors Context form
    Field Description
    Name A unique name for this collector for easy identification.
    Short description Enter a brief, meaningful description of this collector.
    MID Web Server Extension Specify and then start the MID Web Server extension. The supported authentication methods are listed in the Authentication Type field of the MID Web Server extension. For information about how to configure a MID Web Server extension, see Configure the MID Web Server.
    Status This field is auto-populated with the status of the MID Web Server extension. This field is blank until the MID Web Server extension is started. After issuing a command to the MID Web Server extension, one of the following values is displayed:
    • Started: The collector is running.
    • Stopped: The collector is not running.
    • Offline: The MID Server is down.
    • Error: The collector failed with an error (the error message is displayed in Error Message).
    • Warning: A run-time exception has occurred.
    Execute on Specific MID Server or Specific MID Server Cluster, as defined on the specified MID Web Server extension.
    MID Server The Specific MID Server or Specific MID Server Cluster, as defined on the specified MID Web Server extension.
    Executing on The name of the MID Server on which the MID Web Server extension is running.
  4. Right-click the form heading and click Save.
  5. Under Related Links, click Start to start the collector.
    Table 2. Commands in the Event Management Context form
    Related Link Description
    Start If it is not running, start the collector. This action verifies that a web service API endpoint with the Event Management application is running on the MID Server.
    Stop Stops the running collector on the configured MID Server. If the collector is not running, no action is taken.
    Restart Stops, then starts the collector on the configured MID Server.
    Update parameters Sends updated parameters to the collector. Parameters are also updated when the Event Management MID Server context extension is updated. If you click this control when the collector is not running, no update is made.

Example

Showing the use of the URL to transform JSON v2 formatted event messages

Assume that JSON v2 formatted event messages are sent to the MID Server. When using the jsonv2 URL, there is no need to use a script include.

Table 3. Data for the JSON v2 example
Field Value
MID_Server_IP 10.218.64.27
MID_Web_Server_Extension_Port 8097
Event message format jsonv2

Replace the variables in the default format of the URL http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2with values from the preceding table:http://10.218.64.27:8097/api/mid/em/inbound_event/jsonv2

Example showing the URL to push messages not in jsonv2 format

The format of the URL to push event messages from an external source that are not in jsonv2 format is http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event/Transform={Transform_script_name}. The script name must be specified as the Transform header parameter. The Transform header parameter must start with the prefix TransformEvents_.

For this example, assume that the script name is ExternalSource, the URL is therefore:http://10.138.64.27:8097/api/mid/em/inbound_event/Transform_ExternalSource

Example showing JSON v2 formatted event messages
Note: When copying and pasting the text following, hidden characters might also be copied and can cause unexpected results.
{
    "records":
    [
       {
       "source" : "Simulated",
       "node" : "nameofnode",
       "type" : "High Virtual Memory",
       "resource" : "C:",
       "severity" : "1",
       "description" : "Virtual memory usage exceeds 98%",
       "ci_type" : "cmdb_ci_app_server_tomcat",
       "additional_info" : {"name" : "My Airlines"}
       },
       {
       "source" : "Simulated2",
       "node" : "nameofnode2" ,
       "type" : "High Virtual Memory2",
       "resource" : "D:",
       "severity" : "4",
       "description" : "Virtual memory usage exceeds 98%",
       "ci_type" : "cmdb_ci_app_server_tomcat",
       "additional_info" : {"name" : "My Airlines2"}
       },
       {
       "source" : "Simulated3",
       "node" : "nameofnode3",
       "type" : "High Virtual Memory3", 
       "resource" : "F:",
       "severity" : "2",
       "description" : "Virtual memory usage exceeds 98%",
       "ci_type" : "cmdb_ci_app_server_tomcat",
       "additional_info" : {"name" : "My Airlines3"}
       }
  ]
}