Aller au contenu principal

Zscaler ZDX API

Dépendances du connecteur de supervision​

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

Contenu du pack​

Modèles​

Le connecteur de supervision Zscaler ZDX API apporte un modèle d'hôte :

  • App-Monitoring-Zscaler-Zdx-Api-custom: chaque hôte supervise une application, préférentiellement identifiée par son application_id.

Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :

Ce modèle d'hôte n'a pas de modèle de service associé.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
Zscaler Zdx ApplicationsDiscover applications monitored by Zscaler Digital Experience Monitoring (ZDX) using its REST API

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

Découverte de services​

Nom de la règleDescription
App-Monitoring-Zscaler-ZDX-Api-Location-IdDécouvre tous les locations (sites) et crée un service pour chacun d'eux.
Les métriques seront agrégées selon ce critère.

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

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é
application#application.total-users.countcount
application#application.score.valueN/A
application#application.page-fetch-time.millisecondsms

Prérequis​

Les instructions ci-dessous proviennent de la page Getting Started de la documentation de l'API de ZDX:

Votre organisation doit valider les prérequis suivants pour pouvoir accéder à l'API ZDX:

  • Créer une clé d'API.
  • Être détentrice du ZDX Advanced Plan User.

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-zscaler-zdx-api
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Zscaler ZDX API 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-Zscaler-Zdx-Api

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-Zscaler-Zdx-Api-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
ZDX_API_PROTOSpecify http if neededhttps
ZDX_API_PORTAPI port443
ZDX_API_KEY_IDKey ID (see here for more details)API_KEY_ID
ZDX_API_KEY_SECRETKey secret (see here for more details)API_KEY_SECRET
ZDX_API_PATHAPI URL path/v1
ZDX_APPLICATION_IDDefine the appid to monitor. Using this option is recommended to monitor one app because it will only retrieves the data related to the targeted appAPPLICATION_ID
ZDX_API_EXTRA_OPTIONSAny 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
MAX_METRICS_AGEDefine the maximum accepted age (in minutes) for the metrics. If no value is found, the metric will be ignored. Default: 2020
INCLUDE_APPLICATION_NAMERegular expression to include applications to monitor by their name. Using this option is not recommended to monitor one app because it will first retrieve the list of all apps and then filter to get the targeted app
EXCLUDE_APPLICATION_NAMERegular expression to exclude applications to monitor by their name. Using this option is not recommended to monitor one app because it will first retrieve the list of all apps and then filter to get the targeted app
LOCATION_IDNarrows the stats calculation to only one location given by its id. Statistics such as page fetch time, total users and score will be the average value for this location.
INCLUDE_LOCATION_NAMENarrows the stats calculation to several locations filtered by their name using this parameter as a regular expression to include them. Using this option is not recommended to filter one location because it will first retrieve the list of all locations and then filter to get the targeted location.
EXCLUDE_LOCATION_NAMENarrows the stats calculation to several locations filtered by their name using this parameter as a regular expression to exclude them. Using this option is not recommended to filter one location because it will first retrieve the list of all locations and then filter to get the targeted location.
WARNING_PAGE_FETCH_TIMEThreshold in ms
CRITICAL_PAGE_FETCH_TIMEThreshold in ms
WARNING_SCOREThreshold
CRITICAL_SCOREThreshold
WARNING_TOTAL_USERSThreshold
CRITICAL_TOTAL_USERSThreshold
EXTRA_OPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose
  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_zscaler_zdx_api.pl \
	--plugin=apps::monitoring::zscaler::zdx::api::plugin \
	--custommode=api \
	--mode=application \
	--hostname='10.0.0.1' \
	--port='443' \
	--proto='https' \
	--api-path='/v1' \
	--key-id='api-key-id' \
	--key-secret='api-key-secret' \
	--application-id='app-id' \
	--include-application-name='' \
	--exclude-application-name='' \
	--location-id='' \
	--include-location-name='' \
	--exclude-location-name='' \
	--warning-score='' \
	--critical-score='' \
	--warning-total-users='' \
	--critical-total-users='' \
	--warning-page-fetch-time='' \
	--critical-page-fetch-time='' \
	--max-metrics-age='20' \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: All apps are ok | 'application1#application.total-users.count'=53003;;;0; 'application2#application.total-users.count'=83628;;;0; 'application1#application.page-fetch-time.milliseconds'=61218ms;;;0; 'application2#application.page-fetch-time.milliseconds'=8467ms;;;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_zscaler_zdx_api.pl \
	--plugin=apps::monitoring::zscaler::zdx::api::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
application [code]App-Monitoring-Zscaler-Zdx-Application-Api-custom
discovery [code]Utilisé pour la découverte d'hôtes
list-locations [code]Utilisé pour la découverte de services

Options disponibles​

Options des modes​

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

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'
--application-idDefine the appid to monitor. Using this option is recommended to monitor one app because it will only retrieves the data related to the targeted app.
--include-application-nameRegular expression to include applications to monitor by their name. Using this option is not recommended to monitor one app because it will first retrieve the list of all apps and then filter to get the targeted app.
--exclude-application-nameRegular expression to exclude applications to monitor by their name. Using this option is not recommended to monitor one app because it will first retrieve the list of all apps and then filter to get the targeted app.
--location-idNarrows the stats calculation to only one location given by its id. Statistics such as page fetch time, total users and score will be the average value for this location.
--include-location-nameNarrows the stats calculation to several locations filtered by their name using this parameter as a regular expression to include them. Using this option is not recommended to filter one location because it will first retrieve the list of all locations and then filter to get the targeted location.
--exclude-location-nameNarrows the stats calculation to several locations filtered by their name using this parameter as a regular expression to exclude them. Using this option is not recommended to filter one location because it will first retrieve the list of all locations and then filter to get the targeted location. =back
--warning-scoreThreshold.
--critical-scoreThreshold.
--warning-total-usersThreshold.
--critical-total-usersThreshold.
--add-metricsEnables collection of metrics (page fetch time).
--warning-page-fetch-timeThreshold in ms.
--critical-page-fetch-timeThreshold in ms.
--max-metrics-ageDefine the maximum accepted age (in minutes) for the metrics. If no value is found, the metric will be ignored. Default: 20
--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
--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-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>.
--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.
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--hostnameZDX API hostname (default: api.zdxcloud.net)
--portAPI port (default: 443)
--protoSpecify http if needed (default: 'https')
--api-pathAPI URL path (default: '/api')
--key-idKey ID (see L<here|https://help.zscaler.com/zdx/managing-zdx-api-keys\> for more details).
--key-secretKey secret (see L<here|https://help.zscaler.com/zdx/managing-zdx-api-keys\> for more details).
--timeoutDefine HTTP timeout.

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_zscaler_zdx_api.pl \
	--plugin=apps::monitoring::zscaler::zdx::api::plugin \
	--custommode=api \
	--mode=application
	--help