osp-analytics

Overview

Analytics provides a way to record values and / or events generated by some other module. These values are stored inside an InfluxDB which can be internal to the stack or external.

Configuration

Administrator username and password

admin-user : The username of the administrator (<stack_name>_admin-user by default).
admin-pwd : The password for the admin user (<stack_name>_admin-pwd by default).

Change the administrator user

See Rotate admin user to change the database password.

Change the administrator password

See Rotate admin password to change the database password.

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.analytics	Define the configuration of the module	json	module.analytics
measure.analytics	Define a measure that can be linked to an output.	json	measure.analytics
measure.ospp	Define the property of a measure.	json	measure.ospp
field.analytics	Define a field that can be linked to an output.	json	field.analytics
field.ospp	Define the property of a field.	json	field.ospp
output.analytics	Insert a new value inside the analytics upon a value change.	json	output.analytics
query.analytics	Define the query to extract some data (graph, average, …)	json	query.analytics

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