Skip to main content

Kadiska Rest API

Pack Assets​

Templates​

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

  • App-Monitoring-Kadiska-Runner-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-Statistics-Per-CountryApp-Monitoring-Kadiska-Restapi-Watcher-Statistics-Per-CountryChecking performance metrics from Kadiska watchers per country
Watcher-Statistics-Per-ISPApp-Monitoring-Kadiska-Restapi-Watcher-Statistics-Per-ISPChecking performance metrics from Kadiska watchers per ISP
Watcher-Statistics-Per-Site-And-GatewayApp-Monitoring-Kadiska-Restapi-Watcher-Statistics-Per-Site-And-GatewayChecking performance metrics from Kadiska watchers per site and gatewayX

Discovery rules​

Rule NameDescription
RunnersDiscover Kadiska runners
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​

Monitoring Pack​

If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the pack displayed within the Configuration > Plugin Packs > Manager 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-kadiska-restapi

Whatever the license type (online or offline), install the Kadiska Rest API Pack through the Configuration > Plugin Packs > Manager 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-Kadiska-Restapi

Configuration​

Host​

Kadiska Runner​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias fields according to your Kadiska runner name.
  • Specify Kadiska API address name in IP Address/DNS.
  • Apply the App-Monitoring-Kadiska-Runner-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')
XRUNNERNAMESpecify Kadiska runner name
TIMEOUT

Kadiska Watcher​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias fields according to your Kadiska watcher name.
  • Specify Kadiska API address name in IP Address/DNS.
  • 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')
GATEWAYNAMESpecify Kadiska gateway name
SITENAMESpecify Kadiska site name
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=watcher-statistics \
    --client-id= \
    --client-secret= \
    --select-watcher-name= \
    --select-site-name= \
    --select-gateway-name= \
    --period=15 \
    --port='443' \
    --proto='https' \
    --timeout='' \
    --use-new-perfdata

The expected command output is shown below:

OK: DTT spent: 9000 ms Errors: 9000 Full time network spent: 9000 ms Sessions: 9000 SRT spent: 9000 ms Requests: 9000 Redirect time avg: 9000 ms Loading page duration: 9000 ms Loaded pages: %d API Processing duration: 9000 ms Connected users: 9000 Waiting time avg: 9000 ms DTT spent: 9000 ms Errors: 9000%% Full time network spent: 9000 ms Sessions: 9000 SRT spent: 9000 ms Requests: 9000 Redirect time avg: 9000 ms Loading page duration: 9000 ms Loaded pages: %d API Processing duration: 9000 ms Connected users: 9000 Waiting time avg: 9000 ms DTT spent: 9000 ms Errors: 9000% Full network time spent: 9000 ms Loading page duration: 9000 ms Loaded pages: %d API Processing duration: 9000 ms Redirect time avg: 9000 ms Requests: 9000 Sessions: 9000 SRT spent: 9000 ms Connected users: 9000 Waiting time: 9000 ms | 'isp.dtt.spent.time.milliseconds'=9000ms;;;0; 'isp.errors.percentage'=9000%;;;0;100 'isp.network.spent.time.milliseconds'=9000ms;;;0; 'isp.sessions.count'=9000;;;0; 'isp.srt.spent.time.milliseconds'=9000ms;;;0; 'isp.requests.count'=9000;;;0; 'isp.redirect.time.milliseconds'=9000ms;;;0; 'isp.loading.page.duration.milliseconds'=9000ms;;;0; 'isp.pages.count'=9000;;;0; 'isp.processing.duration.milliseconds'=9000ms;;;0; 'users.count'=9000;;;0; 'isp.waiting.time.milliseconds'=9000ms;;;0; 'watcher.dtt.spent.time.milliseconds'=9000ms;;;0; 'watcher.errors.percentage'=9000%;;;0;100 'watcher.network.spent.time.milliseconds'=9000ms;;;0; 'watcher.sessions.count'=9000;;;0; 'watcher.srt.spent.time.milliseconds'=9000ms;;;0; 'watcher.requests.count'=9000;;;0; 'watcher.redirect.time.milliseconds'=9000ms;;;0; 'watchers.loading.page.duration.milliseconds'=9000ms;;;0; 'watchers.pages.count'=9000;;;0; 'watchers.processing.duration.milliseconds'=9000ms;;;0; 'users.count'=9000;;;0; 'watchers.waiting.time.milliseconds'=9000ms;;;0; 'watcher.dtt.spent.time.milliseconds'=9000;;;; 'watcher.errors.percentage'=9000;;;; 'watcher.network.spent.time.milliseconds'=9000;;;; 'watcher.loading.page.duration.milliseconds'=9000;;;; 'watcher.pages.count'=9000;;;; 'watcher.processing.duration.milliseconds'=9000;;;; 'watcher.redirect.time.milliseconds'=9000;;;; 'watcher.requests.count'=9000;;;; 'watcher.sessions.count'=9000;;;; 'watcher.srt.spent.time.milliseconds'=9000;;;; 'users.count'=9000;;;; 'watcher.waiting.time.milliseconds'=9000;;;;

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=watcher-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.