RCA Availability Engine
The RCA Availability Engine microservice consumes availability messages from the SNMP and Ping pollers, correlates them to devices and instances, and, after analysis, generates events to be sent to the FCOM Processor for ingestion into the database.
This microservice is part of the Event microservice pipeline. See Understanding the Event Pipeline in Unified Assurance Concepts for conceptual information.
RCA Availability Engine Prerequisites
Before deploying the microservice, confirm that the following prerequisites are met:
-
A microservice cluster is set up. See Microservice Cluster Setup.
-
The Apache Pulsar microservice is deployed. See Pulsar.
-
The Event Sink microservice is deployed as described in Event Sink, but with a modification to the default value of the DATABASE_ONDUPKEY configuration parameter. Oracle recommends setting this parameter at installation using an override file to ensure that any special string characters used for DATABASE_ONDUPKEY are saved properly.
Create and use the override file as follows:
-
Before installing the Event Sink microservice, create an override.yaml file to define DATABASE_ONDUPKEY, adding RootCauseKey = VALUES(RootCauseKey) to the default value as follows:
You can optionally use this file to change any of the other default configuration settings for the Event Sink microservice.configData: DATABASE_ONDUPKEY: Count = IF(VALUES(Count) > 1, Count + VALUES(Count), Count + 1), Duration = VALUES(LastReported) - FirstReported, EventCategory = VALUES(EventCategory), LastChanged = VALUES(LastChanged), LastReported = VALUES(LastReported), Severity = VALUES(Severity), Summary = VALUES(Summary), RootCauseKey = VALUES(RootCauseKey)
-
When installing the Event Sink microservice, use the -f override.yaml flag on the command:
a1helm install event-sink assure1/event-sink -n $NAMESPACE --set global.imageRegistry=$WEBFQDN -f override.yaml
-
-
The CorrelateRCAEventsByKey CAPE Policy is enabled as follows:
-
Log in to the Unified Assurance UI.
-
From the Configuration menu, select Events, then CAPE, then Policies.
-
Select the CorrelateRCAEventsByKey row.
-
Set the State field to Enabled.
-
Deploying RCA Availability Engine
To deploy the microservice, run the following commands:
su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<WebFQDN>
a1helm install <microservice-release-name> assure1/rca-availability-engine -n $NAMESPACE --set global.imageRegistry=$WEBFQDN
In the commands:
-
<namespace> is the namespace where you are deploying the microservice. The default namespace is a1-zone1-pri, but you can change the zone number and, when deploying to a redundant cluster, change pri to sec.
-
<WebFQDN> is the fully-qualified domain name of the primary presentation server for the cluster.
-
<microservice-release-name> is the name to use for the microservice instance. Oracle recommends using the microservice name (rca-availability-engine) unless you are deploying multiple instances of the microservice to the same cluster.
You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.
Changing RCA Availability Engine Configuration Parameters
When running the install command, you can optionally change default configuration parameter values by including them in the command with additional --set arguments. You can add as many additional --set arguments as you need.
For example, set a parameter described in Default RCA Availability Engine Configuration by adding --set configData.<parameter_name>=<parameter_value>.
Default RCA Availability Engine Configuration
The following table describes the default configuration parameters found in the Helm chart under configData for the microservice.
Name | Default Value | Possible Values | Notes |
---|---|---|---|
LOG_LEVEL | INFO | FATAL, ERROR, WARN, INFO, DEBUG | The logging level used by the application. |
SMOOTHING_INTERVAL | 70 | Integer | How many seconds to wait between running root cause analysis to generate device down alarms. |
AVAILABILITY_HISTORY | 5 | Integer | How much availability history for a device and instance to store. |
STREAM_SYNC_INPUT | none:/// | Text, 255 characters | The stream to synchronize events from. Only mysql:///Events is supported. Setting this synchronizes events from the event database into the RCA event cache at startup. |
TOPO_RESYNC_INTERVAL | 1800 | Integer | How many seconds to wait between synchronizing the Graph database topology into the cache. |