Configure the MID Web Server extension

The MID Web Server is an extension that enables external clients to push metric data and events to the MID Server. This extension is used to listen for raw metric data and external events and it provides options for authentication and data security. The raw data is collected by the MID Server and then transmitted to the instance.

Before you begin

Role required: evt_mgmt_admin
  • Deploy and start a MID Server.
  • The ITOM Metric Management (com.snc.sa.metric) plugin must be enabled.
  • The Enable REST Listener option must be selected in the ITOA MetricExtension. For more information, see Configure the Operational Metric extension.
  • If the Secure Connection option is going to be selected, first obtain a server certificate. For more information, see Setup certificate for secure connection.

About this task

The MID Web Server extension runs for as long as it is enabled. The extension starts a web server on the MID Server to serve web requests from external systems. The raw data is pushed to the extension from a client or using customized script.

The configuration of the MID Web Server extension includes these settings:
  • Authentication type, which can be set to the more advanced option - Keybased.
  • Secure Connection, which lets you choose whether incoming and outgoing data is secured when transmitted. If you choose the advanced secured option, it requires that you obtain a certificate from a well-known certificate authority, and then provide the Keystore Certificate Alias and the Keystore Password.

Procedure

  1. Navigate to MID Server > Extensions > MID Web Server.
  2. In the MID Web Server Contexts list, click New.
  3. Fill in the fields, as appropriate.
    Table 1. Fields in the MID Web Server Context form
    Field Description
    Name A unique name for this MID Web Server collector for easy identification.
    Short description Enter a brief, meaningful description of this collector.
    Extension Specify MID Web Server.
    Status This field is auto-populated with the status of the extension. The field is blank until the extension is started. After issuing a command to the extension, one of the following values is displayed:
    • Started: The extension is running.
    • Stopped: The extension is not running.
    • Offline: The MID Server is down.
    • Error: The extension failed with an error (the error message is displayed in Error Message).
    • Warning: A run-time exception has occurred. The extension continues to work.
    HTTP/HTTPS Port Port number on which you want to listen to incoming requests.
    Authentication Type Select one:

    Keybased

    • Create an authentication token that is sent with each request.
    • Send this authentication token in the request header Authorization.
    To create an authentication token:
    1. Construct a string using defined elements of the HTTP/HTTPS request.
    2. Create a Hash Message Authentication Code (HMAC) of the string, that is, sign the string generated in previous step with the auto-generated secret key. The key is unique per context.

    See example, Configure MID Web Server for metric data

    Note: A valid timestamp (using the HTTP Date header) is required for the authenticated request. In addition, the timestamp must be within 15 minutes of the time on the MID Server.

    Basic

    • The user must provide a username and password. The same username and password must be provided for every request.
    • On the instance, the password is stored encrypted and it is sent also to the MID Server encrypted.
    • In the MID Server, the password is saved in memory.
    • When the request is received, the password is decrypted and matched with the password provided in the request.
    Secret Key [Read-Only] The value that is generated when keybased authentication is selected for the Authentication Type field.
    Error Message Message describing any error that causes a command, such as Start or Stop, to fail. This field only appears when the value in the Status field is Error.
    Execute on Location for running this extension. The available options are Specific MID Server or Specific MID Server Cluster.
    MID Server Depending on your selection in Execute on, the name of the designated MID Server, or MID Server cluster respectively:
    • If you selected Specific MID Server, the name of the designated MID Server.
    • If you selected Specific MID Server Cluster, the name of the designated MID Server cluster.
    The MID Web Server extension supports MID Server clusters that are configured for failover. If you selected the MID Server cluster option, an algorithm determines which MID Server in the cluster runs the extension. The extension can run on only one MID Server. If the MID Server in the cluster that runs the Mid Web Server extension goes down, the extension automatically starts to run on the secondary MID Server. The secondary is the MID Server that is up when the primary goes down.
    Note: Ensure that in the Supported Applications section of the MID Server, either ServiceAnalytics or ALL applications is selected.
    Executing on [Read-Only] The name of the MID Server on which the extension is running. This field shows the name of the MID Server even if the MID Server is down. If the user stops the extension, this field is empty.
  4. Select Secure Connection to provide extra protection, if required. When selected, enter the values for these fields:
    1. In the Keystore Certificate Alias field, enter the name of the keystore certificate.
    2. In the Keystore Password field, enter the keystore password.
  5. Click Save to save the Operational Metric data.
  6. Under Related Links, click Start to start the collector.
    Table 2. Commands in the MID Web Server form
    Related Link Description
    Start If it is not running, starts the MID Web Server.
    Stop Stops the MID Web Server. If the collector is not running, no action is taken.
    Restart Stops, then starts the MID Web Server.
    Test parameters The test is not relevant to the MID Web Server. Parameters are not tested or validated when Test is run.
    Update parameters Stops and then starts the MID Web Server with new parameters. If none of the parameters are modified, no update is made.
    For an example that describes how to prepare an authentication token, see Configure MID Web Server for metric data.