Windows Telegraf Agent | Centreon Documentation (2024)

Telegraf is an observability tool implementing the OpenTelemetry protocol.

This monitoring connector is a proof of concept, Centreon does not recommend to use it in production.It has some limitations such as:

• the need to restart the Telegraf service whenever the configuration is changed.
• the impossibility to display the informational output message of the host or service (due tolimitations of the OpenTelemetry protocol).

Pack assets​

Templates​

The Monitoring Connector Windows Telegraf Agent brings a host template:

• OS-Windows-Telegraf-Agent-custom

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

Collected metrics & status​

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

Prerequisites​

Centreon Engine​

To be able to use the Telegraf agent, you must use a poller with at least version 24.04.2 of centreon-engine.

The Telegraf agent will configure itself via a HTTPS request sent to Centreon Engine.

1. For this to work, you must first generate a certificate on the poller:

openssl req -new -newkey rsa:2048 -sha256 -days 3650 -nodes -x509 -keyout /etc/centreon-engine/conf-server.key -out /etc/centreon-engine/conf-server.crt
chown centreon-engine: /etc/centreon-engine/conf-*

Important : give the IP address or the FQDN of the poller when the Common Name information is prompted.

Example:

Common Name (e.g. server FQDN or YOUR name) []:172.16.5.166

2. Then prepare the information Engine will have to provide to the Telegraf agent.

host_ip=$(hostname -I)
cat > /etc/centreon-engine/otl_server.json <<EOF
{
 "otel_server": {
 "host": "0.0.0.0",
 "port": 4317
 },
 "max_length_grpc_log": 0,
 "telegraf_conf_server": {
 "http_server" : {
 "port": 1443,
 "encryption": true,
 "certificate_path": "/etc/centreon-engine/conf-server.crt",
 "key_path": "/etc/centreon-engine/conf-server.key"
 },
 "engine_otel_endpoint": "${host_ip% }:4317",
 "check_interval":60
 }
}
EOF
chown centreon-engine: /etc/centreon-engine/otl_server.json
systemctl restart centengine

Telegraf agent​

The official installation procedure is here but you'll find the main steps below.

Installing the Telegraf agent​

1. Download and unarchive the agent.

wget https://dl.influxdata.com/telegraf/releases/telegraf-1.30.1_windows_amd64.zip -UseBasicParsing -OutFile telegraf-1.30.1_windows_amd64.zip
Expand-Archive .\telegraf-1.30.1_windows_amd64.zip -DestinationPath 'C:\Program Files\InfluxData\telegraf\'

2. Install the service:

"C:\Program Files\InfluxData\telegraf\telegraf-1.30.3\telegraf.exe" --config https://<poller_ip_address>:1443/engine?host=<windows_server_name> --service install

Downloading centreon_plugins.exe​

Download the centreon_plugins.exe from the latest release available hereand copy it in the same place as the Telegraf agent (that should be "C:\Program Files\InfluxData\telegraf\telegraf-1.30.3\")if you followed the procedure to the letter.

Import du certificat du poller​

1. Open the Edge web browser.
2. Browse to https://<poller_ip_address>:1443.
3. Accept the certificate. No host service found from get parameters should be displayed.
4. Click on the certificate on the left of the URL bar.
5. Go to Details.
6. Export the certificate.
7. Open the file explorer.
8. Right-click on the certificate where you downloaded it.
9. Select Install the certificate.
10. Select Local machine then Next.
11. Specify you want to choose the certificate store manually.
12. Select Trusted Root Certificate Authority then OK.
13. Click Next, then Finish.

Installing the monitoring connector​

Pack​

1. If the platform uses an online license, you can skip the package installationinstruction below as it is not required to have the connector displayed within theConfiguration > Monitoring Connectors Manager menu.If the platform uses an offline license, install the package on the central serverwith the command corresponding to the operating system's package manager:

dnf install centreon-pack-operatingsystems-windows-telegraf-agent

2. Whatever the license type (online or offline), install the Windows Telegraf Agent connector throughthe Configuration > Monitoring Connectors Manager menu.

3. Create the corresponding connector:

In the Configuration > Commands > Connectors menu, click Add and fill the following fields:

Plugin​

This connector relies on an integration supported by Centreon Engine and does not need a plugin.

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 OS-Windows-Telegraf-Agent-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.

5. 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.

6. Restart the Telegraf Data Collector Service service on the Windows server. The host and services' statuses will update in the next minutes.

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).

3. Deploy the configuration. The service appears in the list of services, and on page Resources Status. 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?​

Test that the plugin is able to monitor your Windows server by using a command like this one (replace the sample values by yours):

"\Program Files\InfluxData\telegraf\telegraf-1.30.3\centreon_plugins.exe" --plugin os::windows::local::plugin --mode sessions --language='fr' --timeout='30' --use-new-perfdata

The expected command output is shown below:

OK: Sessions created: 0, disconnected: 0, reconnected : 0, current active : 1, current disconnected : 1 | 'sessions.created.total.count'=0;;;0; 'sessions.disconnected.total.count'=0;;;0; 'sessions.reconnected.total.count'=0;;;0; 'sessions.active.current.count'=1;;;0; 'sessions.disconnected.current.count'=1;;;0;

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 theconnector in your terminal.

The plugin brings the following modes:

Available options​

Generic options​

All generic options are listed here:

Modes options​

All available options for each service template are listed below:

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

"\Program Files\InfluxData\telegraf\telegraf-1.30.3\centreon_plugins.exe" --plugin=os::windows::local::plugin --mode=certificates --help