Aller au contenu principal

Azure ServiceBus

Vue d'ensemble​

Microsoft Azure Service Bus est un répartiteur de messages d’entreprise complètement managé, avec des files d’attente de messages et des rubriques de publication/abonnement. Service Bus est utilisé pour découpler les applications et les services les uns des autres pour offrir les avantages suivants :

  • Travail d’équilibrage de charge entre les workers concurrents
  • Routage et transfert de façon sĂ©curisĂ©e des donnĂ©es et du contrĂ´le au-delĂ  des limites des services et des applications
  • Coordination du travail transactionnel qui nĂ©cessite un degrĂ© Ă©levĂ© de fiabilitĂ©

Le connecteur de supervision Centreon Azure ServiceBus s'appuie sur les API Azure Monitor afin de récuperer les métriques relatives au service ServiceBus. Il est possible d'utiliser les 2 modes proposés par Microsoft: RestAPI ou Azure CLI.

Contenu du connecteur de supervision​

Objets supervisés​

  • Instances Azure ServiceBus
    • Connections
    • Messages
    • Requests
    • Resources

Règles de découverte​

Le connecteur de supervision Centreon Azure ServiceBus inclut un provider de découverte d'Hôtes nommé Microsoft Azure ServiceBus. Celui-ci permet de découvrir l'ensemble des instances ServiceBus rattachés à une souscription Microsoft Azure donnée:

image

La découverte Azure ServiceBus n'est compatible qu'avec le mode 'api'. Le mode 'azcli' n'est pas supporté dans le cadre de cette utilisation.

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​

Metric NameDescriptionUnit
servicebus.namespace.messages.active.countCount of active messages in a Queue/TopicCount
servicebus.namespace.messages.deadlettered.countCount of dead-lettered messages in a Queue/TopicCount
servicebus.namespace.messages.incoming.countIncoming MessagesCount
servicebus.namespace.messages.outgoing.countOutgoing MessagesCount
servicebus.namespace.messages.scheduled.countCount of scheduled messages in a Queue/Topic.Count
servicebus.namespace.messages.total.countTotal messagesCount

Prérequis​

Rendez-vous sur la documentation dédiée afin d'obtenir les prérequis nécessaires pour interroger les API d'Azure.

Installation​

  1. Installer le Plugin sur tous les collecteurs Centreon devant superviser des resources Azure ServiceBus:
yum install centreon-plugin-Cloud-Azure-Integration-ServiceBus-Api
  1. Sur l'interface Integration de Centreon, installer le connecteur de supervision Azure ServiceBus depuis la page Configuration > Gestionnaire de connecteurs de supervision

Configuration​

Hôte​

  • Ajoutez un HĂ´te Ă  Centreon, remplissez le champ Adresse IP/DNS avec l'adresse 127.0.0.1 et appliquez-lui le Modèle d'HĂ´te Cloud-Azure-Integration-ServiceBus-custom.
  • Une fois le modèle appliquĂ©, les Macros ci-dessous indiquĂ©es comme requises (Mandatory) doivent ĂŞtre renseignĂ©es selon le custom-mode utilisĂ©:
MandatoryNomDescription
XAZURECUSTOMMODECustom mode 'api'
XAZURESUBSCRIPTIONSubscription ID
XAZURETENANTTenant ID
XAZURECLIENTIDClient ID
XAZURECLIENTSECRETClient secret
XAZURERESOURCEId of the ServiceBus resource

FAQ​

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:

/usr/lib/centreon/plugins/centreon_azure_integration_servicebus_api.pl \
    --plugin=cloud::azure::integration::servicebus::plugin \
    --mode=requests \
    --custommode=api \
    --subscription='xxxxxxxxx' \
    --tenant='xxxxxxxxx' \
    --client-id='xxxxxxxxx' \
    --client-secret='xxxxxxxxx' \
    --resource='SVC001ABCD' \
    --timeframe='900' \
    --interval='PT5M' \
    --warning-throttled-requests='800' \
    --critical-throttled-requests='900'

La commande devrait retourner un message de sortie similaire Ă :

OK: Instance 'SVC001ABCD' Statistic 'total' Metrics Incoming Requests: 1227.00, Successful Requests: 1221.00 Throttled Requests: 6.00 |
'SVC001ABCD~maximum#servicebus.namespace.requests.incoming.count'=1221;;;0; 'SVC001ABCD~maximum#servicebus.namespace.requests.successful.count'=1221;;;0; 
'SVC001ABCD~maximum#servicebus.namespace.requests.throttled.count'=6;800;900;0;

La commande ci-dessus vérifie les requêtes sur l'instance ServiceBus nommée SIG001ABCD (--plugin=cloud::azure::integration::servicebus::plugin --mode=requests --resource='SIG001ABCD').

Le mode de connexion utilisé est 'api' (--custommode=api), les paramètres d'authentification nécessaires à l'utilisation de ce mode sont donc renseignés en fonction (--subscription='xxxxxxxxx' --tenant='xxxxxxx' --client-id='xxxxxxxx' --client-secret='xxxxxxxxxx').

Les statuts caculés se baseront sur les valeurs totales d'un échantillon dans un intervalle de 15 minutes / 900 secondes (--timeframe='900') avec un état retourné par tranche de 5 minutes (--interval='PT5M').

Dans cet exemple, une alarme de type WARNING sera déclenchée si le nombre de Throttled Requests pendant l'intervalle donné est supérieur à 800 (--warning-throttled-requests='800'); l'alarme sera de type CRITICAL au-delà de 900 requêtes (--critical-throttled-requests='900').

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_azure_integration_servicebus_api.pl \
    --plugin=cloud::azure::integration::servicebus::plugin \
    --mode=requests \
    --help

Diagnostic des erreurs communes​

Les identifiants ont changé et mon Plugin ne fonctionne plus​

Le Plugin utilise un fichier de cache pour conserver les informations de connexion afin de ne pas se ré-authentifier à chaque appel. Si des informations sur le Tenant, la Souscription ou les Client ID / Secret changent, il est nécessaire de supprimer le fichier de cache du Plugin.

Celui ci se trouve dans le répertoire /var/lib/centreon/centplugins/ avec le nom azureapi<md5>_<md5>_<md5>_<md5>.

UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message)​

Lors du déploiement de mes contrôles, j'obtiens le message suivant : UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message).

Cela signifie que l'un des paramètres utilisés pour authentifier la requête est incorrect. Le paramètre en question est spécifié dans le message d'erreur en lieu et place de 'ERROR_DESC'.

Par exemple, 'invalid_client' signifie que le client-id et/ou le client-secret n'est (ne sont) pas valide(s).

UNKNOWN: 500 Can't connect to login.microsoftonline.com:443​

Si l'utilisation d'un proxy est requise pour les connexions HTTP depuis le collecteur Centreon, il est nécessaire de le préciser dans la commande en utilisant l'option --proxyurl='http://proxy.mycompany.com:8080'.

Il est également possible qu'un équipement tiers de type Pare-feu bloque la requête effectuée par le Plugin.

UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values​

Lors du déploiement de mes contrôles, j'obtiens le message suivant 'UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values'.

Cela signifie qu'Azure n'a pas consolidé de données sur la période.

Vous pouvez ajouter --zeroed Ă  la macro EXTRAOPTIONS du service en question afin de forcer le stockage d'un 0 et ainsi Ă©viter un statut UNKNOWN.