Aller au contenu principal

Linux Telegraf Agent

Telegraf est un agent d'observabilité implémentant le protocole OpenTelemetry.

Ce connecteur de supervision est une preuve de concept, Centreon ne recommande pas sa mise en oeuvre en production. Il présente par ailleurs certaines limitations, telles que :

  • la nécessité de redémarrer l'agent pour prendre en compte des changements sur la configuration.
  • l'impossibilité de récupérer le message d'information lié au statut du service ou de l'hôte (limitation liée au protocole OpenTelemetry).

Vous pouvez consulter cette page pour plus d'informations sur ce que permet l'intégration avec Telegraf.

Contenu du pack​

Modèles​

Le connecteur de supervision Linux Telegraf Agent apporte un modèle d'hôte :

  • OS-Linux-Telegraf-Agent-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
CpuOS-Linux-Cpu-Telegraf-Agent-customContrôle du taux d'utilisation CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur
LoadOS-Linux-Load-Telegraf-Agent-customContrôle de la charge serveur
MemoryOS-Linux-Memory-Telegraf-Agent-customContrôle du taux d'utilisation de la mémoire vive
NtpOS-Linux-Ntp-Telegraf-Agent-customContrôle la synchronisation du système avec un serveur NTP
SwapOS-Linux-Swap-Telegraf-Agent-customContrôle du taux d'utilisation de la mémoire virtuelle
UptimeOS-Linux-Uptime-Telegraf-Agent-customDurée depuis laquelle le serveur tourne sans interruption

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte OS-Linux-Telegraf-Agent-custom est utilisé.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
command.exit.code.countcount

Prérequis​

Flux réseau​

Deux flux TCP doivent être ouverts depuis l'hôte supervisé vers le collecteur.

SourceDestinationProtocolePortObjet
Hôte superviséCollecteurTCP1443Obtention de la configuration de Telegraf.
Hôte superviséCollecteurTCP4317Envoi des données au format OpenTelemetry.

Prérequis système sur le collecteur​

Rappel: pour pouvoir utiliser l'agent Telegraf, vous devez utiliser un collecteur ayant au minimum la version 24.04.2 de centreon-engine. L'agent Telegraf devra se configurer via une requête HTTPS adressée à Centreon Engine.

  1. Pour cela il faut commencer par obtenir un certificat valide pour le collecteur, ou le générer, par exemple avec la commande ci-dessous :

Dans la commande suivante, remplacez ${HOSTNAME} par le FQDN du collecteur si la valeur de cette variable ne correspond pas. Si vous paramétrez l'accès au serveur de configuration via l'adresse IP du collecteur plutôt que son FQDN, Telegraf refusera le certificat.

openssl req -new -subj "/CN=${HOSTNAME}" -addext "subjectAltName = DNS:${HOSTNAME}" -newkey rsa:2048 -sha256 -days 365 -nodes -x509 -keyout /etc/centreon-engine/conf-server.key -out /etc/centreon-engine/conf-server.crt
chown centreon-engine: /etc/centreon-engine/conf-*

L'option -days 365 limite la durée de validité du certificat à un an. Vous pouvez adapter celle-ci en fonction de vos préférences concernant la sécurité ou la maintenabilité.

  1. Puis indiquez à Engine les informations de connexion qu'il devra fournir aux agents Telegraf.
cat > /etc/centreon-engine/otl_server.json <<EOF
{
    "otel_server": {
        "host": "0.0.0.0",
        "port": 4317,
        "encryption": true,
        "certificate_path": "/etc/centreon-engine/conf-server.crt",
        "key_path": "/etc/centreon-engine/conf-server.key"
    },
    "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": "${HOSTNAME}:4317",
        "check_interval":60
    }
}
EOF
chown centreon-engine: /etc/centreon-engine/otl_server.json

Configuration de Centreon Engine​

  1. Dans le menu Configuration > Collecteurs > Configuration de Centreon Engine, sous l'onglet Données, ajoutez une entrée dans les modules Broker à charger et inscrivez-y la directive /usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json. Sauvegardez le formulaire.

  2. Exportez la configuration du collecteur, en sélectionnant l'option Redémarrer.

Prérequis système sur l'hôte à superviser​

Les prérequis ci-dessous doivent être appliqués sur les serveurs Linux à superviser pour que le connecteur de supervision puisse fonctionner.

