diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md new file mode 100644 index 000000000000..ac5a198c52a0 --- /dev/null +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md @@ -0,0 +1,335 @@ +--- +id: telegraf +title: Telegraf +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Introduction + +L'agent Telegraf collecte des métriques et calcule des statuts sur les serveurs qu'il supervise, et les envoie à Centreon. Le processeur OpenTelemetry de Centreon lui permet d'interpréter les données envoyées au format OpenTelemetry. + +Développé par InfluxDB, l'agent Telegraf peut être installé sur des serveurs Windows. Centreon Engine envoie la configuration des ressources supervisées à l'agent (hôtes existants, seuils...), afin que l'agent exécute des contrôles et calcule les statuts de ces ressources. + +Étant basés sur Nagios, les plugins Centreon comme les plugins personnalisés sont compatibles avec l'agent. Ceci est dû au fait que l'intégration de Centreon avec Telegraf est basée sur le [format natif Nagios de données d'entrée](https://docs.influxdata.com/telegraf/v1/data_formats/input/nagios/). + +### Limitations + +Les limitations suivantes sont dues à des contraintes côté Telegraf ou côté Centreon. + +* À cause de limitations de Telegraf, la configuration des ressources connues de l'agent est mise à jour uniquement lorsque l'agent est démarré ou [redémarré](#reload-the-agent) (typiquement, un redémarrage de l'agent est nécessaire après avoir [déployé la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration)). Techniquement, c'est l'agent qui demande à Centreon de lui envoyer la configuration la plus à jour. +* Seules les métriques connues (c'est-à-dire les métriques pour les hôtes et services existant dans Centreon) sont envoyées à Centreon. Les métriques concernant des hôtes ou services inconnus sont ignorées. +* Seuls des métriques et des status sont retournés (pas d'outputs). +* Les connexions réseau sont unidirectionnelles : les données vont de l'agent au collecteur. Cela signifie qu'un hôte situé dans une DMZ devra communiquer avec un collecteur situé dans la même DMZ. +* Lorsqu'une amélioration ou une correction sont publiées, le plugin Centreon doit être redéployé sur les hôtes supervisés (il n'y a pas de mise à jour automatique). + +## Étape 1 : Installer l'agent et les plugins Centreon sur l'hôte + +### Téléchargez et installez l'agent sur l'hôte + +1. [Téléchargez l'agent](https://docs.influxdata.com/telegraf/v1/install/) sur tous les serveurs que vous voulez superviser. + +2. Installez l'agent sur les serveurs à l'aide de la commande suivante (remplacez les paramètres d'exemple par vos propres valeurs) : + +```shell +.\telegraf.exe --service install --config "http(s)://:/engine?host=" +``` + +Les arguments de cette commande permettront à Telegraf de savoir où aller chercher la configuration des resources qu'il doit superviser (c'est-à-dire sur le collecteur ou sur le central suivant l'IP définie dans la commande). Le paramètre `` est le nom de l'hôte tel qu'entré dans le champ **Nom** de sa configuration. + +### Déployer le plugin Centreon sur l'hôte + +Le plugin Centreon exécutera les contrôles sur l'hôte. + + + +Sur les hôtes que vous voulez superviser, téléchargez et exécutez le [package pour Windows](https://github.com/centreon/centreon-nsclient-build/releases/download/20240325/centreon_plugins.exe). + + + +## Étape 2: Configurer Centreon + +### Installer le connecteur de supervision qui recevra les données de Telegraf + +1. Sur votre serveur central, allez à la page **Configuration > Gestionnaire de connecteurs de supervision**. +2. [Installez](/docs/monitoring/pluginpacks/#installing-a-monitoring-connector) le connecteur de supervision **Windows Telegraf Agent**. + + +### Créer un connecteur Telegraf + +Installez le processeur Open Telemetry pour Telegraf sur votre serveur central : + +1. Allez à la page **Configuration > Commandes > Connecteurs**. +2. Créez un nouveau connecteur avec les données suivantes : + +| Paramètre | Valeur| +| --------- | ---- | +| Nom du connecteur | Telegraf | +| Description du connecteurn | Telegraf | +| Ligne de commande |```opentelemetry --processor=nagios_telegraf --extractor=attributes --host_path=resource_metrics.scope_metrics.data.data_points.attributes.host --service_path=resource_metrics.scope_metrics.data.data_points.attributes.service``` | +| Utilisé par la commande |
  • OS-Windows-Telegraf-Agent-Certificates
  • OS-Windows-Telegraf-Agent-Ntp
  • OS-Windows-Telegraf-Agent-Pending-Reboot
  • OS-Windows-Telegraf-Agent-Sessions
  • OS-Windows-Telegraf-Agent-Updates
