Aller au contenu principal

cAdvisor w/ Prometheus API

Dépendances du connecteur de supervision​

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

Contenu du pack​

Modèles​

Le connecteur de supervision cAdvisor w/ Prometheus API apporte 4 modèles d'hôte :

  • Cloud-Prometheus-cAdvisor-Api-custom : supervise depuis un seul hôte tous les conteneurs correspondant aux filtres de chaque service.
  • Cloud-Prometheus-cAdvisor-Api-Container-custom : supervise un conteneur exécuté hors de Kubernetes (Docker, Podman).
  • Cloud-Prometheus-cAdvisor-Api-Kubernetes-Container-custom : supervise un conteneur d'un pod Kubernetes.
  • Cloud-Prometheus-cAdvisor-Api-Pod-custom : supervise un pod Kubernetes dans son ensemble.

Les trois derniers modèles d'hôte contrôlent que leur pod ou leur conteneur est présent dans les métriques. Ils sont conçus pour être appliqués par la découverte d'hôtes.

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
Container-CpuCloud-Prometheus-cAdvisor-Cpu-Api-customContrôle l'utilisation CPU du conteneur
Container-LoadCloud-Prometheus-cAdvisor-Load-Api-customContrôle la charge du conteneur
Container-MemoryCloud-Prometheus-cAdvisor-Memory-Api-customContrôle la consommation mémoire du conteneur
Container-StorageCloud-Prometheus-cAdvisor-Storage-Api-customContrôle la consommation du stockage du conteneur
Container-Task-StateCloud-Prometheus-cAdvisor-Task-State-Api-customContrôle l'état des tâches du conteneur

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

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
Prometheus cAdvisorDécouvre les pods et les conteneurs (Kubernetes ou autonomes) à partir des métriques cAdvisor stockées dans Prometheus

La découverte liste les pods et les conteneurs à partir de la métrique container_last_seen, puis applique un modèle d'hôte selon le type de chaque ressource découverte :

Ressource découverteModèle d'hôteNom de l'hôte
Pod KubernetesCloud-Prometheus-cAdvisor-Api-Pod-customnamespace_pod
Conteneur d'un pod KubernetesCloud-Prometheus-cAdvisor-Api-Kubernetes-Container-customnamespace_pod_container
Conteneur exécuté hors de KubernetesCloud-Prometheus-cAdvisor-Api-Container-customcontainer

La découverte renseigne aussi les macros des hôtes : la connexion à Prometheus, ainsi que les filtres CONTAINER_FILTER, POD_FILTER et NAMESPACE_FILTER, qui sélectionnent le pod ou le conteneur de chaque hôte.

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte d'hôtes, notamment sur la façon de planifier l'exécution de la tâche de découverte pour ajouter les hôtes des nouveaux pods au fil de l'évolution de votre cluster Kubernetes.

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é
pod_container#container.cpu.utilization.percentage%
pod_container#container.cpu.throttled.percentage%

Concerne les modèles de service suivants : Cloud-Prometheus-cAdvisor-Cpu-Api-custom, Cloud-Prometheus-cAdvisor-Container-Cpu-Api-custom

Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.

L'instance de chaque métrique est dépend du type de ressource :

  • Conteneur dans un pod : nom du pod et du nom du conteneur (par exemple web-1_nginx ou web-1~nginx)
  • Pod : nom du pod
  • Conteneur exécuté hors de Kubernetes : nom du conteneur (par exemple haproxy).

Les métriques de stockage contiennent aussi le périphérique (par exemple web-1~nginx~/dev/vda1).

Prérequis​

Prometheus et cAdvisor​

Le connecteur interroge l'API d'un serveur Prometheus qui collecte les métriques cAdvisor, depuis l'une des sources suivantes :

  • Le cAdvisor intégré au kubelet (Kubernetes) : le point d'accès /metrics/cadvisor de chaque nœud, généralement collecté par le job kubelet du Prometheus Operator. Il exporte les métriques CPU et mémoire des pods et des conteneurs. Il n'exporte pas les métriques de charge (container_cpu_load_average_10s) et d'état des tâches (container_tasks_state), ni l'occupation disque des conteneurs containerd.
  • Un cAdvisor autonome : sur un hôte Docker ou Podman, ou déployé dans Kubernetes sous forme de DaemonSet. Il est nécessaire pour utiliser les services de charge, de stockage et d'état des tâches.

Les filtres par défaut utilisent les labels container, pod et namespace définis par le kubelet depuis Kubernetes 1.16 (OpenShift 4.3). Sur les plateformes plus anciennes, ces labels s'appellent container_name et pod_name : adaptez les filtres en conséquence, par exemple --container='container_name!~"|.*POD.*"' --pod='pod_name=~".*"'.

