AWS ELB
Dépendances du connecteur de supervision
Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur AWS ELB depuis la page Configuration > Gestionnaire de connecteurs de supervision :
Contenu du pack
Modèles
Le connecteur de supervision AWS ELB apporte 4 modèles d'hôte :
- Cloud-Aws-Elb-Application-LoadBalancer-custom
- Cloud-Aws-Elb-AvailabilityZone-custom
- Cloud-Aws-Elb-LoadBalancer-custom
- Cloud-Aws-Elb-Network-LoadBalancer-custom
Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :
- Cloud-Aws-Elb-Application-LoadBalancer-custom
- Cloud-Aws-Elb-AvailabilityZone-custom
- Cloud-Aws-Elb-LoadBalancer-custom
- Cloud-Aws-Elb-Network-LoadBalancer-custom
- Non rattachés à un modèle d'hôte
Alias | Modèle de service | Description | Découverte |
---|---|---|---|
Elb-Connections | Cloud-Aws-Elb-Application-Connections-Api-custom | Contrôle les statistiques de connexion | |
Elb-Http-Codes | Cloud-Aws-Elb-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Http-Codes | Cloud-Aws-Elb-Application-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Targets-Health | Cloud-Aws-Elb-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Application-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Network-Targets-Health-Api-custom | Contrôle la santé des instances cibles | X |
Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Aws-Elb-Application-LoadBalancer-custom est utilisé.
Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.
Alias | Modèle de service | Description | Découverte |
---|---|---|---|
Elb-Http-Codes | Cloud-Aws-Elb-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Http-Codes | Cloud-Aws-Elb-Application-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Performances | Cloud-Aws-Elb-Performances-Api-custom | Contrôle les performances | |
Elb-Queues | Cloud-Aws-Elb-Queues-Api-custom | Contrôle la file d'attente | |
Elb-Targets-Health | Cloud-Aws-Elb-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Application-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Network-Targets-Health-Api-custom | Contrôle la santé des instances cibles | X |
Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Aws-Elb-AvailabilityZone-custom est utilisé.
Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.
Alias | Modèle de service | Description | Découverte |
---|---|---|---|
Elb-Http-Codes | Cloud-Aws-Elb-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Http-Codes | Cloud-Aws-Elb-Application-Http-Codes-Api-custom | Contrôle le nombre de codes retour HTTP | |
Elb-Performances | Cloud-Aws-Elb-Performances-Api-custom | Contrôle les performances | |
Elb-Queues | Cloud-Aws-Elb-Queues-Api-custom | Contrôle la file d'attente | |
Elb-Targets-Health | Cloud-Aws-Elb-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Application-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Network-Targets-Health-Api-custom | Contrôle la santé des instances cibles | X |
Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Aws-Elb-LoadBalancer-custom est utilisé.
Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.
Ce modèle d'hôte n'a pas de modèle de service associé.
Alias | Modèle de service | Description | Découverte |
---|---|---|---|
Elb-Targets-Health | Cloud-Aws-Elb-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Application-Targets-Health-Api-custom | Contrôle la santé des instances cibles | |
Elb-Targets-Health | Cloud-Aws-Elb-Network-Targets-Health-Api-custom | Contrôle la santé des instances cibles | 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 d'hôtes
Nom de la règle | Description |
---|---|
Amazon AWS ELB (Classic) | Découvre les instances Amazon AWS ELB |
Amazon AWS ELB (Application) | Découvre les instances Amazon AWS Application ELB |
Amazon AWS ELB (Network) | Découvre les instances Amazon AWS Network ELB |
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ègle | Description |
---|---|
Cloud-Aws-Elb-Network-Targets-Health | Découvre les cibles et contrôle leur état de santé |
Cloud-Aws-Elb-Network-Targets-Health-Per-AZ | Découvre les cibles et contrôle leur état de santé |
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.
- Elb-Connections
- Elb-Http-Codes*
- Elb-Performances
- Elb-Queues
- Elb-Targets-Health*
Nom | Unité |
---|---|
elb.connection.active.count | count |
elb.connection.new.count | count |
elb.rejected.new.count | count |
elb.target.connection.error.count | count |
Nom | Unité |
---|---|
elb.httpcode.target.2xx.count | count |
elb.httpcode.target.3xx.count | count |
elb.httpcode.target.4xx.count | count |
elb.httpcode.target.5xx.count | count |
elb.httpcode.elb.3xx.count | count |
elb.httpcode.elb.4xx.count | count |
elb.http.redirect.count | count |
Concerne les modèles de service suivants : Elb-Http-Codes, Elb-Http-Codes
Nom | Unité |
---|---|
elb.requestcount.count | count |
elb.latency.seconds | s |
Nom | Unité |
---|---|
elb.spillovercount.count | count |
elb.surgequeuelength.count | count |
Nom | Unité |
---|---|
elb.healthyhostcount.count | count |
elb.unhealthyhostcount.count | count |
Concerne les modèles de service suivants : Elb-Targets-Health, Elb-Targets-Health, Elb-Targets-Health
Prérequis
Privilèges AWS
Configurez un compte de service (via une combinaison d'access key et de secret key) et affectez-lui les privilèges suivants :
- cloudwatch:getMetricStatistics
- elb:DescribeLoadBalancers
Dépendances du Plugin
Afin de récupérer les informations nécessaires via les APIs AWS, il est possible d'utiliser soit le binaire awscli fourni par Amazon, soit le SDK Perl paws. Le SDK est recommandé car plus performant.
Attention, il n'est pas possible d'utiliser paws si la connexion s'effectue au travers d'un proxy.
- perl-Paws-installation
- aws-cli-installation
yum install perl-Paws
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
Installer le connecteur de supervision
Pack
- 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-cloud-aws-elb
dnf install centreon-pack-cloud-aws-elb
apt install centreon-pack-cloud-aws-elb
yum install centreon-pack-cloud-aws-elb
- Quel que soit le type de la licence (online ou offline), installez le connecteur AWS ELB 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Cloud-Aws-Elb-Api
dnf install centreon-plugin-Cloud-Aws-Elb-Api
apt install centreon-plugin-cloud-aws-elb-api
yum install centreon-plugin-Cloud-Aws-Elb-Api
Utiliser le connecteur de supervision
Utiliser un modèle d'hôte issu du connecteur
- Cloud-Aws-Elb-Application-LoadBalancer-custom
- Cloud-Aws-Elb-AvailabilityZone-custom
- Cloud-Aws-Elb-LoadBalancer-custom
- Cloud-Aws-Elb-Network-LoadBalancer-custom
- 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 Cloud-Aws-Elb-Application-LoadBalancer-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 |
---|---|---|---|
AWSACCESSKEY | Set AWS access key | X | |
AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | ||
AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | |
AWSINSTANCENAME | Set the instance name (can be defined multiple times) | X | |
AWSINSTANCETYPE | Set the instance type (can be: 'loadbalancer', 'availabilityzone') | X | |
AWSREGION | Set the region name | X | |
AWSSECRETKEY | Set AWS secret key | X | |
PROXYURL | Proxy URL if any | ||
EXTRAOPTIONS | 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.
- 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 Cloud-Aws-Elb-AvailabilityZone-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 |
---|---|---|---|
AWSACCESSKEY | Set AWS access key | X | |
AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | ||
AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | |
AWSINSTANCENAME | Set the instance name (can be defined multiple times) | X | |
AWSINSTANCETYPE | Set the instance type (can be: 'loadbalancer', 'availabilityzone') | availabilityzone | X |
AWSREGION | Set the region name | X | |
AWSSECRETKEY | Set AWS secret key | X | |
PROXYURL | Proxy URL if any | ||
EXTRAOPTIONS | 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.
- 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 Cloud-Aws-Elb-LoadBalancer-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 |
---|---|---|---|
AWSACCESSKEY | Set AWS access key | X | |
AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | ||
AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | |
AWSINSTANCENAME | Set the instance name (can be defined multiple times) | X | |
AWSINSTANCETYPE | Set the instance type (can be: 'loadbalancer', 'availabilityzone') | loadbalancer | X |
AWSREGION | Set the region name | X | |
AWSSECRETKEY | Set AWS secret key | X | |
PROXYURL | Proxy URL if any | ||
EXTRAOPTIONS | 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.
- 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 Cloud-Aws-Elb-Network-LoadBalancer-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 |
---|---|---|---|
AWSACCESSKEY | Set AWS access key | X | |
AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | |
AWSINSTANCENAME | Set the instance name (can be defined multiple times) | X | |
AWSREGION | Set the region name | X | |
AWSSECRETKEY | Set AWS secret key | X | |
PROXYURL | Proxy URL if any | ||
EXTRAOPTIONS | 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.
- Elb-Connections
- Elb-Http-Codes
- Elb-Performances
- Elb-Queues
- Elb-Targets-Health
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
STATISTIC | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum') | sum | |
TIMEFRAME | Set timeframe in seconds | 900 | |
PERIOD | Set period in seconds | 60 | |
FILTERMETRIC | Filter metrics (can be: ActiveConnectionCount', 'NewConnectionCount', 'RejectedConnectionCount', 'TargetConnectionErrorCount') (can be a regexp) | ||
WARNINGCONNECTIONACTIVE | Threshold | ||
CRITICALCONNECTIONACTIVE | Threshold | ||
WARNINGCONNECTIONNEW | Threshold | ||
CRITICALCONNECTIONNEW | Threshold | ||
WARNINGCONNECTIONREJECTED | Threshold | ||
CRITICALCONNECTIONREJECTED | Threshold | ||
WARNINGTARGETCONNECTIONERROR | Threshold | ||
CRITICALTARGETCONNECTIONERROR | Threshold | ||
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 |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
STATISTIC | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum') | sum | |
TIMEFRAME | Set timeframe in seconds | 900 | |
PERIOD | Set period in seconds | 60 | |
FILTERMETRIC | Filter metrics (can be: 'HTTPCode_Target_2XX_Count', 'HTTPCode_Target_3XX_Count', 'HTTPCode_Target_4XX_Count', 'HTTPCode_Target_5XX_Count', 'HTTPCode_ELB_3XX_Count', 'HTTPCode_ELB_4XX_Count', 'HTTP_Redirect_Count') (can be a regexp) | ||
WARNINGHTTPCODEELB3XX | Threshold | ||
CRITICALHTTPCODEELB3XX | Threshold | ||
WARNINGHTTPCODEELB4XX | Threshold | ||
CRITICALHTTPCODEELB4XX | Threshold | ||
WARNINGHTTPCODETARGET2XX | Threshold | ||
CRITICALHTTPCODETARGET2XX | Threshold | ||
WARNINGHTTPCODETARGET3XX | Threshold | ||
CRITICALHTTPCODETARGET3XX | Threshold | ||
WARNINGHTTPCODETARGET4XX | Threshold | ||
CRITICALHTTPCODETARGET4XX | Threshold | ||
WARNINGHTTPCODETARGET5XX | Threshold | ||
CRITICALHTTPCODETARGET5XX | Threshold | ||
WARNINGHTTPREDIRECT | Threshold | ||
CRITICALHTTPREDIRECT | Threshold | ||
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 |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
STATISTIC | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum') | sum | |
TIMEFRAME | Set timeframe in seconds | 900 | |
PERIOD | Set period in seconds | 60 | |
FILTERMETRIC | Filter metrics (can be: 'RequestCount', 'Latency') (can be a regexp) | ||
WARNINGLATENCY | Threshold | ||
CRITICALLATENCY | Threshold | ||
WARNINGREQUESTCOUNT | Threshold | ||
CRITICALREQUESTCOUNT | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. | --statistic='average' --verbose |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
STATISTIC | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum') | sum | |
TIMEFRAME | Set timeframe in seconds | 900 | |
PERIOD | Set period in seconds | 60 | |
FILTERMETRIC | Filter metrics (can be: 'SpilloverCount', 'SurgeQueueLength') (can be a regexp) | ||
WARNINGSPILLOVERCOUNT | Threshold | ||
CRITICALSPILLOVERCOUNT | Threshold | ||
WARNINGSURGEQUEUELENGTH | Threshold | ||
CRITICALSURGEQUEUELENGTH | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. | --statistic='maximum' --verbose |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
STATISTIC | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum') | sum | |
TIMEFRAME | Set timeframe in seconds | 900 | |
PERIOD | Set period in seconds | 60 | |
AVAILABILITYZONE | Add Availability Zone dimension | ||
TARGETGROUP | Add target group dimension | ||
FILTERMETRIC | Filter metrics (can be: 'HealthyHostCount', 'UnHealthyHostCount') (can be a regexp) | ||
WARNINGHEALTHYHOSTCOUNT | Threshold | ||
CRITICALHEALTHYHOSTCOUNT | Threshold | ||
WARNINGUNHEALTHYHOSTCOUNT | Threshold | ||
CRITICALUNHEALTHYHOSTCOUNT | Threshold | ||
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 instance AWS en utilisant une commande
telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :
/usr/lib/centreon/plugins/centreon_aws_elb_network_api.pl \
--plugin=cloud::aws::elb::network::plugin \
--mode=targets-health \
--custommode='awscli' \
--aws-secret-key='XXXX' \
--aws-access-key='XXXX' \
--aws-role-arn='' \
--region='us-east-1' \
--name='' \
--availability-zone='' \
--target-group='' \
--proxyurl='' \
--filter-metric='' \
--statistic='sum' \
--timeframe='900' \
--period='60' \
--warning-unhealthyhostcount='' \
--critical-unhealthyhostcount='' \
--warning-healthyhostcount='' \
--critical-healthyhostcount='' \
--verbose
La commande devrait retourner un message de sortie similaire à :
OK: Healthy Hosts Unhealthy Hosts | 'elb.healthyhostcount.count'=22554;;;; 'elb.unhealthyhostcount.count'=34541;;;;
Diagnostic des erreurs communes
Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.
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_aws_elb_network_api.pl \
--plugin=cloud::aws::elb::network::plugin \
--list-mode
Le plugin apporte les modes suivants :
Mode | Modèle de service associé |
---|---|
connections [code] | Cloud-Aws-Elb-Application-Connections-Api-custom |
discovery [code] | Used for host discovery |
http-codes [code] | Cloud-Aws-Elb-Http-Codes-Api-custom Cloud-Aws-Elb-Application-Http-Codes-Api-custom |
list-health-target-groups [code] | Used for service discovery |
performances [code] | Cloud-Aws-Elb-Performances-Api-custom |
queues [code] | Cloud-Aws-Elb-Queues-Api-custom |
targets-health [code] | Cloud-Aws-Elb-Targets-Health-Api-custom Cloud-Aws-Elb-Application-Targets-Health-Api-custom Cloud-Aws-Elb-Network-Targets-Health-Api-custom |
Options disponibles
Options génériques
Les options génériques sont listées ci-dessous :
Option | Description |
---|---|
--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[,[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-perfdata | Change 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 | Change 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-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,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-output | Modify 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-output | Modify 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-output | Modify 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-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. |
--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). E.g.: --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 |
--aws-secret-key | Set AWS secret key. |
--aws-access-key | Set AWS access key. |
--aws-session-token | Set AWS session token. |
--aws-role-arn | Set Amazon Resource Name of the role to be assumed. |
--region | Set the region name (required). |
--period | Set period in seconds. |
--timeframe | Set timeframe in seconds. |
--statistic | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). |
--zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. |
--proxyurl | Proxy URL if any |
--aws-profile | Set AWS profile. |
--endpoint-url | Override AWS service endpoint URL if necessary. |
--timeout | Set timeout in seconds (default: 50). |
--sudo | Use 'sudo' to execute the command. |
--command | Command to get information (default: 'aws'). Can be changed if you have output in a file. |
--command-path | Command path (default: none). |
--command-options | Command options (default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. |
--skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third party. Note that it strips all stderr from the command result. Debug will only display CLI instead of everything. |
Options des modes
Les options disponibles pour chaque modèle de services sont listées ci-dessous :
- Elb-Connections
- Elb-Http-Codes*
- Elb-Performances
- Elb-Queues
- Elb-Targets-Health*
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--name | Set the instance name (required) (can be defined multiple times). |
--availability-zone | Add Availability Zone dimension. |
--target-group | Add target group dimension. |
--filter-metric | Filter metrics (can be: ActiveConnectionCount', 'NewConnectionCount', 'RejectedConnectionCount', 'TargetConnectionErrorCount') (can be a regexp). |
--warning- --critical- | Warning thresholds (can be: 'connection-active', 'connection-new', 'connection-rejected', 'target-connection-error'). |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--name | Set the instance name (required) (can be defined multiple times). |
--availability-zone | Add Availability Zone dimension. |
--target-group | Add target group dimension. |
--filter-metric | Filter metrics (can be: 'HTTPCode_Target_2XX_Count', 'HTTPCode_Target_3XX_Count', 'HTTPCode_Target_4XX_Count', 'HTTPCode_Target_5XX_Count', 'HTTPCode_ELB_3XX_Count', 'HTTPCode_ELB_4XX_Count', 'HTTP_Redirect_Count') (can be a regexp). |
--warning- --critical- | Warning thresholds (can be: 'httpcode-target-2xx', 'httpcode-target-3xx', 'httpcode-target-4xx', 'httpcode-target-5xx', 'httpcode-elb-3xx', 'httpcode-elb-4xx', 'http-redirect') |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--type | Set the instance type (required) (can be: 'loadbalancer', 'availabilityzone'). |
--name | Set the instance name (required) (can be defined multiple times). |
--availability-zone | Add Availability Zone dimension (only with --type='loadbalancer'). |
--filter-metric | Filter metrics (can be: 'RequestCount', 'Latency') (can be a regexp). |
--warning- --critical- | Warning thresholds (can be: 'requestcount', 'latency'). |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--type | Set the instance type (required) (can be: 'loadbalancer', 'availabilityzone'). |
--name | Set the instance name (required) (can be defined multiple times). |
--availability-zone | Add Availability Zone dimension (only with --type='loadbalancer'). |
--filter-metric | Filter metrics (can be: 'SpilloverCount', 'SurgeQueueLength') (can be a regexp). |
--warning- --critical- | Warning thresholds (can be: 'spillovercount', 'surgequeuelength'). |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$' |
--name | Set the instance name (required) (can be defined multiple times). |
--availability-zone | Add Availability Zone dimension. |
--target-group | Add target group dimension. |
--filter-metric | Filter metrics (can be: 'HealthyHostCount', 'UnHealthyHostCount') (can be a regexp). |
--warning- --critical- | Warning thresholds (can be: 'healthyhostcount', 'unhealthyhostcount'). |
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_aws_elb_network_api.pl \
--plugin=cloud::aws::elb::network::plugin \
--mode=targets-health \
--help