| +| Statut du connecteur | Activé | + +### Configurer Engine + +1. Sur le collecteur qui recevra les données de l'agent, créez le fichier suivant : + + ```shell + touch /etc/centreon-engine/otl_server.json + ``` + +2. Entrez le contenu suivant. Cela permettra au collecteur de recevoir les données en provenance de l'agent. + + + + +* Entrez l'adresse IP du collecteur dans le champ **service_address**. +* Le champ **interval** correspond à la fréquence des contrôles effectués par Telegraf, et doit valoir 60 secondes, car il s'agit de la fréquence des contrôles Engine. + +```json +broker_module=/usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + +{ + "otel_server": { + "host": "0.0.0.0", + "port": 4317, + "encryption": false + }, + "max_length_grpc_log": 0, + "telegraf_conf_server": { + "http_server": { + "port": 80, + "encryption": false + }, + "telegraf_conf": { + "interval": "60s", + "service_address": "xxx.xxx.xxx.xxx:4317" + } + } +} +``` + + + + +* Entrez l'adresse IP du collecteur dans le champ **service_address**. +* Le champ **interval** correspond à la fréquence des contrôles effectués par Telegraf, et doit valoir 60 secondes, car il s'agit de la fréquence des contrôles Engine. + +Deux flux seront chiffrés : la configuration envoyée par le collecteur vers l'agent, et les métriques envoyées par l'agent vers le collecteur. + +1. Créez les certificats. +2. Copiez les certificats sur le collecteur qui recevra les données de Telegraf. +3. Entrez le chamin des certificats dans le fichier **otl_server.json**. + +```json +broker_module=/usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + +{ + "otel_server": { + "host": "0.0.0.0", + "port": 4317, + "encryption": true, + "certificate_path": "/tmp/otel/server.crt", + "key_path": "/tmp/otel/server.key" + }, + "max_length_grpc_log": 0, + "telegraf_conf_server": { + "http_server": { + "port": 1443, + "encryption": true, + "certificate_path": "/tmp/otel/server.crt", + "key_path": "/tmp/otel/server.key" + }, + "telegraf_conf": { + "interval": "60s", + "service_address": "127.0.0.1:4317" + } + } +} +``` + + + + +### Ajouter un nouveau module Broker + +1. Allez à la page **Configuration > Collecteurs > Configuration du moteur de collecte**, puis cliquez sur le collecteur qui supervisera les ressources. +2. Dans l'onglet **Données**, dans la section **Commande de lancement du module**, dans le paramètre **Multiple Broker Module**, cliquez sur **Ajouter une nouvelle entrée**. +3. Ajoutez l'entrée suivante : + + ```shell + /usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + ``` + +L'agent Telegraf est maintenant capable de communiquer avec Centreon. Vous pouvez mettre vos hôtes en supervision. + +## Étape 3 : Mettre un hôte en supervision avec l'agent Telegraf + +### Créez des hôtes en utilisant des modèles + +Sur le serveur central, [créez les hôtes](/docs/monitoring/basic-objects/hosts) et appliquez-leur des modèles fournis par le connecteur de supervision **Windows Telegraf AGENT**. + +### Redémarrez l'agent + +Pour que l'agent connaisse les hôtes nouvellement créés et puisse les superviser, exécutez la commande suivante sur l'hôte : + + ```shell + telegraf.exe --service start + telegraf.exe --service stop + ``` diff --git a/pp/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md b/pp/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md new file mode 100644 index 000000000000..804e26e4e34a --- /dev/null +++ b/pp/integrations/plugin-packs/getting-started/how-to-guides/telegraf.md @@ -0,0 +1,337 @@ +--- +id: telegraf +title: Telegraf +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Introduction + +The Telegraf agent collects metrics and computes statuses on the servers it monitors, and sends them to Centreon. +Centreon's OpenTelemetry processor allows it to understand data sent in OpenTelemetry format. + +Developped by InfluxDB, the Telegraf agent can be installed on Windows servers. Centreon Engine is able to send the configuration of monitored resources to the agent (existing hosts, thresholds...), so that the agent can execute checks and compute the statuses of these resources. + +As they are Nagios-based, both Centreon and custom plugins are compatible with the agent. This is because Centreon's Telegraf integration is based on the native [Nagios input data format](https://docs.influxdata.com/telegraf/v1/data_formats/input/nagios/). + +### Limitations + +Due to Telegraf or Centreon constraints, the following limitations need to be considered. + +* Due to Telegraf limitations, the configuration of resources known to the agent is only updated when you start or [reload the agent](#reload-the-agent) (typically, you would do that after [deploying the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration)). Technically, the agent requests an up-to-date configuration from Centreon. +* Only known metrics (i.e., the metrics for the hosts and services created in Centreon) are sent to Centreon. Metrics for unknown hosts or services are discarded. +* Only metrics and statuses are returned (no outputs). +* Network connections are one-way only: data goes from the agent to the poller. This means that a host in a DMZ will need a poller in this DMZ. +* When an enhancement or fix is released, the Centreon plugin must be re-deployed on your monitored host (there is no auto-update). + +## Step 1: Install the agent and the Centreon plugins on the host + +### Download and install the agent on the host + +1. [Download the agent](https://docs.influxdata.com/telegraf/v1/install/) on all the servers you want to monitor. + +2. Install the agent on the servers using the following command (replace the placeholders by your values): + +```shell +.\telegraf.exe --service install --config "http(s)://:/engine?host=" +``` + +The arguments in this command will allow Telegraf to know where to fetch the configuration of the resources that it must monitor (i.e on the poller or the central, according to the IP address you have entered in the command). The `` parameter is the name of the host as you entered it in the **Name** field in its configuration. + +### Deploy the Centreon plugin on the host + +The Centreon plugin will execute the checks on the host. + + + +On the hosts you want to monitor, download and execute the corresponding [package for Windows](https://github.com/centreon/centreon-nsclient-build/releases/download/20240325/centreon_plugins.exe). + + + + +## Step 2: Configure Centreon + +### Install the monitoring connector that will receive data from Telegraf + +1. On your central server, go to **Configuration > Monitoring Connector Manager**. +2. [Install](/docs/monitoring/pluginpacks/#installing-a-monitoring-connector) the **Windows Telegraf Agent** monitoring connector. + + +### Create the Telegraf connector + +Install the Open Telemetry processor for Telegraf on your central server: + +1. Go to **Configuration > Commands > Connectors**. +2. Create a new connector with the following values: + +| Parameter | Value| +| --------- | ---- | +| Connector Name | Telegraf | +| Connector Description | Telegraf | +| Command Line |```opentelemetry --processor=nagios_telegraf --extractor=attributes --host_path=resource_metrics.scope_metrics.data.data_points.attributes.host --service_path=resource_metrics.scope_metrics.data.data_points.attributes.service``` | +| Used by command |
  • OS-Windows-Telegraf-Agent-Certificates
  • OS-Windows-Telegraf-Agent-Ntp
  • OS-Windows-Telegraf-Agent-Pending-Reboot
  • OS-Windows-Telegraf-Agent-Sessions
  • OS-Windows-Telegraf-Agent-Updates