Dans les étapes suivantes, remplacez mypoller.local par le FQDN du collecteur qui va superviser l'hôte. Veillez à bien utiliser le même nom que lors de la création du certificat.

  1. Acceptez le certificat du collecteur (s'il est autosigné).
openssl s_client -connect mypoller.local:1443 2>/dev/null </dev/null |  sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' >  /etc/pki/ca-trust/source/anchors/mypoller.local.crt
update-ca-trust

Vérifiez qu'il est bien valide avec cette commande :

curl https://mypoller.local:1443/engine

La réponse attendue à ce stade est :

<html><body>No host service found from get parameters</body></html>
  1. Installer l'agent Telegraf et ses dépendances.
dnf -y install epel-release
dnf -y config-manager --set-enabled 'powertools'

La partie qui suit est extraite de la documentation officielle de Telegraf.

cat > /etc/yum.repos.d/influxdb.repo <<'EOF'
[influxdb]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF

dnf install -y telegraf
  1. Paramétrez l'agent Telegraf pour qu'il récupère sa configuration auprès du collecteur.
cat > /etc/default/telegraf <<EOF
TELEGRAF_OPTS='--config-url-watch-interval 120s --config=https://mypoller.local:1443/engine?host=$HOSTNAME'
EOF
systemctl restart telegraf
  • Pensez à remplacer mypoller.local par le FQDN de votre collecteur.
  • Si le nom de l'hôte à superviser ne correspond pas à la valeur de la variable $HOSTNAME il vous faudra personnaliser le fichier /etc/default/telegraf.
  1. Pour permettre la supervision de systemd-journal, lancez les commandes suivantes :
usermod -a -G systemd-journal telegraf
systemctl restart telegraf
  1. Ajoutez le dépôt des plugins Centreon et installez le plugin local pour Linux.
cat >/etc/yum.repos.d/centreon-plugins.repo <<'EOF'
[centreon-plugins-stable]
name=Centreon plugins repository.
baseurl=https://packages.centreon.com/rpm-plugins/el8/stable/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1

[centreon-plugins-stable-noarch]
name=Centreon plugins repository.
baseurl=https://packages.centreon.com/rpm-plugins/el8/stable/noarch/
enabled=1
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1

[centreon-plugins-testing]
name=Centreon plugins repository. (UNSUPPORTED)
baseurl=https://packages.centreon.com/rpm-plugins/el8/testing/$basearch/
enabled=0
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1

[centreon-plugins-testing-noarch]
name=Centreon plugins repository. (UNSUPPORTED)
baseurl=https://packages.centreon.com/rpm-plugins/el8/testing/noarch/
enabled=0
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1

[centreon-plugins-unstable]
name=Centreon plugins repository. (UNSUPPORTED)
baseurl=https://packages.centreon.com/rpm-plugins/el8/unstable/$basearch/
enabled=0
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1

[centreon-plugins-unstable-noarch]
name=Centreon plugins repository. (UNSUPPORTED)
baseurl=https://packages.centreon.com/rpm-plugins/el8/unstable/noarch/
enabled=0
gpgcheck=1
gpgkey=https://yum-gpg.centreon.com/RPM-GPG-KEY-CES
module_hotfixes=1
EOF

dnf install -y centreon-plugin-Operatingsystems-Linux-Local.noarch
  1. Redémarrez le service telegraf.
systemctl restart telegraf

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-operatingsystems-linux-telegraf-agent

  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Linux Telegraf-Agent depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

  2. Créez le nouveau connecteur.

Dans le menu Configuration > Commandes > Connecteurs, cliquez sur Ajouter puis saisissez les champs suivants :

ParamètreValeur
Nom du connecteurTelegraf Agent
Description du connecteurTelegraf Agent
Ligne de commandeopentelemetry --processor=nagios_telegraf --extractor=attributes --host_path=resourceMetrics.scopeMetrics.metrics.dataPoints.attributes.host --service_path=resourceMetrics.scopeMetrics.metrics.dataPoints.attributes.service
Utilisé par la commandeSélectionnez toutes les commandes dont le nom correspond à OS-Linux-Telegraf-Agent-*
Statut du connecteurActivé

Plugin​

Ce connecteur de supervision s'appuie sur une intégration prise en charge par Centreon Engine et ne requiert pas de plugin particulier sur les collecteurs.

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte OS-Linux-Telegraf-Agent-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
TELEGRAFPLUGINSPath where the Centreon Plugins can be found./usr/lib/centreon/pluginsX
TELEGRAFSTATEFILEDIRDefine the cache directory./var/lib/telegrafX
TELEGRAFEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
COMMANDCommand to test (default: none). You can use 'sh' to use '&&' or '||'X
COMMANDOPTIONSCommand options (default: none)
THRESHOLDSSet action according command exit code. Example: %(code) == 0,OK,File xxx exist#%(code) == 1,CRITICAL,File xxx not exist#,UNKNOWN,Command problemX
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre hôte Linux en vous connectant avec l'utilisateur root. Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

sudo -u telegraf /usr/lib/centreon/plugins/centreon_linux_local.pl \
    --plugin='os::linux::local::plugin' \
    --mode='cpu' \
    --warning-core='99' \
    --critical-core='' \
    --warning-average='40' \
    --critical-average='' \
    --statefile-dir='/var/lib/telegraf'

La commande devrait retourner un message de sortie similaire à :

OK: CPU(s) average usage is 2.95 % | 'cpu.utilization.percentage'=2.95%;0:40;;0;100 '0#core.cpu.utilization.percentage'=3.07%;0:99;;0;100 '1#core.cpu.utilization.percentage'=2.83%;0:99;;0;100

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

sudo -u telegraf /usr/lib/centreon/plugins/centreon_linux_local.pl \
    --plugin='os::linux::local::plugin' \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
check-plugin [code]Not used in this Monitoring Connector
cmd-return [code]OS-Linux-Cmd-Generic-Telegraf-Agent-custom
OS-Linux-Is-File-Generic-Telegraf-Agent-custom
OS-Linux-Is-Not-File-Generic-Telegraf-Agent-custom
connections [code]OS-Linux-Connections-Generic-Telegraf-Agent-custom
cpu [code]OS-Linux-Cpu-Telegraf-Agent-custom
cpu-detailed [code]OS-Linux-Cpu-Detailed-Telegraf-Agent-custom
discovery-snmp [code]Not used in this Monitoring Connector
discovery-snmpv3 [code]Not used in this Monitoring Connector
diskio [code]OS-Linux-Disk-IO-Telegraf-Agent-custom
files-date [code]OS-Linux-File-Date-Generic-Telegraf-Agent-custom
files-size [code]OS-Linux-File-Size-Generic-Telegraf-Agent-custom
inodes [code]OS-Linux-Inodes-Telegraf-Agent-custom
list-interfaces [code]Used for service discovery
list-partitions [code]Not used in this Monitoring Connector
list-storages [code]Used for service discovery
list-systemdservices [code]Not used in this Monitoring Connector
load [code]OS-Linux-Load-Telegraf-Agent-custom
lvm [code]Not used in this Monitoring Connector
memory [code]OS-Linux-Memory-Telegraf-Agent-custom
mountpoint [code]Not used in this Monitoring Connector
ntp [code]OS-Linux-Ntp-Telegraf-Agent-custom
open-files [code]OS-Linux-Open-Files-Telegraf-Agent-custom
packet-errors [code]OS-Linux-Packet-Errors-Telegraf-Agent-custom
paging [code]Not used in this Monitoring Connector
pending-updates [code]OS-Linux-Pending-Updates-Telegraf-Agent-custom
process [code]OS-Linux-Process-Generic-Telegraf-Agent-custom
quota [code]Not used in this Monitoring Connector
storage [code]OS-Linux-Disks-Telegraf-Agent-custom
swap [code]OS-Linux-Swap-Telegraf-Agent-custom
systemd-journal [code]OS-Linux-Systemd-Journal-Telegraf-Agent-custom
systemd-sc-status [code]OS-Linux-Systemd-Sc-Status-Telegraf-Agent-custom
traffic [code]OS-Linux-Traffic-Telegraf-Agent-custom
uptime [code]OS-Linux-Uptime-Telegraf-Agent-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

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.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--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 a "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'.
--hostnameHostname to query.
--timeoutTimeout in seconds for the command (default: 45). Default value can be override by the mode.
--commandCommand to get information. Used it you have output in a file.
--command-pathCommand path.
--command-optionsCommand options.
--sudo sudo command.
--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.

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--manage-returnsSet action according command exit code. Example: %(code) == 0,OK,File xxx exist#%(code) == 1,CRITICAL,File xxx not exist#,UNKNOWN,Command problem
--separatorSet the separator used in --manage-returns (default : #)
--exec-commandCommand to test (default: none). You can use 'sh' to use '&&' or '||'.
--exec-command-pathCommand path (default: none).
--exec-command-optionsCommand options (default: none).

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

sudo -u telegraf /usr/lib/centreon/plugins/centreon_linux_local.pl \
    --plugin='os::linux::local::plugin' \
    --mode='cpu' \
    --help