osp-scripts

List of configuration files

Filename	Short description	Format	Documentation
module.service	Each service is defined in a separate file and then combined into a unified compose stack file	yml	See the Swarm administration or Official documentation
module.scripts	Defines the global configuration of the module	json	module.scripts
owner.scripts	Defines a script that generate a value	json	owner.scripts
detached.scripts	Defines a script that do some action without generating a value	json	detached.scripts
output.scripts	Defines which script to execute when a value change	json	output.scripts

Supervision Prometheus (Beta)

Execution Time

Metric	Labels	Type	Description
pre_insert_rule_execution_seconds	ItemId	histogram	Pre-insert rule execution time in seconds
archive_execution_seconds	None	histogram	Archive execution time in seconds
history_execution_seconds	None	histogram	History execution time in seconds
alarm_action_execution_seconds	None	histogram	Alarm action execution time in seconds
insertion_execution_seconds	None	histogram	Time to insert into the buffer
processing_execution_seconds	step	histogram	Processing time per step in seconds

Buffer & Batch Metrics

Metric	Labels	Type	Description
insertion_count_total	None	counter	Total alarms inserted into the buffer
buffer_size	None	gauge	Buffer size before processing (insertion)
processing_batch_size	batch total_batch	gauge	Size of processing batch (insertion)

Processing Execution Created Timestamps

Metric	Labels	Type	Description
archive_execution_seconds_created	None	gauge	Timestamp of archive execution
history_execution_seconds_created	None	gauge	Timestamp of history execution
insertion_count_created	None	gauge	Timestamp of insertion count
insertion_execution_seconds_created	None	gauge	Timestamp of insertion execution
processing_execution_seconds_created	buffer total_batch batch pre-alarms alarm check aggregate post-alarms write	gauge	Timestamp of processing execution per step

Metric	Labels	Type	Description
action_rule_execution_seconds	itemId	histogram	Duration in seconds of the execution of each action rule, labeled by itemId.

alarm_action_execution_seconds

Metric	Labels	Type	Description
alarm_action_execution_seconds	acknowledge, escalate, lock, unlock, clear, tag, untag, journal, edit, create, insert	histogram	Duration in seconds of each alarm action execution, labeled by the corresponding action.

Front view

Metric	Labels	Type	Description
live_change_execution_seconds	step=find	histogram	Duration in seconds of the find operation on the database.
live_change_execution_seconds	step=compute	histogram	Duration in seconds to compute the difference between two alarm states, publishing only the changes to the front-end.
live_change_execution_seconds	filter	histogram	Label representing each applied filter.

An example for a Grafana dashboard : Dashboard

Healthcheck

The health-check for this module periodically executes a script (every 5 seconds) returning the current timestamp. The module then writes that timestamp into the healthcheck file.

Environment Variables

All modules env variables

Variable Name	Default Value	Usage
PROMETHEUS_PORT	9100	The internal port used for Openmetrics exposition.
DISPATCHER_HOST	modules_configuration-dispatcher_main	The hostname on which the modules can fetch the configuration.
DISPATCHER_PORT	10000	The port used by the module to listen for configuration request.
USE_LEGACY_RESTART	Not set	When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container.
CUSTOM_JVM_OPTIONS	Not set	Allow to inject JVM options. See Configuration changes for more information.
ALLOW_VERSION_MISMATCH	Not set	Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version.

Dedicated variables

None

Hot-reload

Hot reload is supported for most elements. However, changes to the following configurations will trigger a full module reload:

• Messaging configuration

• Script execution