Configure the Webhook LAM

The Webhook LAM receives and processes Webhook events forwarded to Moogsoft Enterprise. The LAM parses the data into Moogsoft Enterprise events.

To configure the LAM you require backend access. Alternatively, you can install a Webhook integration in the UI. See Webhook for integration steps.

Configure the Webhook LAM if you want to configure custom properties, set up high availability or configure advanced options that are not available in the UI integration.

Before You Begin

Before you configure the Webhook LAM, ensure you have met the following requirements:

  • If you are using an on-prem version of Moogsoft Enterprise, you have configured it with a valid SSL certificate.

  • Your webhook client can make requests to external endpoints over port 443.

  • The integration client is able to submit a JSON payload and supports basic auth.

Configure the LAM

Edit the configuration file to control the behavior of the Webhook LAM. You can find the file at $MOOGSOFT_HOME/config/Webhook_lam.conf.

The Webhook LAM is a REST-based LAM as it provides an HTTP endpoint for data ingestion. Note that only the generic REST LAM properties in Webhook_lam.conf apply to integrating with Webhook; see the LAM and Integration Reference for a full description of all properties.

Some properties in the file are commented out by default; remove the '#' character to enable them.

  1. Configure the connection properties for the REST connection:

    • address: Address on the Moogsoft Enterprise server that listens for REST messages. Defaults to all interfaces.

    • port: Port on the Moogsoft Enterprise server that listens for REST messages. Defaults to 8888.

  2. Configure authentication:

    • authentication_type: Type of authentication used by the LAM. Defaults to none.

    • basic_auth_static: Username and password used for Basic Auth Static authentication.

    • authentication_cache: Whether to cache the username and password for the current connection when the authentication type is Basic.

  3. Configure the LAM behavior:

    • accept_all_json: Allows the LAM to read and process all forms of JSON.

    • lists_contain_multiple_events: Whether Moogsoft Enterprise interprets a JSON list as multiple events.

    • num_threads: Number of worker threads to use for processing events.

    • rest_response_mode: When to send a REST response. See the LAM and Integration Reference for the options.

    • rpc_response_timeout: Number of seconds to wait for a REST response.

    • event_ack_mode: When Moogfarmd acknowledges events from the Webhook LAM during the event processing pipeline.

  4. Configure the SSL properties if you want to encrypt communications between the LAM and the REST connection:

    • use_ssl: Whether to use SSL certification.

    • path_to_ssl_files: Path to the directory that contains the SSL certificates.

    • ssl_key_filename: The SSL server key file.

    • ssl_cert_filename: The SSL root CA file.

    • use_client_certificates: Whether to use SSL client certification.

    • client_ca_filename: The SSL client CA file.

    • auth_token or encrypted_auth_token: Authentication token in the request body.

    • header_auth_token or encrypted_header_auth_token: Authentication token in the request header.

    • ssl_protocol: Sets the allowed SSL protocols.

  5. Optionally configure the LAM identification and capture logging details:

    • name: Maps to $Laminstancename, so that the agent field indicates events Moogsoft Enterprise ingests from this LAM.

    • capture_log: Name and location of the LAM's capture log file, which it writes to for debugging purposes.

  6. Optionally configure severity conversions. See Severity Reference for further information and "Conversion Rules" in Data Parsing for details on conversions in general.

  7. Optionally configure the process logging details:

    • configuration_file: Name and location of the LAM's process log configuration file. See Configure Logging for more information.

Example

An example Webhook configuration is as follows:

monitor:
{
    name                          : "Webhook Lam",
    class                         : "CRestMonitor",
    port                          : 8888,
    address                       : "0.0.0.0",
    use_ssl                       : false,
    #path_to_ssl_files            : "config",
    #ssl_key_filename             : "server.key",
    #ssl_cert_filename            : "server.pem",
    #use_client_certificates      : false,
    #client_ca_filename           : "ca.crt",
    #auth_token                   : "my_secret",
    #encrypted_auth_token         : "dfJtTQMGiFHfiq7sCmxguBt6Jv+eytkoiKCquSB/7iWxpgGsG2aez3z2j7SuBtKj",
    #header_auth_token            : "my_secret",
    #encrypted_header_auth_token  : "dfJtTQMGiFHfiq7sCmxguBt6Jv+eytkoiKCquSB/7iWxpgGsG2aez3z2j7SuBtKj",
    #ssl_protocols                : [ "TLSv1.2" ],
    authentication_type           : "none",
    authentication_cache          : true,
    accept_all_json               : false,
    lists_contain_multiple_events : true,
    num_threads                   : 5,
    rest_response_mode            : "on_receipt",
    rpc_response_timeout          : 20,
    event_ack_mode                : "queued_for_processing"
},
agent:
{
    name                          : "Webhook",
    capture_log                   : "$MOOGSOFT_HOME/log/data-capture/webhook.log"
},
log_config:
{
    configuration_file            : "$MOOGSOFT_HOME/config/logging/webhook_lam_log.json"
},

Configure for High Availability

Configure the Webhook LAM for high availability if required. See High Availability Overview for details.

Configure LAMbot processing

The Webhook LAMbot processes and filters events before sending them to the Message Bus. You can customize or bypass this processing if required. You can also load JavaScript files into the LAMbot and execute them.

See LAMbot Configuration for more information. An example Webhook LAM filter configuration is shown below.

filter:
{
    presend: "WebhookLam.js",
    modules: [ "CommonUtils.js" ]
}

Start and Stop the LAM

Restart the Webhook LAM to activate any changes you make to the configuration file or LAMbot.

The LAM service name is Webhooklamd.

See Control Moogsoft Enterprise Processes for the commands to start, stop and restart the LAM.

You can use a GET request to check the status of the Webhook LAM. See "Check the LAM Status" in Configure the REST LAM for further information and examples.

Configure the Webhook

After you have the Webhook LAM running and listening for incoming requests, you can test it. See "Test the Webhook" in Webhook.