AWS Transit Gateway

Dépendances du connecteur de supervision

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur AWS Transit Gateway depuis la page Configuration > Connecteurs > Connecteurs de supervision :

• Base Pack

Contenu du pack

Modèles

Le connecteur de supervision AWS Transit Gateway apporte un modèle d'hôte :

• Cloud-Aws-Transitgateway-custom

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

Cloud-Aws-Transitgateway-custom

Alias	Modèle de service	Description	Découverte
Gateways-Traffic-Global	Cloud-Aws-Transitgateway-Gateways-Traffic-Global-Api-custom	Contrôle l'état et le trafic d'une Transit Gateway AWS	X

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Aws-Transitgateway-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.

Règles de découverte

Découverte de services

Nom de la règle	Description
Cloud-Aws-Transitgateways-Gateways	Découvre une Transit Gateway AWS et supervise son état et son trafic

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.

Gateways-Traffic-Global

Nom	Unité
gateway.traffic.in.bytes	B
gateway.traffic.in.bytespersecond	B/s
gateway.traffic.out.bytes	B
gateway.traffic.out.bytespersecond	B/s
gateway.packets.in.count	count
gateway.packets.in.countpersecond	/s
gateway.packets.out.count	count
gateway.packets.out.countpersecond	/s
gateway.packets.blackholedropped.count	count
gateway.packets.blackholedropped.countpersecond	/s
gateway.packets.noroutedropped.count	count
gateway.packets.noroutedropped.countpersecond	/s

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

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

yum install perl-Paws

aws-cli-installation

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

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 :

Alma / RHEL / Oracle Linux 8

dnf install centreon-pack-cloud-aws-transitgateway

Alma / RHEL / Oracle Linux 9

dnf install centreon-pack-cloud-aws-transitgateway

Debian 11 & 12

apt install centreon-pack-cloud-aws-transitgateway

CentOS 7

yum install centreon-pack-cloud-aws-transitgateway

2. Quel que soit le type de la licence (online ou offline), installez le connecteur AWS Transit Gateway 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

dnf install centreon-plugin-Cloud-Aws-Transitgateway-Api

Alma / RHEL / Oracle Linux 9

dnf install centreon-plugin-Cloud-Aws-Transitgateway-Api

Debian 11 & 12

apt install centreon-plugin-cloud-aws-transitgateway-api

CentOS 7

yum install centreon-plugin-Cloud-Aws-Transitgateway-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-Aws-Transitgateway-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.

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		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.

5. 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.

Gateways-Traffic-Global

Macro	Description	Valeur par défaut	Obligatoire
FILTERGATEWAY	Filter on a specific TransitGateway ID. This filter is based on the "TransitGatewayId" attribute of the gateway	.*
FILTERMETRIC	Filter on a specific metric. Can be: BytesIn, BytesOut, PacketsIn, PacketsOut, PacketDropCountBlackhole, PacketDropCountNoRoute
TIMEFRAME	Set timeframe in seconds
PERIOD	Set period in seconds
WARNINGBYTESIN	Threshold
CRITICALBYTESIN	Threshold
WARNINGBYTESOUT	Threshold
CRITICALBYTESOUT	Threshold
WARNINGPACKETSDROPBLACKHOLE	Threshold
CRITICALPACKETSDROPBLACKHOLE	Threshold
WARNINGPACKETSDROPNOROUTE	Threshold
CRITICALPACKETSDROPNOROUTE	Threshold
WARNINGPACKETSIN	Threshold
CRITICALPACKETSIN	Threshold
WARNINGPACKETSOUT	Threshold
CRITICALPACKETSOUT	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

3. 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_transitgateway_api.pl \
	--plugin=cloud::aws::transitgateway::plugin \
	--mode=traffic \
	--custommode='awscli' \
	--aws-secret-key='XXXX' \
	--aws-access-key='XXXX' \
	--aws-role-arn='' \
	--region='us-east-1' \
	--proxyurl=''  \
	--filter-gateway='.*' \
	--filter-metric='' \
	--timeframe='' \
	--period='' \
	--warning-bytes-in='' \
	--critical-bytes-in='' \
	--warning-bytes-out='' \
	--critical-bytes-out='' \
	--warning-packets-in='' \
	--critical-packets-in='' \
	--warning-packets-drop-blackhole='' \
	--critical-packets-drop-blackhole='' \
	--warning-packets-out='' \
	--critical-packets-out='' \
	--warning-packets-drop-noroute='' \
	--critical-packets-drop-noroute='' \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: 'tgw-01234567890abcd' Statistic 'Average' Metrics Bytes In: 2.89 MB, Bytes Out: 2.78 MB, Packets Received (In): 3844.04 ,
Packets Drop Blackhole: 0.00 , Packets Sent (Out): 3677.79 , Packets Drop No Route: 0.01  |
'tgw-01234567890abcd~average#gateway.traffic.in.bytes'=3026151.39B;;;; 'tgw-01234567890abcd~average#gateway.traffic.out.bytes'=2920220.01B;;;;
'tgw-01234567890abcd~average#gateway.packets.in.count'=3844.04;;;; 'tgw-01234567890abcd~average#gateway.packets.blackholedropped.count'=0.00;;;;
'tgw-01234567890abcd~average#gateway.packets.out.count'=3677.79;;;; 'tgw-01234567890abcd~average#gateway.packets.noroutedropped.count'=0.01;;;;

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_transitgateway_api.pl \
	--plugin=cloud::aws::transitgateway::plugin \
	--list-mode

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
list-gateways [code]	Used for service discovery
region [code]	Not used in this Monitoring Connector
traffic [code]	Cloud-Aws-Transitgateway-Gateways-Traffic-Global-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=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-output	Modify 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-output	Modify 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-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 :

Gateways-Traffic-Global

Option	Description
--filter-gateway	Filter on a specific TransitGateway ID. This filter is based on the "TransitGatewayId" attribute of the gateway.
--filter-metric	Filter on a specific metric. Can be: BytesIn, BytesOut, PacketsIn, PacketsOut, PacketDropCountBlackhole, PacketDropCountNoRoute
--warning-$metric$	Warning thresholds ($metric$ can be: 'bytes-in', 'bytes-out', 'packets-in', 'packets-out', 'packets-drop-blackhole', 'packets-drop-noroute').
--critical-$metric$	Critical thresholds ($metric$ can be: 'bytes-in', 'bytes-out', 'packets-in', 'packets-out', 'packets-drop-blackhole', 'packets-drop-noroute').

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_transitgateway_api.pl \
	--plugin=cloud::aws::transitgateway::plugin \
	--mode=traffic \
	--help