Skip to main content

Kadiska Rest API

Pack Assets​

Templates​

The Centreon Plugin Pack Kadiska Rest API brings 2 different host templates:

  • App-Monitoring-Kadiska-Station-Restapi-custom
  • App-Monitoring-Kadiska-Watcher-Restapi-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefaultDiscovery
Target-StatisticsApp-Monitoring-Kadiska-Restapi-Target-StatisticsChecking performance metrics from Kadiska targets using Rest APIXX
Watcher-StatisticsApp-Monitoring-Kadiska-Restapi-Watcher-StatisticsChecking performance metrics from Kadiska watchers using Rest APIX

Discovery rules​

Rule NameDescription
StationsDiscover Kadiska stations
WatchersDiscover Kadiska watchers

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

Collected metrics & status​

Metric NameUnit
targets#tracer.packets.loss.percentage%
targets#tracer.path.length
targets#tracer.round.trip.persecondms

Prerequisites​

A client ID and client secret are needed to be able to request Kadisa API.

To get these tokens, go to https://app.kadiska.com/ and in Configuration > API Clients to create a client with Data Analyst role. Ensure to keep the client secret because you will not be able to retrieve it from Kadiska interface afterwards.

Setup​

  1. Install the plugin package on every Centreon poller expected to monitor Kadiska Rest API resources:
yum install centreon-plugin-Applications-Monitoring-Kadiska-Restapi
  1. On the Centreon web interface, on page Configuration > Plugin Packs, install the Kadiska Rest API Centreon Plugin Pack.

Configuration​

Host​

Kadiska Station​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Kadiska Rest API server settings.
  • Apply the App-Monitoring-Kadiska-Station-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
XKADISKAAPICLIENTIDKadiska Client ID
XKADISKAAPICLIENTSECRETKadiska Client Secret
KADISKAAPIPORT(Default: '443')
KADISKAAPIPROTO(Default: 'https')
XSTATIONNAMESpecify Kadiska station name
TIMEOUT

Kadiska Watcher​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Kadiska Rest API server settings.
  • Apply the App-Monitoring-Kadiska-Watcher-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
XKADISKAAPICLIENTIDKadiska Client ID
XKADISKAAPICLIENTSECRETKadiska Client Secret
KADISKAAPIPORT(Default: '443')
KADISKAAPIPROTO(Default: 'https')
XWATCHERNAMESpecify Kadiska watcher name
TIMEOUT

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) and test the plugin by running the following command:

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--mode=nettracer-statistics \
--client-id='client:xxx' \
--client-secret='my-secret' \
--filter-station-name='Paris-RT' \
--filter-tracer='tracername' \
--period=15 \
--port='443' \
--proto='https' \
--timeout='' \
--verbose \

The expected command output is shown below:

OK: Round trip: 2 ms Path length: 9 Packets Loss: 3 % | 'tracer.round.trip.persecond'=2ms;;;0; 'tracer.path.length'=9;;;0; 'tracer.packets.loss.percentage'=3%;;;0;100 

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

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--mode=nettracer-statistics \
--help

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

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--list-mode

Troubleshooting​

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