Aller au contenu principal

TCP Protocol

Contenu du Pack​

Modèles​

Le connecteur de supervision Protocol TCP apporte 2 modèles d'hôte :

  • App-Protocol-Tcp
  • App-Protocol-Tcp-Only

Le connecteur apporte les modèles de service suivants (classés par modèle d'hôte):

AliasModèle de serviceDescription
N/AN/AN/A

Métriques & statuts collectés​

MétriqueUnité
statusN/A
tcp.response.time.secondss

Installation​

Pack de supervision​

Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack 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 paquet associé à sa distribution :

dnf install centreon-pack-applications-protocol-tcp

Quel que soit le type de la licence (online ou offline), installez le Pack Protocol TCP depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un pack. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-Protocol-Tcp

Configuration​

Hôte​

  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 App-Protocol-Tcp-custom.
ObligatoireMacroDescriptionDéfaut
TCPPACKETLOSSPERCENT50
TCPPACKETS1
TCPPORT80
TCPTIMEOUT3

Service​

Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.

ObligatoireMacroDescriptionDéfaut
TIMEOUTConnection timeout in seconds (Default: 3)5
PORTPort used
WARNING
CRITICAL
EXTRAOPTIONSAny extra option you may want to add to the command line (eg. a --verbose flag)

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 collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine) :

/usr/lib/centreon/plugins//centreon_protocol_tcp.pl \
    --plugin=apps::protocols::tcp::plugin \
    --mode=response-time  \
    --hostname='10.0.0.1' \
    --port='80' \
    --timeout='' \
    --warning-rta='' \
    --critical-rta='' \
    --warning-rtmax='' \
    --critical-rtmax='' \
    --warning-rtmin='' \
    --critical-rtmin='' \
    --warning-pl='' \
    --critical-pl='' \

La commande devrait retourner un message de sortie similaire à :

OK: TCP '10.0.0.1' port 80 rta 0.633ms, lost 0% | 'tcp.roundtrip.time.average.milliseconds'=0.633ms;;;0; 'tcp.roundtrip.time.maximum.milliseconds'=2.145ms;;;0; 'tcp.roundtrip.time.minimum.milliseconds'=0.193ms;;;0; 'tcp.packets.loss.percentage'=0%;;;0;100

Modes disponibles​

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

/usr/lib/centreon/plugins//centreon_protocol_tcp.pl \
    --plugin=apps::protocols::tcp::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
connection-statusApp-Protocol-Tcp-Connection-Status
response-timeApp-Protocol-Tcp-Response-Time

Options complémentaires​

OptionDescriptionType
--modeChoose a mode.Global
--dyn-modeSpecify a mode with the path (separated by '::').Global
--list-modeList available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionDisplay plugin version.Global
--pass-managerUse a password manager.Global
--verboseDisplay long output.Output
--debugDisplay also debug messages.Output
--filter-perfdataFilter perfdata that match the regexp.Output
--filter-perfdata-advAdvanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")'Output
--explode-perfdata-maxPut max perfdata (if it exist) in a specific perfdata (without values: same with '_max' suffix) (Multiple options)Output
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --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()Output
--extend-perfdata-groupExtend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target[,[newuom],[m in],[max]] 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)'Output
--change-short-output --change-long-outputChange short/long output display: --change-short-output=pattern~replace~modifierOutput
--change-exitChange exit code: --change-exit=unknown=criticalOutput
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomFilter UOM that match the regexp.Output
--opt-exitOptional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown).Output
--output-ignore-perfdataRemove perfdata from output.Output
--output-ignore-labelRemove label status from output.Output
--output-xmlDisplay output in XML format.Output
--output-jsonDisplay output in JSON format.Output
--output-openmetricsDisplay metrics in OpenMetrics format.Output
--output-fileWrite output in file (can be used with json and xml options)Output
--disco-formatDisplay discovery arguments (if the mode manages it).Output
--disco-showDisplay discovery values (if the mode manages it).Output
--float-precisionSet the float precision for thresholds (Default: 8).Output
--source-encodingSet encoding of monitoring sources (In some case. Default: 'UTF-8').Output

Options des modes​

Les options spécifiques aux modes sont listées ci-dessus :

OptionDescriptionType
--hostnameIP Addr/FQDN of the hostMode
--portPort usedMode
--sslUse SSL connection. (no attempt is made to check the certificatevalidity by default).Mode
--timeoutConnection timeout in seconds (Default: 3)Mode
--unknown-statusSet unknown threshold for status. Can used special variables like: %{status}, %{port}, %{error_message}Mode
--warning-statusSet warning threshold for status. Can used special variables like: %{status}, %{port}, %{error_message}Mode
--critical-statusSet critical threshold for status (Default: '%{status} eq "failed"'). Can used special variables like: %{status}, %{port}, %{error_message}Mode
--warning-timeThreshold warning in secondsMode
--critical-timeThreshold critical in secondsMode

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

/usr/lib/centreon/plugins//centreon_protocol_tcp.pl \
    --plugin=apps::protocols::tcp::plugin \
    --mode=connection-status  \
    --help

Diagnostic des erreurs communes​

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