Un cAdvisor autonome déployé dans Kubernetes ne définit pas ces labels. Il expose uniquement les labels du moteur de conteneurs (par exemple container_label_io_kubernetes_pod_name). Dans ce cas, vous pouvez soit :

  • Adapter les filtres à ces noms de labels.
  • Configurer Prometheus pour copier ces labels vers container, pod et namespace (par exemple avec metric_relabel_configs).

Bonne pratique : nommer vos conteneurs​

cAdvisor identifie chaque conteneur par son nom. Par défaut, Docker attribue un nouveau nom aléatoire à chaque recréation de conteneur. Centreon crée alors de nouvelles métriques et un nouveau fichier RRD dans /var/lib/centreon/metrics, accumulant des données obsolètes.

Attribuez toujours un nom fixe à chaque conteneur supervisé :

# Ligne de commande
docker run -d --name mon-nginx nginx

# Docker Compose
services:
  web:
    image: nginx
    container_name: mon-nginx

Si vous utilisez Kubernetes, les pods d'un StatefulSet gardent un nom stable (mon-service-0, mon-service-1, etc.), tout comme les pods créés directement (kind: Pod). Les pods des autres contrôleurs (Deployment, DaemonSet, Job, CronJob, etc.) reçoivent un nouveau nom à chaque recréation : la découverte d'hôtes peut être configurée pour ajouter un nouvel hôte à chaque changement de nom, et supprimer l'ancien, mais les métriques collectées pour deux noms différents ne seront ni liées ni visibles ensemble.

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-cloud-prometheus-cadvisor-api
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur cAdvisor w/ Prometheus 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-Cloud-Prometheus-cAdvisor-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-cAdvisor-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
PROMETHEUSAPIHOSTNAMEPrometheus hostnameX
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.

Les modèles de service du modèle d'hôte Cloud-Prometheus-cAdvisor-Api-custom sélectionnent les conteneurs avec leurs propres macros CONTAINER et POD. Les valeurs par défaut de ces macros utilisent les noms de labels de Kubernetes 1.15 et antérieurs : avec Kubernetes 1.16 et ultérieurs, utilisez par exemple container!~"|.*POD.*" et pod=~".*" (voir les prérequis).

Les modèles de service des modèles d'hôte Cloud-Prometheus-cAdvisor-Api-Container-custom, Cloud-Prometheus-cAdvisor-Api-Kubernetes-Container-custom et Cloud-Prometheus-cAdvisor-Api-Pod-custom sélectionnent leur pod ou leur conteneur avec les macros CONTAINER_FILTER, POD_FILTER et NAMESPACE_FILTER de leur hôte.

Cloud-Prometheus-cAdvisor-Cpu-Api-custom

MacroDescriptionValeur par défautObligatoire
CONTAINERFilter on the container (must be a PromQL filter)container_name!~".POD."
PODFilter on the pod (must be a PromQL filter)pod_name=~".*"
WARNINGUSAGEWarning threshold on the CPU usage (%)80
CRITICALUSAGECritical threshold on the CPU usage (%)90
WARNINGTHROTTLEDWarning threshold on the CPU throttling (%)10
CRITICALTHROTTLEDCritical threshold on the CPU throttling (%)20
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose

Cloud-Prometheus-cAdvisor-Container-Cpu-Api-custom

MacroDescriptionValeur par défautObligatoire
WARNING_USAGEWarning threshold on the CPU usage (%)
CRITICAL_USAGECritical threshold on the CPU usage (%)
WARNING_THROTTLEDWarning threshold on the CPU throttling (%)
CRITICAL_THROTTLEDCritical threshold on the CPU throttling (%)
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_cadvisor_api.pl \
	--plugin=cloud::prometheus::exporters::cadvisor::plugin \
	--mode=memory \
	--hostname=10.0.0.1 \
	--url-path='/api/v1' \
	--port='9090' \
	--proto='http' \
	--container='container="nginx"' \
	--pod='pod="web-1"' \
	--extra-filter='namespace="default"' \
	--warning-usage='' \
	--critical-usage='' \
	--warning-working='' \
	--critical-working='' \
	--warning-cache='' \
	--critical-cache='' \
	--warning-rss='' \
	--critical-rss='' \
	--warning-swap='' \
	--critical-swap='' \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: Container 'nginx' [pod: web-1] Memory Usage: 50.00 MB (50.00% of 100.00 MB), Working: 40.00 MB (40.00% of 100.00 MB), Cache: 10.00 MB, Rss: 38.00 MB, Swap: 0.00 B | 'web-1~nginx#memory.used.bytes'=52428800B;;;0;104857600 'web-1~nginx#memory.working.bytes'=41943040B;;;0;104857600 'web-1~nginx#cache.usage.bytes'=10485760B;;;0; 'web-1~nginx#rss.usage.bytes'=39845888B;;;0; 'web-1~nginx#swap.usage.bytes'=0B;;;0;
