Skip to main content

Linux SNMP (Rust)

The centreon-plugin-rust-snmp Rust plugin is currently in beta.

Connector dependencies​

The following monitoring connectors will be installed when you install the Linux SNMP (Rust) connector through the Configuration > Connectors > Monitoring Connectors menu:

Pack assets​

Templates​

The Monitoring Connector Linux SNMP (Rust) brings a host template:

  • OS-Linux-SNMP-Rs-custom

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

Service AliasService TemplateService Description
CpuOS-Linux-Cpu-SNMP-Rs-customCheck CPU utilization rate for the machine
MemoryOS-Linux-Memory-SNMP-Rs-customMonitor the memory (RAM) usage
SwapOS-Linux-Swap-SNMP-Rs-customCheck the swap usage
UptimeOS-Linux-Uptime-SNMP-Rs-customTime since the host has been running

The services listed above are created automatically when the OS-Linux-SNMP-Rs-custom host template is used.

Collected metrics & status​

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

NameUnit
avg.cpu.usage.percent%
cpu#core.cpu.usage.percent%

Prerequisites​

To monitor a Linux based device, the SNMP service must be installed and configured. Most of Linux distributions rely on net-snmp.

SNMP server configuration​

Basic configuration​

Notice: the configuration below may vary depending on your distribution. Refer to the official documentation if this does not work for you.

Find below a minimalist snmpd.conf / net-snmp config file (replace my-snmp-community by the relevant value).

com2sec notConfigUser  default       my-snmp-community
group   notConfigGroup v1           notConfigUser
group   notConfigGroup v2c           notConfigUser
view centreon included .1.3.6.1
view    systemview    included   .1.3.6.1.2.1.1
view    systemview    included   .1.3.6.1.2.1.25.1.1
access notConfigGroup "" any noauth exact centreon none none
access  notConfigGroup ""      any       noauth    exact  systemview none none
includeAllDisks 10%

The SNMP server must be restarted each time the configuration is modified. Also make sure that the SNMP server is configured to automatically start on boot.

Network flow​

The target server must be reachable from the Centreon Poller on the UDP/161 SNMP port.

Installing the monitoring connector​

Pack​

The installation procedures for monitoring connectors are slightly different depending on whether your license is offline or online.

  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 > Connectors > Monitoring Connectors 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-operatingsystems-linux-snmp-rs
  1. Whatever the license type (online or offline), install the Linux SNMP (Rust) connector through the Configuration > Connectors > Monitoring Connectors 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-operatingsystems-linux-snmp-rs

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 in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the OS-Linux-SNMP-Rs-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
SNMP_EXTRA_OPTIONSAny 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
WARNING_AVERAGEWarning threshold90
CRITICAL_AVERAGECritical threshold95
WARNING_COREWarning threshold for the metric 'core.cpu.usage.percent'
CRITICAL_CORECritical threshold for the metric 'core.cpu.usage.percent'
EXTRA_OPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.
  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-plugin-rust-snmp -H '10.0.0.1' -c 'my-snmp-community' -v '2c'  \
	--json '/usr/lib/centreon/plugins/rs-collections/operatingsystems-linux-snmp/uptime.json' \
	--warning-seconds='' \
	--critical-seconds=''

The expected command output is shown below:

OK: Uptime: 64750s | 'system.uptime.seconds'=64750s;;;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-plugin-rust-snmp -H '10.0.0.1' -c 'my-snmp-community' -v '2c'  \
	--json '/usr/lib/centreon/plugins/rs-collections/operatingsystems-linux-snmp/uptime.json' \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
cpu [code]OS-Linux-Cpu-SNMP-Rs-custom
inodes [code]Non utilisé dans ce connecteur de supervision
memory [code]OS-Linux-Memory-SNMP-Rs-custom
memory-64 [code]OS-Linux-Memory-64bits-SNMP-Rs-custom
processcount [code]OS-Linux-Process-Generic-SNMP-Rs-custom
storage [code]OS-Linux-Disk-Global-SNMP-Rs-custom
swap [code]OS-Linux-Swap-SNMP-Rs-custom
swap-64 [code]OS-Linux-Swap-64bits-SNMP-Rs-custom
sysdesc [code]Non utilisé dans ce connecteur de supervision
uptime [code]OS-Linux-Uptime-SNMP-Rs-custom

Available options​

Generic options​

All generic options are listed here:

OptionDescription
--hostnameHostname or IP address (default: localhost)
--portSNMP port (default: 161)
--snmp-versionSNMP version (default: 2c)
--jsonJSON command definition file
--filter-inInclude filter (can be used multiple times)
--filter-outExclude filter (can be used multiple times)
--no-data-statusStatus when the filters keep no data: OK, WARNING, CRITICAL or UNKNOWN (default: UNKNOWN)
--check-formatCheck JSON file validity and exit
--check-responseDisplay raw SNMP response
--list-countersList all available metrics
--helpPrint this help message

Modes options​

All available options for each service template are listed below:

OptionDescription
--warning-coreWarning threshold for the metric 'core.cpu.usage.percent'.
--critical-coreCritical threshold for the metric 'core.cpu.usage.percent'.
--warning-avgWarning threshold for the metric 'avg.cpu.usage.percent'.
--critical-avgCritical threshold for the metric 'avg.cpu.usage.percent'.

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

/usr/lib/centreon/plugins/centreon-plugin-rust-snmp -H '10.0.0.1' -c 'my-snmp-community' -v '2c'  \
	--json '/usr/lib/centreon/plugins/rs-collections/operatingsystems-linux-snmp/uptime.json' \
	--warning-seconds='' \
	--help