osp-scripts¶
List of configuration files¶
Filename |
Short description |
Format |
Documentation |
---|---|---|---|
module.service |
Each service is described in its own file and then assembled |
yml |
See the Swarm administration or Official documentation |
module.scripts |
Defines the global configuration of the module |
json |
|
owner.scripts |
Defines a script that generate a value |
json |
|
detached.scripts |
Defines a script that do some action without generating a value |
json |
|
output.scripts |
Defines which script to execute when a value change |
json |
Supervision Prometheus (Beta)¶
Warning
Prometheus supervision feature is in beta version, we are very glad to receive feedback at info@swissdotnet.ch. This feature behavior can change without notice in future versions.
The module provides a prometheus export on the 9100 TCP port. It provides following metrics:
Script execution time¶
script_execution_seconds with a label (itemId) for each script.
The metric is an histogram with the following buckets (a bucket of 0.05s will contain the number of computation that take up to 0.05s to execute):
0.001 seconds
0.05 seconds
0.1 seconds
0.25 seconds
0.5 seconds
0.75 seconds
1.0 seconds
5.0 seconds
10.0 seconds
20.0 seconds
60.0 seconds
300.0 seconds
inf
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.