Skip to main content

OpenMetrics

Connector dependencies​

The following monitoring connectors will be installed when you install the OpenMetrics connector through the Configuration > Monitoring Connector Manager menu:

Pack assets​

Templates​

The Monitoring Connector OpenMetrics brings 2 host templates:

  • App-Monitoring-Openmetrics-File-custom
  • App-Monitoring-Openmetrics-Web-custom

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

Service AliasService TemplateService Description
Scrape-MetricsApp-Monitoring-Openmetrics-Scrape-Metrics-File-customScrapes metrics from an OpenMetrics formatted file on a remote host
Scrape-MetricsApp-Monitoring-Openmetrics-Scrape-Metrics-Web-customScrapes metrics from a web page exposing OpenMetrics

The services listed above are created automatically when the App-Monitoring-Openmetrics-File-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.

The values of the metrics collected depend on your Openmetrics device and the filters you choose.

Prerequisites​

  1. Configuration of the OpenMetrics Source
  • OpenMetrics-Compatible Service: You need an application or service that exposes metrics in the OpenMetrics format, often via an HTTP/HTTPS API (e.g., Prometheus or applications exposing a /metrics endpoint).
  • Accessible Endpoint: Ensure that the OpenMetrics endpoint is accessible from the Centreon server (or the poller). Test access using tools like curl or wget.
  1. Network Configuration
  • Port Opening: The poller must be able to connect to the port used by the OpenMetrics endpoint (typically port 80 for HTTP or 443 for HTTPS).
  • Firewall: Configure firewall rules to allow connections between the poller and the endpoint.
  1. Authentication If the OpenMetrics endpoint requires authentication (e.g., a token or HTTP Basic credentials), you must configure this information in Centreon. Store the credentials in the host macros.

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-openmetrics
  1. Whatever the license type (online or offline), install the OpenMetrics connector through the Configuration > Monitoring Connector 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-Openmetrics

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 App-Monitoring-Openmetrics-File-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
OPENMETRICSUSERNAMEEndpoint username
OPENMETRICSPASSWORDEndpoint password
OPENMETRICSPROTOSpecify https if needed (default: 'http')
OPENMETRICSPORTPort used (default: 80)
OPENMETRICSFILEPATHCommand options
OPENMETRICSURLPATHURL to scrape metrics from (default: '/metrics')
OPENMETRICSEXTRAOPTIONSAny 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
FILTERMETRICSOnly parse some metrics (regexp can be used). Example: --filter-metrics='^status$'
INSTANCESet the label from dimensions to get the instance value from
FILTERINSTANCEOnly display some instances. Example: --filter-instance='0'
SUBINSTANCESet the label from dimensions to get the subinstance value from
FILTERSUBINSTANCEOnly display some subinstances. Example: --filter-subinstance='idle'
WARNINGSet warning threshold
CRITICALSet critical threshold
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.--verbose
  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_monitoring_openmetrics.pl \
	--plugin=apps::monitoring::openmetrics::plugin \
	--mode=scrape-metrics \
	--custommode='web' \
	--hostname='10.0.0.1' \
	--port='' \
	--proto='' \
	--urlpath='' \
	--username='' \
	--password=''  \
	--filter-metrics='' \
	--warning='' \
	--critical='' \
	--instance='' \
	--filter-instance='' \
	--subinstance='' \
	--filter-subinstance='' \
	--verbose

The expected command output is shown below:

OK: All metrics are ok | 'metric2'=512;;;; 'metric2'=256;;;; 'metric1'=120;;;; 'metric1'=45;;;;
Metric 'metric2' value is '512' [Help: "This metric tracks memory usage."] [Type: 'gauge'] [Dimensions: "serviceA|heap"]
Metric 'metric2' value is '256' [Help: "This metric tracks memory usage."] [Type: 'gauge'] [Dimensions: "serviceB|stack"]
Metric 'metric1' value is '120' [Help: "This metric tracks the number of requests."] [Type: 'counter'] [Dimensions: "endpoint1|GET"]
Metric 'metric1' value is '45' [Help: "This metric tracks the number of requests."] [Type: 'counter'] [Dimensions: "endpoint2|POST"]

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_monitoring_openmetrics.pl \
	--plugin=apps::monitoring::openmetrics::plugin \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
scrape-metrics [code]App-Monitoring-Openmetrics-Scrape-Metrics-File-custom
App-Monitoring-Openmetrics-Scrape-Metrics-Web-custom

Available options​

Modes options​

All available options for each service template are listed below:

OptionDescription
--filter-metricsOnly parse some metrics (regexp can be used). Example: --filter-metrics='^status$'
--warningSet warning threshold.
--criticalSet critical threshold.
--instanceSet the label from dimensions to get the instance value from.
--filter-instanceOnly display some instances. Example: --filter-instance='0'
--subinstanceSet the label from dimensions to get the subinstance value from.
--filter-subinstanceOnly display some subinstances. Example: --filter-subinstance='idle'
--new-perfdataReplace the underscore symbol by a point in perfdata.

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

/usr/lib/centreon/plugins/centreon_monitoring_openmetrics.pl \
	--plugin=apps::monitoring::openmetrics::plugin \
	--mode=scrape-metrics \
	--help