Skip to main content

Centreon Poller

Centreon collectors must be monitored by the central server.

Pack assets​

Templates​

The Monitoring Connector Centreon Poller brings a host template:

  • App-Monitoring-Centreon-Poller-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService Description
Broker-StatsApp-Monitoring-Centreon-Broker-Stats-Poller-customCheck Centreon Broker processes statistics
proc-centengineApp-Monitoring-Centreon-Process-centengine-customCheck centreon-engine process
proc-gorgonedApp-Monitoring-Centreon-Process-gorgoned-customCheck centcore process
proc-ntpdApp-Monitoring-Centreon-Process-ntpd-customCheck NTP process
proc-sshdApp-Monitoring-Centreon-Process-sshd-customCheck SSHD process

The services listed above are created automatically when the App-Monitoring-Centreon-Poller-custom host template is used.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics linked to each service.

Metric nameUnit
endpoint#statusN/A
endpoint#speed-eventsevents/s
endpoint#queued-eventsevents
endpoint#unacknowledged-eventsevents

To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.

Prerequisites​

SNMP​

SNMP must be configured on each poller being monitored. You can refer to this documentation to find out how to set up a quick SNMP configuration.

SSH key exchange​

One of the checks included in the pack is performed through SSH. The central server should be able to connect to each poller being monitored.

The central server performs its checks as the centreon-engine user, and will log in to the pollers as the centreon user.

Follow these steps to exchange the SSH key:

  1. On the poller being monitored by the central server, set a password for the centreon user: 
passwd centreon
  1. On the central server, create and copy the new centreon-user's SSH key on the poller: 
su - centreon-engine
ssh-keygen -t ed25519 -a 100
ssh-copy-id -i ~/.ssh/id_ed25519.pub centreon@<IP_POLLER>

Installing the monitoring connector​

Pack​

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-monitoring-centreon-poller
  1. Whatever the license type (online or offline), install the Centreon Poller connector through the Configuration > Monitoring Connectors Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Monitoring-Centreon-Poller

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill the Name, Alias & IP Address/DNS fields according to your ressource settings.
  3. Apply the App-Monitoring-Centreon-Poller-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
