JS Generic Event Processor
The JavaScript Generic Event Processor microservice enriches and processes of custom JavaScript rules-based events and forwards them down the Event pipeline to an output topic, which is generally on subscribed to by the Event Sink microservice.
This microservice is part of the Event microservice pipeline. See Understanding the Event Pipeline in Unified Assurance Concepts for conceptual information.
Autoscaling is enabled by default for this microservice. You can optionally disable autoscaling when you deploy the microservice. See Configuring Autoscaling.
This microservice provides additional Prometheus monitoring metrics. See JavaScript Generic Event Processor Self-Monitoring Metrics.
JavaScript Generic Event Processor 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.
Deploying JavaScript Generic Event Processor
To deploy the microservice, run the following commands:
su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<WebFQDN>
a1helm install <microservice-release-name> assure1/js-generic-event-processor -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 (js-generic-event-processor) 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 JavaScript Generic Event Processor 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 JavaScript Generic Event Processor Configuration by adding --set configData.<parameter_name>=<parameter_value>. For example, --set configData.LOG_LEVEL=DEBUG.
-
Disable autoscaling for the microservice by adding --set autoscaling.enabled=false.
-
Set an autoscaling parameter described in JavaScript Generic Event Processor Autoscaling Configuration by adding --set autoscaling.<parameter_name>=<parameter_value>. For example, --set autoscaling.thresholds.backlogSize=2000.
Default JavaScript Generic Event Processor 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 | Logging level used by application. |
| STREAM_INPUT Not configurable yet | persistent://assure1/event/js-generic-processor | Text, 255 characters | Apache Pulsar topic path. Topic at end of path may be any text value. |
| STREAM_OUTPUT Not configurable yet | persistent://assure1/event/sink | Text, 255 characters | Not configurable at this time |
| PRODUCTION_ENV | true | true,false | If true, application WILL NOT display any console.log statements from js rules. |
| STRICT_COMPILE | true | true,false | If true, application will force javascript strict compilation rules. |
| RULES_LOCATION | /core/default/processing/event/js-generic-event-processor | Text, 255 characters | Default SVN location (within Unified Assurance) for base.rule.js rules processing file. |
JavaScript Generic Event Processor Autoscaling Configuration
Autoscaling is supported for the JavaScript Generic Event Processor microservice. See Configuring Autoscaling for general information and details about the standard autoscaling configurations.
The JavaScript Generic Event Processor microservice also supports the additional configurations described in the following table.
| Name | Default Value | Possible Values | Notes |
|---|---|---|---|
| thresholds.backlogSize | 1000 | Integer | The number of items that need to be in the backlog before the autoscaling starts additional processes. |
| thresholds.totalEventsProcessed | 400 | Integer | Total events processed by the microservice. If the average of total events processed in five minutes exceeds the threshold, pods will be scaled. |
JavaScript Generic Event Processor Self-Monitoring Metrics
The JavaScript Generic Event Processor microservice exposes the self-monitoring metrics described in the following table to Prometheus.
| Metric Name | Type | Description |
|---|---|---|
| total_events_processed | Counter | Number of events processed by js-generic-processor |
| processing_time_per_event | Gauge | Processing time per events by js-generic-processor |
| js_generic_event_processor_backlog_size | Gauge | Number of items pending in the backlog |
Note:
Metric names in the database include a prefix that indicates the service that inserted them. The prefix is prom_ for metrics inserted by Prometheus. For example, total_events_processed is stored as prom_total_events_processed in the database.