Aller au contenu principal

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 :

AliasModèle de serviceDescriptionDéfautDécouverte
Virtual-InterfacesCloud-Aws-Directconnect-Virtual-Interfaces-ApiContrôle les interfaces virtuellesXX
ConnectionsCloud-Aws-Directconnect-Connections-ApiContrôle les connexionsX

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​

MétriqueUnité
connection state
connection_name#connection.egress.bitspersecondbps
connection_name#connection.ingress.bitspersecondbps
connection_name#connection.egress.packets.persecond/s
connection_name#connection.ingress.packets.persecond/s
connection_name#connection.outbound.light.level.dbmdBm
connection_name#connection.inbound.light.level.dbmdBm

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 PrivilegeDescription
directconnect:describe-connectionsListe l'ensemble des connexions.
directconnect:describe-virtual-interfacesListe l'ensemble des interfaces virtuelles
cloudwatch:getMetricStatisticsRé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.

yum install perl-Paws

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 :

dnf 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 :

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

Configuration​

Hôte​

  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-Directconnect-custom-custom.
  4. Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescriptionDéfaut
AWSACCESSKEYSet AWS access key
AWSASSUMEROLESet arn of the role to be assumed
AWSCUSTOMMODEChoose a custom modeawscli
AWSREGIONSet the region name
AWSSECRETKEYSet AWS secret key
CONNECTIONIDConnection id
EXTRAOPTIONSAny extra option you may want to add to every command line (eg. a --verbose flag)
PROXYURLProxy 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 :

ModeModèle
connectionsCloud-Aws-Directconnect-Connections-Api
discoveryUsed for host discovery
list-connectionsNot used in this Plugin Pack
list-virtual-interfacesUsed for service discovery
virtual-interfacesCloud-Aws-Directconnect-Virtual-Interfaces-Api

Options complémentaires​

Options globales​

Les options globales aux modes sont listées ci-dessus :

OptionDescriptionType
--modeChoose a mode.Global
--dyn-modeSpecify a mode with the path (separated by '::').Global
--list-modeList available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionDisplay plugin version.Global
--custommodeChoose a custom mode.Global
--list-custommodeList available custom modes.Global
--multipleMultiple custom mode objects (required by some specific modes)Global
--pass-managerUse a password manager.Global
--verboseDisplay long output.Output
--debugDisplay also debug messages.Output
--filter-perfdataFilter perfdata that match the regexp.Output
--filter-perfdata-advAdvanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")'Output
--explode-perfdata-maxPut max perfdata (if it exist) in a specific perfdata (without values: same with '_max' suffix) (Multiple options)Output
--change-perfdata --extend-perfdataChange 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-groupExtend 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-outputChange short/long output display: --change-short-output=pattern~replace~modifierOutput
--change-exitChange exit code: --change-exit=unknown=criticalOutput
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomFilter UOM that match the regexp.Output
--opt-exitOptional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown).Output
--output-ignore-perfdataRemove perfdata from output.Output
--output-ignore-labelRemove label status from output.Output
--output-xmlDisplay output in XML format.Output
--output-jsonDisplay output in JSON format.Output
--output-openmetricsDisplay metrics in OpenMetrics format.Output
--output-fileWrite output in file (can be used with json and xml options)Output
--disco-formatDisplay discovery arguments (if the mode manages it).Output
--disco-showDisplay discovery values (if the mode manages it).Output
--float-precisionSet the float precision for thresholds (Default: 8).Output
--source-encodingSet 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 :

OptionDescriptionType
--aws-secret-keySet AWS secret key.Awscli
--aws-access-keySet AWS access key.Awscli
--aws-session-tokenSet AWS session token.Awscli
--aws-role-arnSet arn of the role to be assumed.Awscli
--aws-profileSet AWS profile.Awscli
--endpoint-urlOverride AWS service endpoint URL if necessary.Awscli
--regionSet the region name (Required).Awscli
--periodSet period in seconds.Awscli
--timeframeSet timeframe in seconds.Awscli
--statisticSet cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum').Awscli
--zeroedSet metrics value to 0 if none. Usefull when CloudWatch does not return value when not defined.Awscli
--timeoutSet timeout in seconds (Default: 50).Awscli
--sudoUse 'sudo' to execute the command.Awscli
--commandCommand to get information (Default: 'aws'). Can be changed if you have output in a file.Awscli
--command-pathCommand path (Default: none).Awscli
--command-optionsCommand options (Default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself.Awscli
--proxyurlProxy URL if anyAwscli
--skip-ssl-checkAvoid 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

Options des modes​

Les options spécifiques aux modes sont listées ci-dessus :

OptionDescriptionType
--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-idFilter connection id (can be a regexp).Mode
--filter-metricFilter metrics (Can be: 'ConnectionBpsEgress', 'ConnectionBpsIngress', 'ConnectionPpsEgress', 'ConnectionPpsIngress', 'ConnectionLightLevelTx', 'ConnectionLightLevelRx') (Can be a regexp).Mode
--warning-statusSet warning threshold for status. Can used special variables like: %{state}, %{bandwidth}, %{connectionName}Mode
--critical-statusSet 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

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.