Exense Step REST API
Dépendances du connecteur de supervision
Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Exense Step REST API depuis la page Configuration > Connecteurs > Connecteurs de supervision :
Contenu du pack
Modèles
Le connecteur de supervision Exense Step REST API apporte un modèle d'hôte :
- App-Exense-Step-Restapi-custom
Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :
- App-Exense-Step-Restapi-custom
- Non rattachés à un modèle d'hôte
Aucun service par défaut.
| Alias | Modèle de service | Description | Découverte |
|---|---|---|---|
| Plans | App-Exense-Step-Plans-Restapi-custom | Contrôle les plans | X |
Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, créez un service manuellement et appliquez le modèle de service souhaité.
Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.
Règles de découverte
Découverte de services
| Nom de la règle | Description |
|---|---|
| App-Exense-Step-Plans-Restapi-Plan-Name | Découvre tous les plans pour les superviser individuellement. |
| App-Exense-Step-Plans-Restapi-Tenant-Name | Découvre les tenants pour superviser tous les plans de chaque tenant en un service. |
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.
- Plans
| Nom | Unité |
|---|---|
| plans.detected.count | count |
| plans~plan.executions.detected.count | count |
| plans~plan.executions.failed.percentage | % |
| plans~plan.execution.last.seconds | s |
| plans~plan.running.duration.seconds | s |
| plan-execution-status | N/A |
| plan-execution-status | N/A |
Prérequis
- Le collecteur Centreon doit avoir un accès réseau au serveur Exense Step : Vérifier que l’API REST est accessible manuellement avec curl ou un navigateur.
http://<step-host>:<port>/step/rest
- Vérifier que le collecteur Centreon peut s'authentifier auprès de l'API. Le compte utilisé doit avoir des droits de lecture sur les ressources suivantes :
- Plans
- Tenants (si multi-tenancy activé)
En cas de problème vous pouvez vérifier manuellement que vous avez bien accès à l'API avec l'utilisateur centreon-engine en faisant cette commande curl :
curl -u user:pass http://<step-host>:<port>/step/rest/plans
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.
- 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-applications-exense-step-restapi
dnf install centreon-pack-applications-exense-step-restapi
apt install centreon-pack-applications-exense-step-restapi
yum install centreon-pack-applications-exense-step-restapi
- Quel que soit le type de la licence (online ou offline), installez le connecteur Exense Step REST 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Applications-Exense-Step-Restapi
dnf install centreon-plugin-Applications-Exense-Step-Restapi
apt install centreon-plugin-applications-exense-step-restapi
yum install centreon-plugin-Applications-Exense-Step-Restapi
Utiliser le connecteur de supervision
Utiliser un modèle d'hôte issu du connecteur
- Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
- Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
- Appliquez le modèle d'hôte App-Exense-Step-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.
- Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
| Macro | Description | Valeur par défaut | Obligatoire |
|---|---|---|---|
| APIUSERNAME | Set API username | USERNAME | |
| APIPASSWORD | Set API password | PASSWORD | X |
| APITOKEN | Use token authentication | TOKEN | |
| APIPROTO | Specify https if needed (default: 'https') | https | |
| APIPORT | API port (default: 443) | 443 | |
| APITIMEOUT | Set HTTP timeout | ||
| APIEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici. |
- 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
- 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.
- 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.
- Plans
| Macro | Description | Valeur par défaut | Obligatoire |
|---|---|---|---|
| TENANTNAME | Check plan of a tenant (default: '[All]') | ||
| FILTERPLANID | Filter plans by plan ID | ||
| FILTERPLANNAME | Filter plans by plan name | ||
| FILTERENVIRONMENT | Filter plan executions by environment name | ||
| SINCETIMEPERIOD | Time period to get plans executions information (in seconds. default: 86400) | ||
| ONLYLASTEXECUTION | Check only last plan execution | ||
| TIMEZONE | Define timezone for start/end plan execution time (default is 'UTC') | ||
| STATUSFAILED | Expression to define status failed (default: '%{result} =~ /technical_error|failed|interrupted/i') | ||
| UNKNOWNPLANEXECUTIONSTATUS | Set unknown threshold for last plan execution status. You can use the following variables: %{status}, %{planName} | ||
| WARNINGPLANEXECUTIONLAST | Thresholds | ||
| CRITICALPLANEXECUTIONLAST | Thresholds | ||
| WARNINGPLANEXECUTIONSDETECTED | Thresholds | ||
| CRITICALPLANEXECUTIONSDETECTED | Thresholds | ||
| WARNINGPLANEXECUTIONSFAILEDPRCT | Thresholds | ||
| CRITICALPLANEXECUTIONSFAILEDPRCT | Thresholds | ||
| WARNINGPLANEXECUTIONSTATUS | Set warning threshold for last plan execution status. You can use the following variables: %{status}, %{planName} | ||
| CRITICALPLANEXECUTIONSTATUS | Set critical threshold for last plan execution status. You can use the following variables: %{status}, %{planName} | ||
| WARNINGPLANRUNNINGDURATION | Thresholds | ||
| CRITICALPLANRUNNINGDURATION | Thresholds | ||
| WARNINGPLANSDETECTED | Thresholds | ||
| CRITICALPLANSDETECTED | Thresholds | ||
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. | --verbose |
- 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_exense_step_restapi.pl \
--plugin=apps::exense::step::restapi::plugin \
--custommode=api \
--mode=plans \
--hostname='10.0.0.1' \
--port='443' \
--proto='https' \
--token='TOKEN' \
--api-username='USERNAME' \
--api-password='PASSWORD' \
--timeout='' \
--tenant-name='' \
--filter-plan-id='' \
--filter-plan-name='' \
--filter-environment='' \
--since-timeperiod='' \
--only-last-execution='' \
--timezone='' \
--status-failed='' \
--unknown-plan-execution-status='' \
--warning-plan-execution-status='' \
--critical-plan-execution-status='' \
--warning-plans-detected='' \
--critical-plans-detected='' \
--warning-plan-executions-detected='' \
--critical-plan-executions-detected='' \
--warning-plan-executions-failed-prct='' \
--critical-plan-executions-failed-prct='' \
--warning-plan-execution-last='' \
--critical-plan-execution-last='' \
--warning-plan-running-duration='' \
--critical-plan-running-duration=''
La commande devrait retourner un message de sortie similaire à :
OK: detected: 14004 number of plan executions detected: 27141 number of failed executions: 52904 % last execution 48712 running duration 88986 executions are ok | 'plans.detected.count'=14004;;;0; 'plans~plan.executions.detected.count'=27141;;;0; 'plans~plan.executions.failed.percentage'=52904%;;;0;100 'plans~plan.execution.last.seconds'=48712s;;;; 'plans~plan.running.duration.seconds'=88986s;;;;
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_exense_step_restapi.pl \
--plugin=apps::exense::step::restapi::plugin \
--list-mode
Le plugin apporte les modes suivants :
| Mode | Modèle de service associé |
|---|---|
| list-plans [code] | Used for service discovery |
| list-tenants [code] | Used for service discovery |
| plans [code] | App-Exense-Step-Plans-Restapi-custom |
Options disponibles
Options des modes
Les options disponibles pour chaque modèle de services sont listées ci-dessous :
- Plans
| Option | Description |
|---|---|
| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
| --tenant-name | Check plan of a tenant (default: '[All]'). |
| --filter-plan-id | Filter plans by plan ID. |
| --filter-plan-name | Filter plans by plan name. |
| --filter-environment | Filter plan executions by environment name. |
| --since-timeperiod | Time period to get plans executions information (in seconds. default: 86400). |
| --only-last-execution | Check only last plan execution. |
| --timezone | Define timezone for start/end plan execution time (default is 'UTC'). |
| --status-failed | Expression to define status failed (default: '%{result} =~ /technical_error|failed|interrupted/i'). |
| --unknown-plan-execution-status | Set unknown threshold for last plan execution status. You can use the following variables: %{status}, %{planName} |
| --warning-plan-execution-status | Set warning threshold for last plan execution status. You can use the following variables: %{status}, %{planName} |
| --critical-plan-execution-status | Set critical threshold for last plan execution status. You can use the following variables: %{status}, %{planName} |
| --warning-plans-detected | Thresholds. |
| --critical-plans-detected | Thresholds. |
| --warning-plan-executions-detected | Thresholds. |
| --critical-plan-executions-detected | Thresholds. |
| --warning-plan-executions-failed-prct | Thresholds. |
| --critical-plan-executions-failed-prct | Thresholds. |
| --warning-plan-execution-last | Thresholds. |
| --critical-plan-execution-last | Thresholds. |
| --warning-plan-running-duration | Thresholds. |
| --critical-plan-running-duration | Thresholds. |
| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). |
| --dyn-mode | Specify a mode with the module's path (advanced). |
| --list-mode | List all available modes. |
| --mode-version | Check minimal version of mode. If not, unknown error. |
| --version | Return the version of the plugin. |
| --custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. |
| --list-custommode | List all available custom modes. |
| --multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). |
| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
| --verbose | Display extended status information (long output). |
| --debug | Display debug messages. |
| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
| --filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 Convert 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-group | Add 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: =over 4 Sum 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-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
| --change-exit | Replace 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-adv | Replace 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-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. |
| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' |
| --output-xml | Return the output in XML format (to send to an XML API). |
| --output-json | Return the output in JSON format (to send to a JSON API). |
| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
| --output-file | Write 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-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
| --float-precision | Define the float precision for thresholds (default: 8). |
| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B<output>. =cut |
| --http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. |
| --proxyurl | Proxy URL. Example: http://my.proxy:3128 |
| --proxypac | Proxy pac file (can be a URL or a local file). |
| --insecure | Accept insecure SSL connections. |
| --http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. |
| --memcached | Memcached server to use (only one server). |
| --redis-server | Redis server to use (only one server). Syntax: address[:port] |
| --redis-attribute | Set Redis Options (--redis-attribute="cnx_timeout=5"). |
| --redis-db | Set Redis database index. |
| --failback-file | Fall back on a local file if Redis connection fails. |
| --memexpiration | Time to keep data in seconds (default: 86400). |
| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). |
| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). |
| --statefile-concat-cwd | If 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-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). |
| --statefile-key | Define the key to encrypt/decrypt the cache. |
| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). |
| --hostname | API hostname. |
| --port | API port (default: 443) |
| --proto | Specify https if needed (default: 'https') |
| --token | Use token authentication. |
| --api-username | Set API username |
| --api-password | Set API password |
| --timeout | Set 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_exense_step_restapi.pl \
--plugin=apps::exense::step::restapi::plugin \
--custommode=api \
--help