Aller au contenu principal

Prometheus Server API

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Prometheus Server API depuis la page Configuration > Gestionnaire de connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Prometheus Server API apporte 2 modèles d'hôte :

  • Cloud-Prometheus-Api-custom
  • Cloud-Prometheus-Target-Name-Api-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
Target-StatusCloud-Prometheus-Target-Status-Api-customContrôle le statut des sources de données

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Prometheus-Api-custom est utilisé.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
Prometheus TargetsDécouvre les Targets Prometheus

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

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é
statusN/A

Prérequis​

Le Collecteur Centreon doit être en mesure d'executer des requêtes HTTP(S) vers le Serveur Prometheus.

Installer le connecteur de supervision​

Pack​

  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 > Gestionnaire de 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-cloud-prometheus-api
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Prometheus Server depuis l'interface web et le menu Configuration > Gestionnaire de 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-Cloud-Prometheus-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 Cloud-Prometheus-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
PROMETHEUSAPIPROTOSpecify https if neededhttp
PROMETHEUSAPIPORTAPI port9090
PROMETHEUSAPIURLAPI URL path/api/v1
EXTRAOPTIONSAny 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
INSTANCESet the instance label on which the results should be calculate for (example: --instance='name')
OUTPUTSet the output for each instances (example: --output='Container %{instance} value is %{label}')
MULTIPLEOUTPUTSet the global output in case everything is fine for multiple instances (example: --multiple-output='Containers are OK')
WARNINGSTATUSDefine the conditions to match for the status to be WARNING. Can use special variables like %{instance} and any other labels you set through --query and --query-range options
CRITICALSTATUSDefine the conditions to match for the status to be CRITICAL. Can use special variables like %{instance} and any other labels you set through --query and --query-range options
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  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_prometheus_api.pl \
	--plugin=cloud::prometheus::restapi::plugin \
	--mode=target-status \
	--hostname=10.0.0.1 \
	--url-path='/api/v1' \
	--port='9090' \
	--proto='http'  \
	--warning-status='' \
	--critical-status='%\{health\} !~ /up/' \
	--warning-active='' \
	--critical-active='' \
	--warning-dropped='' \
	--critical-dropped='' \
	--warning-up='' \
	--critical-up='' \
	--warning-down='' \
	--critical-down='' \
	--warning-unknown='' \
	--critical-unknown='' \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: Targets Active: 2, Dropped: 175, Up: 2, Down: 0, Unknown: 0 - All targets status are ok | 'targets.active.count'=2;;;0; 'targets.dropped.count'=175;;;0; 'targets.up.count'=2;;;0; 'targets.down.count'=0;;;0; 'targets.unknown.count'=0;;;0;
Target 'http://10.244.1.249:9153/metrics' health is 'up' [pod = coredns-74ff55c5b-g4hmt][namespace = kube-system][service = prometheus-operator-coredns][instance = 10.244.1.249:9153][job = coredns][endpoint = http-metrics]
Target 'http://10.244.2.5:9153/metrics' health is 'up' [pod = coredns-74ff55c5b-vh9zt][namespace = kube-system][service = prometheus-operator-coredns][instance = 10.244.2.5:9153][job = coredns][endpoint = http-metrics]

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

UNKNOWN: 500 Can't connect to amzprometheus.int.centreon.com:9090 (<error_text>) |​