MODULESTATSFILESpecify the centreon-broker json stats file (required). Can be multiple/var/lib/centreon-engine/*-module-stats.jsonX
SNMPEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). All options are listed here.
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
FILTERNAMEFilter endpoint name
WARNINGQUEUEDEVENTSThresholds
CRITICALQUEUEDEVENTSThresholds
WARNINGSPEEDEVENTSThresholds
CRITICALSPEEDEVENTSThresholds
CRITICALSTATUSDefine the conditions to match for the status to be CRITICAL (default: '%{type} eq "output" and %{queue_file_enabled} =~ /yes/i'). You can use the following variables: %{queue_file_enabled}, %{state}, %{status}, %{type}, %{display}%{type} eq "output" and %{queue_file_enabled} =~ /true|yes/i
WARNINGSTATUSDefine the conditions to match for the status to be WARNING. You can use the following variables: %{queue_file_enabled}, %{state}, %{status}, %{type}, %{display}
WARNINGUNACKNOWLEDGEDEVENTSThresholds
CRITICALUNACKNOWLEDGEDEVENTSThresholds
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.--verbose --ssh-username='centreon'
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_centreon_poller.pl \
    --plugin=apps::centreon::local::plugin \
    --hostname=10.0.0.1 \
    --mode=broker-stats \
    --broker-stats-file='/var/lib/centreon-engine/*-module-stats.json' \
    --filter-name='' \
    --warning-speed-events='' \
    --critical-speed-events='' \
    --warning-queued-events='' \
    --critical-queued-events='' \
    --warning-unacknowledged-events='' \
    --critical-unacknowledged-events='' \
    --warning-status='' \
    --critical-status='%{type} eq "output" and %{queue_file_enabled} =~ /true|yes/i' \
    --verbose \
    --ssh-username='centreon'

The expected command output is shown below:

OK: Broker statistics are ok | '*endpoint*#speed-events'=events/s;;;0;'*endpoint*#queued-events'=events;;;0;'*endpoint*#unacknowledged-events'=events;;;0;

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes​

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_centreon_poller.pl \
    --plugin=apps::centreon::local::plugin \
    --list-mode

The plugin brings the following modes:

ModeLinked service template
arp [code]Not used in this Monitoring Connector
bamservice [code]Not used in this Monitoring Connector
broker-stats [code]App-Monitoring-Centreon-Broker-Stats-Poller-custom
centengine-stats [code]Not used in this Monitoring Connector
centreon-plugins-version [code]Not used in this Monitoring Connector
cpu [code]Not used in this Monitoring Connector
cpu-detailed [code]Not used in this Monitoring Connector
disk-usage [code]Not used in this Monitoring Connector
diskio [code]Not used in this Monitoring Connector
downtime-trap [code]Not used in this Monitoring Connector
dummy [code]Not used in this Monitoring Connector
inodes [code]Not used in this Monitoring Connector
interfaces [code]Not used in this Monitoring Connector
list-diskio [code]Not used in this Monitoring Connector
list-diskspath [code]Not used in this Monitoring Connector
list-interfaces [code]Not used in this Monitoring Connector
list-processes [code]Not used in this Monitoring Connector
list-storages [code]Not used in this Monitoring Connector
load [code]Not used in this Monitoring Connector
memory [code]Not used in this Monitoring Connector
metaservice [code]Not used in this Monitoring Connector
not-so-dummy [code]Not used in this Monitoring Connector
processcount [code]App-Monitoring-Centreon-Process-centengine-custom
App-Monitoring-Centreon-Process-gorgoned-custom
App-Monitoring-Centreon-Process-ntpd-custom
App-Monitoring-Centreon-Process-sshd-custom
retention-broker [code]Not used in this Monitoring Connector
storage [code]Not used in this Monitoring Connector
swap [code]Not used in this Monitoring Connector
tcpcon [code]Not used in this Monitoring Connector
time [code]Not used in this Monitoring Connector
udpcon [code]Not used in this Monitoring Connector
uptime [code]Not used in this Monitoring Connector

Available options​

Generic options​

All generic options are listed here:

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on an "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale"Mbps",mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.

Modes options​

All available options for each service template are listed below:

OptionDescription
--ssh-backendDefine the backend you want to use. It can be: sshcli (default), plink and libssh.
--ssh-usernameDefine the user name to log in to the host.
--ssh-passwordDefine the password associated with the user name. Cannot be used with the sshcli backend. Warning: using a password is not recommended. Use --ssh-priv-key instead.
--ssh-portDefine the TCP port on which SSH is listening.
--ssh-priv-keyDefine the private key file to use for user authentication.
--sshcli-commandssh command (default: 'ssh').
--sshcli-pathssh command path (default: none)
--sshcli-optionSpecify ssh cli options (example: --sshcli-option='-o=StrictHostKeyChecking=no').
--plink-commandplink command (default: 'plink').
--plink-pathplink command path (default: none)
--plink-optionSpecify plink options (example: --plink-option='-T').
--libssh-strict-connectConnection won't be OK even if there is a problem (server known changed or server found other) with the ssh server.
--hostnameHostname to query in ssh.
--timeoutTimeout in seconds for the command (default: 30).
--sudoUse 'sudo' to execute the command.
--broker-stats-fileSpecify the centreon-broker json stats file (required). Can be multiple.
--filter-nameFilter endpoint name.
--warning- --critical-Thresholds. Can be: 'speed-events', 'queued-events', 'unacknowledged-events'.
--warning-statusDefine the conditions to match for the status to be WARNING. You can use the following variables: %{queue_file_enabled}, %{state}, %{status}, %{type}, %{display}
--critical-statusDefine the conditions to match for the status to be CRITICAL (default: '%{type} eq "output" and %{queue_file_enabled} =~ /yes/i'). You can use the following variables: %{queue_file_enabled}, %{state}, %{status}, %{type}, %{display}

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_centreon_poller.pl \
    --plugin=apps::centreon::local::plugin \
    --hostname=10.0.0.1 \
    --help