Container 'nginx' [pod: web-1] Memory Usage: 50.00 MB (50.00% of 100.00 MB), Working: 40.00 MB (40.00% of 100.00 MB), Cache: 10.00 MB, Rss: 38.00 MB, Swap: 0.00 B

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_prometheus_cadvisor_api.pl \
	--plugin=cloud::prometheus::exporters::cadvisor::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
cpu [code]Cloud-Prometheus-cAdvisor-Cpu-Api-custom
Cloud-Prometheus-cAdvisor-Container-Cpu-Api-custom
Cloud-Prometheus-cAdvisor-Pod-Cpu-Api-custom
discovery [code]Utilisé pour la découverte d'hôtes
list-containers [code]Non utilisé dans ce connecteur de supervision
load [code]Cloud-Prometheus-cAdvisor-Load-Api-custom
Cloud-Prometheus-cAdvisor-Container-Load-Api-custom
Cloud-Prometheus-cAdvisor-Pod-Load-Api-custom
memory [code]Cloud-Prometheus-cAdvisor-Memory-Api-custom
Cloud-Prometheus-cAdvisor-Container-Memory-Api-custom
Cloud-Prometheus-cAdvisor-Pod-Memory-Api-custom
presence [code]Utilisé pour le contrôle de l'hôte de Cloud-Prometheus-cAdvisor-Api-Container-custom
Cloud-Prometheus-cAdvisor-Api-Kubernetes-Container-custom
Cloud-Prometheus-cAdvisor-Api-Pod-custom
storage [code]Cloud-Prometheus-cAdvisor-Storage-Api-custom
Cloud-Prometheus-cAdvisor-Container-Storage-Api-custom
Cloud-Prometheus-cAdvisor-Pod-Storage-Api-custom
task-state [code]Cloud-Prometheus-cAdvisor-Task-State-Api-custom
Cloud-Prometheus-cAdvisor-Container-Task-State-Api-custom
Cloud-Prometheus-cAdvisor-Pod-Task-State-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.
--show-passwordBy default, sensitive information in command lines is hidden in debug output and replaced with *** (however, debug logs may still display sensitive information). Using the --show-password option will display the passwords in plain text.
--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-measure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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()'
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-measure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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()'
--extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-measure>],[min],[max]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage used perfdata into free: --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()'
--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-measure>],[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-measure> (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: 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)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' 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=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' 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=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' 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_output) =~ /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'.
--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
--cpu-attributeSet the CPU attribute to match element (must be a PromQL filter, default: 'cpu="total"').
--containerFilter on a specific container (must be a PromQL filter, default: 'container!~"|.POD."').
--podFilter on a specific pod (must be a PromQL filter, default: 'pod=~"."'). The label filtered is the first word of the --container and --pod filters. The kubelet cAdvisor metrics label names depend on the platform version: Kubernetes < 1.14: container_name and pod_name only. Kubernetes 1.14 and 1.15: both container_name/pod_name and container/pod. Kubernetes >= 1.16: container and pod only. OpenShift: container_name and pod_name only up to 4.1 (Kubernetes 1.13), both label sets in 4.2 (Kubernetes 1.14), container and pod only from 4.3 (Kubernetes 1.16). Rancher: depends on the Kubernetes version of the managed cluster. Kubernetes 1.16 is available from Rancher 2.3.0 (experimental), generally available in 2.3.2 and the default in 2.3.3. On older platforms, use for example: --container='container_name!~"|.POD."' --pod='pod_name=~"."'
--namespaceFilter on a specific namespace (must be a PromQL filter, default: 'namespace=~".*"'). Two pods with the same name in different namespaces are reported separately, but with the same output and performance data names: filter on the namespace to tell them apart.
--warning-usageWarning threshold.
--warning-throttledWarning threshold.
--critical-usageCritical threshold.
--critical-throttledCritical threshold.
--extra-filterAdd a PromQL filter (can be defined multiple times). Example : --extra-filter='name=~".pretty."'
--metric-overloadOverload default metrics name (can be defined multiple times). Example : --metric-overload='metric,^my_metric_name$' Default : - throttled: ^container_cpu_cfs_throttled_seconds_total.* - usage: ^container_cpu_usage_seconds_total.*
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='throttled'

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_cadvisor_api.pl \
	--plugin=cloud::prometheus::exporters::cadvisor::plugin \
	--mode=memory \
	--help