Lorsque cette erreur est renvoyée, vérifier que les informations pour contacter le serveur Prometheus sont correctes (Port, Nom d'Hôte) et que la connexion est possible.

Le contenu de la balise <error_text> donne des indications supplémentaires sur la cause du dysfonctionnement.

UNKNOWN: 400 Bad Request |​

La requête PromQL contient probablement une erreur de syntaxe. Il est nécessaire de valider son fonctionnement dans l'interface Prometheus.

Comment utiliser le mode Expression (générique) ?​

Note : Ce mode peut être utilisé à la fois directement sur un hôte étant un serveur Prometheus et à la fois sur un hôte pour lequel Prometheus récupère des métriques. Dans les deux cas, l'hôte doit hérité du modèle Cloud-Prometheus-Api-custom et le service doit être créé manuellement au moyen du modèle de service Cloud-Prometheus-Expression-Api-custom

Voici un exemple pour illustrer comment le mode Expression fonctionne :

/usr/lib/centreon/plugins//centreon_prometheus_api.pl \
    --plugin=cloud::prometheus::restapi::plugin \
    --mode=expression \
    --hostname=amzprometheus.int.centreon.com \
    --url-path='/api/v1' --port='9090' --proto='http' \
    --query='cpu_requests,sum by (node) (kube_pod_container_resource_requests_cpu_cores) / sum by (node) (kube_node_status_capacity_cpu_cores) * 100' \
    --output='%\{instance\} CPU Requests: %\{cpu_requests\}%' --multiple-output='Nodes CPU Requests within bounds' \
    --instance='node' \
    --warning-status='%\{cpu_requests\} > 60' --critical-status='%\{cpu_requests\} > 70' \
    --use-new-perfdata --verbose
Option --query et Macro QUERIES associée​

L'option --query permet de définir deux paramètres :

  • le nom de la métrique pour Centreon (cpu_requests)
  • la requête PromQL (sum by (node) (kube_pod_container_resource_requests_cpu_cores) / sum by (node) (kube_node_status_capacity_cpu_cores) * 100)

Dans la configuration du service, vous pouvez spécifier plusieurs requêtes c'est pour cette raison que la macro QUERIES inclut exceptionnellement la définition du nom de la métrique. Dans le cas ci-dessus, la macro QUERIES vaudrait --query='cpu_requests,sum by (node) (kube_pod_container_resource_requests_cpu_cores) / sum by (node) (kube_node_status_capacity_cpu_cores) * 100'.

Option --instance et Macro associée​

L'option --instance permet de préciser le label utilisé dans les graphs. La macro MACRO dans cet exemple serait node grâce à l'option --instance='node'.

Options --multiple-output/--output et macros MULTIPLEOUTPUT/OUTPUT associées​

Les options d'output permettent de personnaliser les messages de sortie dans les cas suivants :

  • Supervision d'une métrique sur plusieurs instances
  • Check retournant une erreur

Les valeurs peuvent être spécifiées via les macros correspondantes. Dans l'exemple ci-dessus la macro OUTPUT vaudrait "%{instance} CPU Requests: %{cpu_requests}%". Notez que le label Centreon défini dans l'option --query est utilisée pour afficher la valeur obtenue. La variable %{instance} est aussi utilisée pour afficher le nom du node.

La macro MULTIOUTPUT vaudrait Nodes CPU Requests within bounds.

Options --\*-status et macros *STATUS associées​

Les options --warning-status et --critical-status permettent de définir les seuils d'alerte.

Toujours dans l'exemple ci-dessus, l'alerte WARNING sera déclenchée quand la valeur de cpu_requests dépassera 60 et CRITICAL quand elle dépassera 70.

La macro WARNINGSTATUS vaudrait '%{cpu_requests} > 60'. La macro CRITICALSTATUS vaudrait '%{cpu_requests} > 70'.

Notez que le label Centreon spécifié dans l'option --query est utilisé à nouveau pour comparer les valeurs aux seuils.

Sortie du Plugin et résumé des macros​

Si tout fonctionne correctement, un message similaire au suivant devrait s'afficher:

OK: Nodes CPU Requests within bounds | 'amzkubemaster.int.centreon.com#cpu_requests'=37.5;;;; 'amzkubenode1.int.centreon.com#cpu_requests'=35;;;; 'amzkubenode2.int.centreon.com#cpu_requests'=30;;;;
amzkubemaster.int.centreon.com CPU Requests: 37.5%
amzkubenode1.int.centreon.com CPU Requests: 35%
amzkubenode2.int.centreon.com CPU Requests: 30%

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_prometheus_api.pl \
	--plugin=cloud::prometheus::restapi::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
discovery [code]Used for host discovery
expression [code]Cloud-Prometheus-Expression-Api-custom
target-status [code]Cloud-Prometheus-Target-Name-Status-Api-custom
Cloud-Prometheus-Target-Status-Api-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

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[,[newuom],[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
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[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-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,namesofnewmetrics,calculation[,[newuom],[min],[max]] regex: regular expression namesofnewmetrics: 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 newuom (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-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.
--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). E.g.: --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'. =head1 DESCRIPTION B<output>. =cut
--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.
--timeframeSet timeframe in seconds (i.e. 3600 to check last hour).
--stepSet the step of the metric query (examples: '30s', '1m', '15m', '1h').
--hostnamePrometheus hostname.
--url-pathAPI url path (default: '/api/v1')
--portAPI port (default: 9090)
--protoSpecify https if needed (default: 'http')
--credentialsSpecify this option if you access the API with authentication
--usernameSpecify the username for authentication (mandatory if --credentials is specified)
--passwordSpecify the password for authentication (mandatory if --credentials is specified)
--basicSpecify this option if you access the API over basic authentication and don't want a '401 UNAUTHORIZED' error to be logged on your web server. Specify this option if you access the API over hidden basic authentication or you'll get a '404 NOT FOUND' error. (use with --credentials)
--timeoutSet HTTP timeout
--headerSet HTTP header (can be multiple, example: --header='Authorization:Bearer ABCD') Useful to access Prometheus API hosted in a specific environment.

Options des modes​

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

OptionDescription
--querySet a PromQL query. Query option must be like --query='label,query'.
--query-rangeSet a PromQL query. Query option must be like --query-range='label,query'. This query type uses --step, --timeframe and --aggregation options to compute the values.
--instanceSet the instance label on which the results should be calculate for (example: --instance='name').
--outputSet the output for each instances (example: --output='Container %{instance} value is %{label}').
--multiple-outputSet the global output in case everything is fine for multiple instances (example: --multiple-output='Containers are OK').
--warning-statusDefine the conditions to match for the status to be WARNING (default: ''). Can use special variables like %{instance} and any other labels you set through --query and --query-range options.
--critical-statusDefine the conditions to match for the status to be CRITICAL (default: ''). Can use special variables like %{instance} and any other labels you set through --query and --query-range options.
--timeframeSet timeframe in seconds (i.e. 3600 to check last hour) (required for --query-range queries, Default: '900').
--stepSet the step of the metric query (examples: '30s', '1m', '15m', '1h') (required for --query-range queries, Default: '1m').
--aggregationSet the aggregation on metric values (can be: 'average', 'min', 'max', 'sum') (required for --query-range queries, Default: 'average').

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_prometheus_api.pl \
	--plugin=cloud::prometheus::restapi::plugin \
	--mode=target-status \
	--help