Skip to main content

LatenceTech RestAPI

Connector dependencies​

The following monitoring connectors will be installed when you install the LatenceTech RestAPI connector through the Configuration > Connectors > Monitoring Connectors menu:

Pack assets​

Templates​

The Monitoring Connector LatenceTech RestAPI brings a host template:

  • App-Monitoring-Latencetech-Restapi-custom

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

Service AliasService TemplateService Description
ConnectivityApp-Monitoring-Latencetech-Connectivity-Restapi-customCheck agent connectivity statistics
ForecastApp-Monitoring-Latencetech-Forecast-Restapi-customCheck agent forecast statistics
LatencyApp-Monitoring-Latencetech-Latency-Restapi-customCheck agent latency statistics
RadioApp-Monitoring-Latencetech-Radio-Restapi-customCheck agent radio statistics
ThroughputApp-Monitoring-Latencetech-Throughput-Restapi-customCheck agent throughput statistics
TwampApp-Monitoring-Latencetech-Twamp-Restapi-customCheck agent TWAMP (Two-way active measurement protocol) statistics

The services listed above are created automatically when the App-Monitoring-Latencetech-Restapi-custom host template is used.

Discovery rules​

Host discovery​

Rule nameDescription
LatenceTechDiscover LatenceTech agents using the Rest API.

More information about discovering hosts automatically is available on the dedicated page.

Collected metrics & status​

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

NameUnit
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

Prerequisites​

The connector requires the LatenceTech Rest API to be installed on your analyzer instance. You can refer to the LatenceTech official documentation for the installation procedure. To use the connector, you need to have your API key and Customer ID. The API key is used to authenticate the requests sent to the LatenceTech RestAPI. You can get your customer ID by requesting the API with the /api/v1/networks endpoint (this request does not need any parameters).

Installing the monitoring connector​

Pack​

The installation procedures for monitoring connectors are slightly different depending on whether your license is offline or online.

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Connectors > Monitoring Connectors menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-monitoring-latencetech-restapi
  1. Whatever the license type (online or offline), install the LatenceTech RestAPI connector through the Configuration > Connectors > Monitoring Connectors menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Monitoring-Latencetech-Restapi

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 in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the App-Monitoring-Latencetech-Restapi-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.
MacroDescriptionDefault valueMandatory
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). All options are listed here.
  1. 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.

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).
MacroDescriptionDefault valueMandatory
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). All options are listed here.
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. 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?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/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=''

The expected command output is shown below:

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;

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter.

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

All available modes can be displayed by adding the --list-mode parameter to the command:

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

The plugin brings the following modes:

ModeLinked service template
connectivity [code]App-Monitoring-Latencetech-Connectivity-Restapi-custom
discovery [code]Used for host discovery
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

Available options​

Generic options​

All generic options are listed here:

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

Modes options​

All available options for each service template are listed below:

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

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

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