Configure the CA Spectrum LAM

CA Spectrum provides deep application monitoring and performance lifecycle management. The CA Spectrum LAM connects to CA Spectrum, fetches the incidents and forwards them to Moogsoft Enterprise.

The CA Spectrum API does not supply events with status 'clear' for collection by Moogsoft Enterprise.

You can install a basic CA Spectrum integration in the UI. See CA Spectrum for integration steps.

Before You Begin

The CA Spectrum LAM has been validated with CA Spectrum OneClick v10.2. Before you start to set up your integration, ensure you have met the following requirements for each CA Spectrum server:

You have the URL for your CA Spectrum server.
The port for your CA Spectrum server is open and accessible from Moogsoft Enterprise.
You have credentials to connect to the CA Spectrum server.
You have set up alarms in CA spectrum.
Your CA Spectrum server is able to accept HTTP/HTTPS requests.

Additionally, you can provide optional configuration details. See the LAM and Integration Reference for a description of all properties.

Configure the LAM

Edit the configuration file to control the behavior of the CA Spectrum LAM. You can find the file at $MOOGSOFT_HOME/config/caspectrum_lam.conf

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

Configure the connection properties for each CA Spectrum target:
- url: CA Spectrum request URL including host and port.
- user: CA Spectrum account user.
- password or encrypted_password: CA Spectrum account password or encrypted password.
Configure the LAM behavior for each target:
- request_interval: Length of time to wait between requests, in seconds.
- max_retries: Number of times the LAM attempts to reconnect after connection failure.
- retry_interval: Length of time to wait between reconnection attempts, in seconds.
- recovery_interval: Length of time to wait between recovery requests in seconds. Must be less than the request_interval set for each target. Defaults to 20.
- max_lookback: The period of time for which to recover missed events in seconds. Defaults to -1 (recover all events since the last successful poll).
- timeout: The value in seconds to wait for a request to complete before timing out. If a timeout occurs, the LAM will wait for the next poll before trying again.
- limit: The number of events that can be fetched here. The default is set to 1000. If 0, or any negative value is set, it will revert to the default value i.e. 1000.
If you want to connect through a proxy server, configure the host, port, user, and password or encrypted password properties in the proxy section for the target.
Configure the SSL properties for each target if you want to encrypt communications between CA Spectrum and Moogsoft Enterprise:
- disable_certificate_validation: Whether to disable SSL certificate validation.
- path_to_ssl_files: Path to the directory that contains the SSL certificates.
- server_cert_filename: Name of the SSL root CA file.
- client_key_filename: Name of the SSL client key file.
- client_cert_filename: Name of the SSL client certificate.
Configure landscapes.
- landscape: The list of landscape names to retrieve alarms for.
Optionally configure filters:
- attributeName: Specifies an attribute to filter by.
- acknowledged: Detemines whether to only fetch acknowledged events.
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.
Optionally configure severity conversions. 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

monitor:
{
    name: "CA Spectrum Lam Monitor",
    class: "CCASpectrumMonitor",
    request_interval: 60,
    max_retries: -1,
    retry_interval: 60,
    retry_recovery:
    {
        recovery_interval: 20,
        max_lookback: -1
    },
    targets:
           {
           target1:
                  {
                      url: "http://localhost:8080", 
                      user_name: "user name", 
                      password: "password",
                      #encrypted_password: "ieytOFRUdLpZx53nijEw0rOh07VEr8w9lBxdCc7229o=",
                      request_interval: 60,
                      max_retries: -1,
                      retry_interval: 60,
                      retry_recovery:
                                    {
                                        recovery_interval: 20,
                                        max_lookback: -1
                                    },            
                      #proxy:
                      #{
                          #host: "localhost",
                          #port: 8181,
                          #user: "user",
                          #password: "pass",
                          #encrypted_password: "ieytOFRUdLpZx53nijEw0rOh07VEr8w9l="
                          #},
                          disable_certificate_validation  : false,
                          path_to_ssl_files: "config",
                          server_cert_filename: "server.crt",
                          #client_key_filename: "client.key",
                          #client_cert_filename: "client.crt",                   
                          limit: 1000,
                          timeout: 120,
                          filter:
                          {
                              acknowledged: false
                          }              
                      },
           target2:
                  {
                      url: "http://localhost:8080",
                      user_name: "user name",
                      password: "password",
                      request_interval: 60,
                      max_retries: -1,
                      retry_interval: 60,
                      disable_certificate_validation: false,
                      #path_to_ssl_files: "config",
                      #server_cert_filename: "server.crt",                     
                      limit: 1000,
                      landscape: ["landscape-1", "landscape-2"],
                      timeout: 120,
                      filter:
                            {
                                acknowledged: "false"                        
                            }
                  }
           }
},
agent:
{
    name: "CA Spectrum",
    capture_log: "$MOOGSOFT_HOME/log/data-capture/ca_spectrum_lam.log"
},
log_config:
{
    configuration_file: "$MOOGSOFT_HOME/config/logging/caspectrum.log.json"
}

Configure for High Availability

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

Configure Hexadecimal Mapping

The spectrum_alarm_attribute property allows you to map the hexadecimal codes of alarm fields the LAM receives to variable names.

Below is a list of the default mappings. To map any other alarm fields, enter its hexadecimal code within this property and map it to a variable of your choice.

Hexadecimal Code	Mapped Variable
0x10000	`modelTypeName`
0x10001	`modelTypeOfAlarmedModel`
0x10009	`securityString`
0x1000a	`condition`
0x1006e	`modelName`
0x11ee8	`modelClass`
0x11f4d	`acknowledged`
0x11f4e	`creationDate`
0x11f4f	`alarmStatus`
0x11f50	`causeCode`
0x11f52	`eventIdList`
0x11f53	`modelHandleOfAlarmedModel`
0x11f54	`primaryAlarm`
0x11f56	`severity`
0x11f57	`troubleshooter`
0x11f9b	`userClearable`
0x11f9c	`alarmId`
0x11fc4	`alarmSource`
0x11fc5	`occurrences`
0x11fc6	`troubleshooterModelHandle`
0x12022	`troubleTicketId`
0x1296e	`originatingEvent`
0x12a04	`symptomList`
0x12a05	`causeList`
0x12a06	`symptomCount`
0x12a07	`causeCount`
0x12a56	`significantModelId`
0x12a63	`webContextURL`
0x12a6f	`eventSymptomList`
0x12a70	`eventSymptomCount`
0x12a82	`IPtoDomainMap`
0x12b4c	`alarmTitle`
0x12c05	`secureDomainDisplay`
0x12d7f	`networkAddress`
0x12d83	`secureDomainAddress`
0x1321a	`lastOccurrenceDate`
0x129aa	`modelId`
0x129ab	`modelTypeId`
0x11d42	`domainName`
0x129ac	`domainId`

Configure LAMbot Processing

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

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

Start and Stop the LAM

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

The LAM service name is caspectrumlamd.

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 CA Spectrum LAM. See "Check the LAM Status" in Configure the REST LAM for further information and examples.

Configure CA Spectrum

You do not need to perform any integration-specific steps on your CA Spectrum systems. After you configure the LAM, it polls your CA Spectrum servers at regular intervals to collect event data (every 60 seconds by default).

In this section: