Amazon Direct Connect
Contenu du Pack​
Modèles​
Le connecteur de supervision Centreon Amazon Direct Connect apporte un modèle d'hôte :
- Cloud-Aws-Directconnect-custom-custom
Il apporte les modèles de service suivants :
Alias | Modèle de service | Description | Défaut | Découverte |
---|---|---|---|---|
Virtual-Interfaces | Cloud-Aws-Directconnect-Virtual-Interfaces-Api | Contrôle les interfaces virtuelles | X | X |
Connections | Cloud-Aws-Directconnect-Connections-Api | Contrôle les connexions | X |
Les services par Défaut sont créés automatiquement lorsque le modèle d'hôte est appliqué.
Les modèles de service avec le champ "Découverte" sont liés à une règle de découverte automatique de service.
Règles de découverte​
Ce pack propose une règle de découverte d'hôtes permettant de découvrir automatiquement des ressources Amazon Direct Connect.
Vous trouverez plus d'informations sur la découverte d'Hôtes et son fonctionnement sur la documentation du module : Découverte des hôtes.
Métriques & statuts collectés​
- Connections
- Virtual-Interfaces
Métrique | Unité |
---|---|
connection state | |
connection_name#connection.egress.bitspersecond | bps |
connection_name#connection.ingress.bitspersecond | bps |
connection_name#connection.egress.packets.persecond | /s |
connection_name#connection.ingress.packets.persecond | /s |
connection_name#connection.outbound.light.level.dbm | dBm |
connection_name#connection.inbound.light.level.dbm | dBm |
Métrique | Unité |
---|---|
virtual interface state | |
connection_name~virtual_interface_name#virtual_interface.egress.bitspersecond | bps |
connection_name~virtual_interface_name#virtual_interface.ingress.bitspersecond | bps |
connection_name~virtual_interface_name#virtual_interface.egress.packets.persecond | /s |
connection_name~virtual_interface_name#virtual_interface.ingress.packets.persecond | /s |
Prérequis​
Privilèges AWS​
Voici la liste des droits nécessaires au travers des access/secret key utilisées pour pouvoir utiliser le monitoring AWS/EC2 :
AWS Privilege | Description |
---|---|
directconnect:describe-connections | Liste l'ensemble des connexions. |
directconnect:describe-virtual-interfaces | Liste l'ensemble des interfaces virtuelles |
cloudwatch:getMetricStatistics | Récupère les métriques Cloudwatch du namespace AWS/DX. |
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
Installation​
Pack de supervision​
Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack 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 paquet associé à sa distribution :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- CentOS 7
- Debian 11 & 12
dnf install centreon-pack-cloud-aws-directconnect
dnf install centreon-pack-cloud-aws-directconnect
yum install centreon-pack-cloud-aws-directconnect
apt install centreon-pack-cloud-aws-directconnect
Quel que soit le type de la licence (online ou offline), installez le Pack Amazon Direct Connect 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 pack. 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
- CentOS 7
- Debian 11 & 12
dnf install centreon-plugin-Cloud-Aws-Directconnect-Api
dnf install centreon-plugin-Cloud-Aws-Directconnect-Api
yum install centreon-plugin-Cloud-Aws-Directconnect-Api
apt install centreon-plugin-cloud-aws-directconnect-api
Configuration​
Hôte​
- 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-Directconnect-custom-custom.
- Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
Obligatoire | Macro | Description | Défaut |
---|---|---|---|
AWSACCESSKEY | Set AWS access key | ||
AWSASSUMEROLE | Set arn of the role to be assumed | ||
AWSCUSTOMMODE | Choose a custom mode | awscli | |
AWSREGION | Set the region name | ||
AWSSECRETKEY | Set AWS secret key | ||
CONNECTIONID | Connection id | ||
EXTRAOPTIONS | Any extra option you may want to add to every command line (eg. a --verbose flag) | ||
PROXYURL | Proxy URL if any |
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
) :
/usr/lib/centreon/plugins/centreon_aws_directconnect_api.pl \
--plugin=cloud::aws::directconnect::plugin \
--mode=connections \
--custommode=awscli \
--aws-secret-key='*******************' \
--aws-access-key='**********' \
--region='eu-west-1' \
--proxyurl='http://myproxy.mycompany.org:8080'
--statistic=average \
--timeframe='600' \
--period='60' \
--verbose
La commande devrait retourner un message de sortie similaire à :
OK: connection 'Centreon-EqFA5-Connection-1-10Gbps' state: available [bandwidth: 10Gbps] - statistic 'Average' outbound data: 19.58 Mb/s, inbound data: 53.96 Mb/s, inbound light level: -1.48 dBm, outbound light level: -1.37 dBm, outbound packets data: 7318.25 /s, inbound packet data: 8787.87 /s | 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.egress.bitspersecond'=19579682.84bps;;;; 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.ingress.bitspersecond'=53962349.94bps;;;; 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.inbound.light.level.dbm'=-1.48dBm;;;; 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.outbound.light.level.dbm'=-1.37dBm;;;; 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.egress.packets.persecond'=7318.25/s;;;; 'Centreon-EqFA5-Connection-1-10Gbps~average#connection.ingress.packets.persecond'=8787.87/s;;;;
Checking connection 'Centreon-EqFA5-Connection-1-10Gbps'
state: available [bandwidth: 10Gbps]
statistic 'Average' outbound data: 19.58 Mb/s, inbound data: 53.96 Mb/s, inbound light level: -1.48 dBm, outbound light level: -1.37 dBm, outbound packets data: 7318.25 /s, inbound packet data: 8787.87 /s
Custom modes disponibles​
Tous les custom modes disponibles peuvent être affichés en ajoutant le paramètre
--list-custommode
à la commande :
/usr/lib/centreon/plugins/centreon_aws_directconnect_api.pl \
--plugin=cloud::aws::directconnect::plugin \
--list-custommode
Le plugin apporte les custom modes suivants :
- paws
- awscli
Modes disponibles​
Tous les modes disponibles peuvent être affichés en ajoutant le paramètre
--list-mode
à la commande :
/usr/lib/centreon/plugins//centreon_aws_directconnect_api.pl \
--plugin=cloud::aws::directconnect::plugin \
--list-mode
Le plugin apporte les modes suivants :
Mode | Modèle |
---|---|
connections | Cloud-Aws-Directconnect-Connections-Api |
discovery | Used for host discovery |
list-connections | Not used in this Plugin Pack |
list-virtual-interfaces | Used for service discovery |
virtual-interfaces | Cloud-Aws-Directconnect-Virtual-Interfaces-Api |
Options complémentaires​
Options globales​
Les options globales aux modes sont listées ci-dessus :
Option | Description | Type |
---|---|---|
--mode | Choose a mode. | Global |
--dyn-mode | Specify a mode with the path (separated by '::'). | Global |
--list-mode | List available modes. | Global |
--mode-version | Check minimal version of mode. If not, unknown error. | Global |
--version | Display plugin version. | Global |
--custommode | Choose a custom mode. | Global |
--list-custommode | List available custom modes. | Global |
--multiple | Multiple custom mode objects (required by some specific modes) | Global |
--pass-manager | Use a password manager. | Global |
--verbose | Display long output. | Output |
--debug | Display also debug messages. | Output |
--filter-perfdata | Filter perfdata that match the regexp. | Output |
--filter-perfdata-adv | Advanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' | Output |
--explode-perfdata-max | Put max perfdata (if it exist) in a specific perfdata (without values: same with '_max' suffix) (Multiple options) | Output |
--change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --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() | Output |
--extend-perfdata-group | Extend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target[,[newuom],[m in],[max]] 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(traf fic_(in|out)_$1)' | Output |
--change-short-output --change-long-output | Change short/long output display: --change-short-output=pattern~replace~modifier | Output |
--change-exit | Change exit code: --change-exit=unknown=critical | Output |
--range-perfdata | Change perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display. | Output |
--filter-uom | Filter UOM that match the regexp. | Output |
--opt-exit | Optional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown). | Output |
--output-ignore-perfdata | Remove perfdata from output. | Output |
--output-ignore-label | Remove label status from output. | Output |
--output-xml | Display output in XML format. | Output |
--output-json | Display output in JSON format. | Output |
--output-openmetrics | Display metrics in OpenMetrics format. | Output |
--output-file | Write output in file (can be used with json and xml options) | Output |
--disco-format | Display discovery arguments (if the mode manages it). | Output |
--disco-show | Display discovery values (if the mode manages it). | Output |
--float-precision | Set the float precision for thresholds (Default: 8). | Output |
--source-encoding | Set encoding of monitoring sources (In some case. Default: 'UTF-8'). | Output |
Options des custom modes​
Les options spécifiques aux modes custom sont listées ci-dessus :
- awscli
- paws
Option | Description | Type |
---|---|---|
--aws-secret-key | Set AWS secret key. | Awscli |
--aws-access-key | Set AWS access key. | Awscli |
--aws-session-token | Set AWS session token. | Awscli |
--aws-role-arn | Set arn of the role to be assumed. | Awscli |
--aws-profile | Set AWS profile. | Awscli |
--endpoint-url | Override AWS service endpoint URL if necessary. | Awscli |
--region | Set the region name (Required). | Awscli |
--period | Set period in seconds. | Awscli |
--timeframe | Set timeframe in seconds. | Awscli |
--statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | Awscli |
--zeroed | Set metrics value to 0 if none. Usefull when CloudWatch does not return value when not defined. | Awscli |
--timeout | Set timeout in seconds (Default: 50). | Awscli |
--sudo | Use 'sudo' to execute the command. | Awscli |
--command | Command to get information (Default: 'aws'). Can be changed if you have output in a file. | Awscli |
--command-path | Command path (Default: none). | Awscli |
--command-options | Command options (Default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. | Awscli |
--proxyurl | Proxy URL if any | Awscli |
--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. Will be enhanced someday. Debug will only display CLI instead of evreything. | Awscli |
Option | Description | Type |
---|---|---|
--aws-secret-key | Set AWS secret key. | Paws |
--aws-access-key | Set AWS access key. | Paws |
--aws-session-token | Set AWS session token. | Paws |
--aws-role-arn | Set arn of the role to be assumed. | Paws |
--region | Set the region name (Required). | Paws |
--period | Set period in seconds. | Paws |
--timeframe | Set timeframe in seconds. | Paws |
--statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | Paws |
--zeroed | Set metrics value to 0 if none. Usefull when CloudWatch does not return value when not defined. | Paws |
--proxyurl | Proxy URL if any | Paws |
Options des modes​
Les options spécifiques aux modes sont listées ci-dessus :
- Connections
- Virtual-Interfaces
Option | Description | Type |
---|---|---|
--critical-connection-egress | ='10Mb' --verbose See 'https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing\_metrics\_wit h_cloudwatch.html' for more informations. Default statistic: 'average' / All satistics are valid. | Mode |
--filter-connection-id | Filter connection id (can be a regexp). | Mode |
--filter-metric | Filter metrics (Can be: 'ConnectionBpsEgress', 'ConnectionBpsIngress', 'ConnectionPpsEgress', 'ConnectionPpsIngress', 'ConnectionLightLevelTx', 'ConnectionLightLevelRx') (Can be a regexp). | Mode |
--warning-status | Set warning threshold for status. Can used special variables like: %{state}, %{bandwidth}, %{connectionName} | Mode |
--critical-status | Set critical threshold for status. Can used special variables like: %{state}, %{bandwidth}, %{connectionName} | Mode |
--warning- --critical- | Thresholds. Can be 'connection-egress', 'connection-ingress', 'connection-packets-egress', 'connection-packets-ingress', 'connection-ligh-level-outbound', 'connection-ligh-level-inbound. | Mode |
Option | Description | Type |
---|---|---|
--critical-virtual-interface-egress | ='10Mb' --verbose See 'https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing\_metrics\_wit h_cloudwatch.html' for more informations. Default statistic: 'average' / All satistics are valid. | Mode |
--filter-connection-id | Filter connection id (can be a regexp). | Mode |
--filter-virtual-interface-id | Filter virtual interface id (can be a regexp). | Mode |
--filter-metric | Filter metrics (Can be: 'VirtualInterfaceBpsEgress', 'VirtualInterfaceBpsIngress', 'VirtualInterfacePpsEgress', 'VirtualInterfacePpsIngress') (Can be a regexp). | Mode |
--warning-status | Set warning threshold for status. Can used special variables like: %{state}, %{vlan}, %{type}, %{virtualInterfaceId} | Mode |
--critical-status | Set critical threshold for status. Can used special variables like: %{state}, %{vlan}, %{type}, %{virtualInterfaceId} | Mode |
--warning- --critical- | Thresholds. Can be 'virtual-interface-egress', 'virtual-interface-ingress', 'virtual-interface-packets-egress', 'virtual-interface-packets-ingress'. | Mode |
Pour un mode, la liste de toutes les options complémentaires et leur signification peut être
affichée en ajoutant le paramètre --help
à la commande :
/usr/lib/centreon/plugins/centreon_aws_directconnect_api.pl \
--plugin=cloud::aws::directconnect::plugin \
--mode=connections \
--help
Diagnostic des erreurs communes​
Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.