osp-network-monitoring

Overview

The osp-network-monitoring periodically sends requests to configured devices to check for their availability and provides the result as a value. Each device can be polled at a different rate for fine tuned failure reporting.

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.network-monitoring

Defines the module configuration

json

module.network-monitoring

owner.network-monitoring

Defines one monitoring link

json

owner.network-monitoring

Docker specificity

To allow the osp-network-monitoring connector to send ICMP requests, the container should be started with altered network options. This can be achieved by adding the following lines to the associated module.service file

sysctls:
  net.ipv4.ping_group_range: 0 1000

or with the option –sysctl net.ipv4.ping_group_range=’0 1000’ when starting it as a remote connector.

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