Configure the Node.js LAM

The Node.js LAM is an endpoint for HTTP notifications from a Node.js application. The LAM parses the data from the app into Moogsoft Onprem as events.

You can install a basic Node.js integration in the UI. See Node.js for integration steps.

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

See the Node.js documentation for information on Node.js components.

Before You Begin

The Node.js integration has been validated with Node.js v1.6. Before you set up the LAM, ensure you have met the following requirements:

You have a working knowledge of Node.js and can write JavaScipt code.
You have access to the Node.js source code and the ability and permissions to rebuild your Node.js app.
Your Node.js app can make requests to external endpoints over port 443. This is the default.

If you are configuring a distributed deployment refer to High Availability Overview first. You will need the details of the server configuration you are going to use for HA.

Configure the LAM

Edit the configuration file to control the behavior of the Node.js LAM. You can find the file at $MOOGSOFT_HOME/config/nodejs_lam.conf

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

Some properties in the file are commented out by default. Uncomment properties to enable them.

Configure the properties for the REST connection:
- address: Address on the Moogsoft Onprem server that listens for REST messages. Defaults to all interfaces.
- port: Port on the Moogsoft Onprem server that listens for REST messages. Defaults to 48011.
Configure authentication:
- authentication_type: Type of authentication used by the LAM. Defaults to none.
- authentication_cache: Whether to cache the username and password for the current connection when the authentication type is Basic.
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_protocols: Sets the allowed SSL protocols.
Configure the LAM behavior:
- num_threads: Number of worker threads to use when 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 REST LAM during the event processing pipeline.
- accept_all_json: Allows the LAM to read and process all forms of JSON.
- lists_contain_multiple_events: Whether Moogsoft Onprem interprets a JSON list as multiple events.
Optionally configure the LAM identification and capture logging details:
- name: Maps to $Laminstancename, so that the agent field indicates events Moogsoft Onprem ingests from this LAM.
- capture_log: Name and location of the LAM's capture log file, which it writes to for debugging purposes.
Optionally configure severity conversion. See Severity Reference for further information and "Conversion Rules" in Tokenize Source Event Data for details on conversions in general.
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.Configure Logging

Example

The following example demonstrates a Node.js LAM configuration.

monitor:
{
    name                          : "Nodejs Lam",
    class                         : "CRestMonitor",
    port                          : 48011,
    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                          : "Nodejs",
    capture_log                   : "$MOOGSOFT_HOME/log/data-capture/nodejs_lam.log"
},
log_config:
{
    configuration_file            : "$MOOGSOFT_HOME/config/logging/nodejs_lam_log.json"
},

Configure for High Availability

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

Configure LAMbot Processing

The Node.js 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 Node.js LAM filter configuration is shown below.

filter:
{
    presend: "nodejsLam-SolutionPak.js",
    modules: [ "CommonUtils.js" ]
}

Start and Stop the LAM

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

The LAM service name is nodejslamd.

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

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

Configure Your Node.js App

After you have the Node.js LAM running and listening for incoming requests, you can configure your Node.js application. See "Configure your Node.js App" in Node.js.

In this section: