Aller au contenu principal

LatenceTech RestAPI

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur LatenceTech RestAPI depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision LatenceTech RestAPI apporte un modèle d'hôte :

  • App-Monitoring-Latencetech-Restapi-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
ConnectivityApp-Monitoring-Latencetech-Connectivity-Restapi-customContrôle des statistiques de connectivité de l'agent
ForecastApp-Monitoring-Latencetech-Forecast-Restapi-customContrôle des statistiques de prévision de l'agent
LatencyApp-Monitoring-Latencetech-Latency-Restapi-customContrôle des statistiques de latence de l'agent
RadioApp-Monitoring-Latencetech-Radio-Restapi-customContrôle des statistiques radio de l'agent
ThroughputApp-Monitoring-Latencetech-Throughput-Restapi-customContrôle des statistiques de débit de l'agent
TwampApp-Monitoring-Latencetech-Twamp-Restapi-customContrôle des statistiques TWAMP (protocole de mesure active bidirectionnelle) de l'agent

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-Monitoring-Latencetech-Restapi-custom est utilisé.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
LatenceTechDiscover LatenceTech agents using the Rest API.

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Métriques & statuts collectés​

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

NomUnité
kpis#tcp.response.time.millisecondsms
kpis#udp.response.time.millisecondsms
kpis#http.response.time.millisecondsms
kpis#https.response.time.millisecondsms
kpis#icmp.response.time.millisecondsms
kpis#twamp.response.time.millisecondsms
kpis#download.bandwidth.bpsbps
kpis#upload.bandwidth.bpsbps
kpis#jitter.time.millisecondsms
kpis#application.latency.millisecondsms
kpis#network.latency.millisecondsms
kpis#expected.latency.millisecondsms
kpis#network.stability.percentage%
kpis#expected.stability.percentage%
kpis#volatility.percentage%
qoe-rateN/A
kpis#packetloss.rate.percentage%
kpis#expected.packetloss.rate.percentage%
connectivity-healthN/A

Prérequis​

Le connecteur de supervision requiert que l'API Rest LatenceTech soit installée sur votre instance d'analyseur. Vous pouvez vous référer à la documentation officielle de LatenceTech pour la procédure d'installation. Pour utiliser le connecteur, vous devez disposer de votre clé API et de votre ID client. La clé API est utilisée pour authentifier les requêtes envoyées à l'API Rest de LatenceTech. Vous pouvez obtenir votre ID client en interrogeant l'API avec le point de terminaison /api/v1/networks (cette requête ne nécessite pas de paramètres).

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  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 > Connecteurs > 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-applications-monitoring-latencetech-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur LatenceTech RestAPI depuis l'interface web et le menu Configuration > Connecteurs > 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 connecteur. 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-Monitoring-Latencetech-Restapi

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 App-Monitoring-Latencetech-Restapi-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
LATENCETECHAPIPROTOCOLSpecify https if neededhttps
LATENCETECHAPIPORTPort used12099
AGENTIDSet the ID of the agentX
LATENCETECHAPIKEYSet API keyX
LATENCETECHAPIPATHSet API path/api/v1
LATENCETECHCUSTOMERIDSet cutomer/network IDX
EXTRAOPTIONSAny 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
WARNINGAPPLICATIONLATENCYWarning thresholds for application latency in milliseconds
CRITICALAPPLICATIONLATENCYCritical thresholds for application latency in milliseconds
WARNINGCONNECTIVITYHEALTHDefine the conditions to match for the connectivity status to be WARNING%{connectivityHealth} =~ "Warning"
CRITICALCONNECTIVITYHEALTHDefine the conditions to match for the connectivity status to be CRITICAL%{connectivityHealth} =~ "Need Attention"
WARNINGDOWNLOADBANDWIDTHWarning thresholds for download bandwidth in bps
CRITICALDOWNLOADBANDWIDTHCritical thresholds for download bandwidth in bps
WARNINGEXPECTEDLATENCYWarning thresholds for expected latency in milliseconds
CRITICALEXPECTEDLATENCYCritical thresholds for expected latency in milliseconds
WARNINGEXPECTEDPACKETLOSSPRCTWarning thresholds for expected packet loss percentage
CRITICALEXPECTEDPACKETLOSSPRCTCritical thresholds for expected packet loss percentage
WARNINGEXPECTEDSTABILITYPRCTWarning thresholds for expected stability percentage
CRITICALEXPECTEDSTABILITYPRCTCritical thresholds for expected stability percentage
WARNINGHTTPRESPONSETIMEWarning thresholds for HTTP response time in milliseconds
CRITICALHTTPRESPONSETIMECritical thresholds for HTTP response time in milliseconds
WARNINGHTTPSRESPONSETIMEWarning thresholds for HTTPS response time in milliseconds
CRITICALHTTPSRESPONSETIMECritical thresholds for HTTPS response time in milliseconds
WARNINGICMPRESPONSETIMEWarning thresholds for ICMP response time in milliseconds
CRITICALICMPRESPONSETIMECritical thresholds for ICMP response time in milliseconds
WARNINGJITTERTIMEWarning thresholds for jitter time in milliseconds
CRITICALJITTERTIMECritical thresholds for jitter time in milliseconds
WARNINGNETWORKLATENCYWarning thresholds for network latency in milliseconds
CRITICALNETWORKLATENCYCritical thresholds for network latency in milliseconds
WARNINGNETWORKSTABILITYPRCTWarning thresholds for network stability percentage
CRITICALNETWORKSTABILITYPRCTCritical thresholds for network stability percentage
WARNINGPACKETLOSSPRCTWarning thresholds for packet loss percentage
CRITICALPACKETLOSSPRCTCritical thresholds for packet loss percentage
WARNINGQOERATEWarning thresholds for Quality of Experience rate
CRITICALQOERATECritical thresholds for Quality of Experience rate
WARNINGTCPRESPONSETIMEWarning thresholds for TCP response time in milliseconds
CRITICALTCPRESPONSETIMECritical thresholds for TCP response time in milliseconds
WARNINGTWAMPRESPONSETIMEWarning thresholds for TWAMP response time in milliseconds
CRITICALTWAMPRESPONSETIMECritical thresholds for TWAMP response time in milliseconds
WARNINGUDPRESPONSETIMEWarning thresholds for UDP response time in milliseconds
CRITICALUDPRESPONSETIMECritical thresholds for UDP response time in milliseconds
WARNINGUPLOADBANDWIDTHWarning thresholds for upload bandwidth in bps
CRITICALUPLOADBANDWIDTHCritical thresholds for upload bandwidth in bps
WARNINGVOLATILITYPRCTWarning thresholds for volatility percentage
CRITICALVOLATILITYPRCTCritical thresholds for volatility percentage
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 collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). 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) :

/usr/lib/centreon/plugins/centreon_latencetech_restapi.pl \
	--plugin=apps::monitoring::latencetech::restapi::plugin \
	--mode=twamp \
	--hostname='127.0.0.1' \
	--port='12099' \
	--proto='https' \
	--api-path='/api/v1' \
	--api-key='apikey' \
	--customer-id='1' \
	--agent-id='2'  \
	--warning-twamp-forward='' \
	--critical-twamp-forward='' \
	--warning-twamp-reverse='' \
	--critical-twamp-reverse='' \
	--warning-twamp-processing='' \
	--critical-twamp-processing=''

La commande devrait retourner un message de sortie similaire à :

OK: Agent '2' TWAMP Forward Delta: 12.92ms, TWAMP Reverse Delta: -4.19ms, TWAMP Processing Delta: 0.11ms | '2#twamp.forwarddelta.time.milliseconds'=12.92ms;;;0; '2#twamp.reversedelta.time.milliseconds'=-4.19ms;;;0; '2#twamp.processingdelta.time.milliseconds'=0.11ms;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

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 :

/usr/lib/centreon/plugins/centreon_latencetech_restapi.pl \
	--plugin=apps::monitoring::latencetech::restapi::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
connectivity [code]App-Monitoring-Latencetech-Connectivity-Restapi-custom
discovery [code]Utilisé pour la découverte d'hôtes
forecast [code]App-Monitoring-Latencetech-Forecast-Restapi-custom
latency [code]App-Monitoring-Latencetech-Latency-Restapi-custom
radio [code]App-Monitoring-Latencetech-Radio-Restapi-custom
throughput [code]App-Monitoring-Latencetech-Throughput-Restapi-custom
twamp [code]App-Monitoring-Latencetech-Twamp-Restapi-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[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()' =back
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()' =back
--extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()' =back
--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,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: 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 <new-unit-of-mesure> (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: um 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(traffic_(in|out)_$1)' =back
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-short-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' 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.
--change-output-advReplace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--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). Example: --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'. <output>.
--filter-countersOnly display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy PAC file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--hostnameSet Latencetech hostname or IP address.
--portPort used (default: 12099).
--protoSpecify https if needed (default: 'https').
--api-pathSet API path (default: '/api/v1').
--api-keySet API key (mandatory).
--customer-idSet cutomer/network ID (mandatory).
--agent-idSet Agent ID (for modes that require it).
--timeoutSet timeout in seconds (default: 10).

Options des modes​

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

OptionDescription
--agent-idSet the ID of the agent (mandatory option).
--warning-tcp-response-timeWarning thresholds for TCP response time in milliseconds.
--critical-tcp-response-timeCritical thresholds for TCP response time in milliseconds.
--warning-udp-response-timeWarning thresholds for UDP response time in milliseconds.
--critical-udp-response-timeCritical thresholds for UDP response time in milliseconds.
--warning-http-response-timeWarning thresholds for HTTP response time in milliseconds.
--critical-http-response-timeCritical thresholds for HTTP response time in milliseconds.
--warning-https-response-timeWarning thresholds for HTTPS response time in milliseconds.
--critical-https-response-timeCritical thresholds for HTTPS response time in milliseconds.
--warning-icmp-response-timeWarning thresholds for ICMP response time in milliseconds.
--critical-icmp-response-timeCritical thresholds for ICMP response time in milliseconds.
--warning-twamp-response-timeWarning thresholds for TWAMP response time in milliseconds.
--critical-twamp-response-timeCritical thresholds for TWAMP response time in milliseconds.
--warning-download-bandwidthWarning thresholds for download bandwidth in bps.
--critical-download-bandwidthCritical thresholds for download bandwidth in bps.
--warning-upload-bandwidthWarning thresholds for upload bandwidth in bps.
--critical-upload-bandwidthCritical thresholds for upload bandwidth in bps.
--warning-jitter-timeWarning thresholds for jitter time in milliseconds.
--critical-jitter-timeCritical thresholds for jitter time in milliseconds.
--warning-application-latencyWarning thresholds for application latency in milliseconds.
--critical-application-latencyCritical thresholds for application latency in milliseconds.
--warning-network-latencyWarning thresholds for network latency in milliseconds.
--critical-network-latencyCritical thresholds for network latency in milliseconds.
--warning-expected-latencyWarning thresholds for expected latency in milliseconds.
--critical-expected-latencyCritical thresholds for expected latency in milliseconds.
--warning-network-stability-prctWarning thresholds for network stability percentage.
--critical-network-stability-prctCritical thresholds for network stability percentage.
--warning-expected-stability-prctWarning thresholds for expected stability percentage.
--critical-expected-stability-prctCritical thresholds for expected stability percentage.
--warning-volatility-prctWarning thresholds for volatility percentage.
--critical-volatility-prctCritical thresholds for volatility percentage.
--warning-qoe-rateWarning thresholds for Quality of Experience rate.
--critical-qoe-rateCritical thresholds for Quality of Experience rate.
--warning-packet-loss-prctWarning thresholds for packet loss percentage.
--critical-packet-loss-prctCritical thresholds for packet loss percentage.
--warning-expected-packet-loss-prctWarning thresholds for expected packet loss percentage.
--critical-expected-packet-loss-prctCritical thresholds for expected packet loss percentage.
--warning-connectivity-healthDefine the conditions to match for the connectivity status to be WARNING. (default: '%{connectivityHealth} =~ "Warning"').
--critical-connectivity-healthDefine the conditions to match for the connectivity status to be CRITICAL. (default: '%{connectivityHealth} =~ "Need Attention"').

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 :

/usr/lib/centreon/plugins/centreon_latencetech_restapi.pl \
	--plugin=apps::monitoring::latencetech::restapi::plugin \
	--mode=twamp \
	--help