| +| Connector Status | Enabled | + +### Configure Engine + +1. On the poller that will receive the data from the agent, create the following file: + + ```shell + touch /etc/centreon-engine/otl_server.json + ``` + +2. Enter the following contents. This will allow the poller to receive the data that the agent will send. + + + + +* Enter the IP address of the poller in the **service_address** field. +* The **interval** field is the frequency of checks performed by Telegraf, and should be set to 60 seconds as it is the frequency of Engine checks. + +```json +broker_module=/usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + +{ + "otel_server": { + "host": "0.0.0.0", + "port": 4317, + "encryption": false + }, + "max_length_grpc_log": 0, + "telegraf_conf_server": { + "http_server": { + "port": 80, + "encryption": false + }, + "telegraf_conf": { + "interval": "60s", + "service_address": "xxx.xxx.xxx.xxx:4317" + } + } +} +``` + + + + +* Enter the IP address of the poller in the **service_address** field. +* The **interval** field is the frequency of checks performed by Telegraf, and should be set to 60 seconds as it is the frequency of Engine checks. + +Two flows will be encrypted: the configuration sent by the poller to the agent, and the metrics sent by the agent to the poller. + +1. Create the certificates. +2. Copy the certificates on to the poller that will receive data from Telegraf. +3. Enter the path to the certificates in the **otl_server.json** file. + +```json +broker_module=/usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + +{ + "otel_server": { + "host": "0.0.0.0", + "port": 4317, + "encryption": true, + "certificate_path": "/tmp/otel/server.crt", + "key_path": "/tmp/otel/server.key" + }, + "max_length_grpc_log": 0, + "telegraf_conf_server": { + "http_server": { + "port": 1443, + "encryption": true, + "certificate_path": "/tmp/otel/server.crt", + "key_path": "/tmp/otel/server.key" + }, + "telegraf_conf": { + "interval": "60s", + "service_address": "127.0.0.1:4317" + } + } +} +``` + + + + +### Add a new Broker module + +1. Go to **Configuration > Pollers > Engine configuration**, then click on the poller you want to monitor your resources. +2. On the **Data** tab, in the **Broker module** section, in the **Multiple Broker Module** parameter, click on **Add a new entry**. +3. Add the following entry : + + ```shell + /usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json + ``` + +The Telegraf agent is now able to communicate with Centreon. You can set up the monitoring of your hosts. + +## Step 3: Monitoring a host with the Telegraf agent + +### Create hosts using templates + +On the central server, [create hosts](/docs/monitoring/basic-objects/hosts) and apply to them templates provided by the **Windows Telegraf AGENT** monitoring connector. + +### Reload the agent + +To let the agent know about the hosts you just created and start monitoring them, run the following command on the host: + + ```shell + telegraf.exe --service start + telegraf.exe --service stop + ``` \ No newline at end of file diff --git a/pp/sidebarsPp.js b/pp/sidebarsPp.js index 2529f93749bb..576c364a6c93 100644 --- a/pp/sidebarsPp.js +++ b/pp/sidebarsPp.js @@ -22,6 +22,10 @@ module.exports = { { type: 'doc', id: 'integrations/plugin-packs/getting-started/how-to-guides/centreon-nsclient-tutorial' + }, + { + type: 'doc', + id: 'integrations/plugin-packs/getting-started/how-to-guides/telegraf' }, { type: 'doc',