Comment utiliser l'API Scoutbees avec Microsoft Power Automate

ControlUp Scoutbees est une solution basée sur le cloud qui utilise des tests de transactions synthétiques en continu pour vous alerter de manière proactive lorsque la disponibilité de vos applications, de vos postes de travail et de vos ressources réseau est affectée. Scoutbees permet aux équipes d'exploitation informatique d'identifier rapidement les causes des problèmes de disponibilité et de les résoudre avant que la productivité des utilisateurs ne soit affectée.

Du point de vue de la facilité d'utilisation, l'interface utilisateur est simple et intuitive ; Scoutbees est un produit tout à fait génial. Une chose que nos clients nous demandaient (et qui manquait dans le produit) était un moyen d'intégrer Scoutbees dans leur système d'information. Processus DevOps et les plateformes internes existantes. Nous les avons entendus, haut et fort, et nous sommes heureux de vous annoncer qu'Honeycomb, la nouvelle version de l'interface utilisateur, est maintenant disponible. API ScoutbeesEST ICI !

Avec l'API, nous vous donnons la possibilité non seulement d'extraire des données de Scoutbees de manière programmatique, mais aussi de créer de nouveaux scouts et de modifier les scouts existants. Si vous souhaitez créer automatiquement de nouveaux scouts dans le cadre d'un processus automatisé de construction de serveur, pas de problème ! Si vous voulez fournir un bouton optionnel pour permettre la création d'un scout dans votre propre page web, pas de problème ! Voulez-vous afficher certains des résultats des tests de Scoutbees sur votre propre site interne ? Aucun problème ! 

The Scoutbees Honeycomb API gives you access to pretty much all the features you can use in the service and lets you extend them for use in your own applications. It strives to be RESTful and is organized around the main resources you would be interacting with, such as Scouts, Tests, and Hives. If you can dream it, you can pretty much do it. 😊 

Assez discuté. Et si nous l'essayions ensemble ?

Server Build Flow dans Microsoft Power Automate for Desktop

Précédemment, nous avons publié un blog sur construire votre propre intégration personnalisée de ServiceNowqui a été une grande source d'inspiration pour ce billet. Si vous souhaitez apprendre à utiliser une API, c'est un excellent point de départ. 

Dans cet article, nous allons voir comment utiliser l'API Scoutbees dans une application Microsoft Power Automate Flow. Le flux de cet exemple est la construction d'un serveur et dans les étapes suivantes, nous détaillerons l'ajout d'une étape pour configurer un Scoutbees Scout pour effectuer des tests ping continus à la fin de la construction du serveur afin de s'assurer qu'il est surveillé de manière proactive dès le départ. 

TIP : Pour en savoir plus sur le fonctionnement de l'API Scoutbees et sur la manière dont vous pouvez l'utiliser, vous pouvez vous référer à la section Documentation de l'API. Cela peut également vous aider à vous faire une idée des données que vous pouvez extraire et des actions que vous pouvez effectuer.

Conditions préalables

Avant de commencer, nous aurons besoin d'une clé API dans notre compte Scoutbees. 

Pour créer une clé API, il suffit de se connecter à Scoutbees, de cliquer sur le menu hamburger et de cliquer sur API.

Cliquez sur le bouton Créer Clé API bouton.

Indiquez votre clé API et le nom de la clé API, puis cliquez sur Ajouter.

Naviguez jusqu'à la clé que vous venez de créer, développez-la et choisissez l'option Copier la clé API. Vous pouvez coller ce texte dans le bloc-notes pour l'instant, nous en aurons besoin dans notre script PowerShell.

Construire notre script

Notre script est très simple. Vous pouvez voir le peu de lignes nécessaires dans l'image ci-dessus. Pour l'expliquer aussi simplement que possible, nous allons passer en revue 3 sections du code et les assembler pour créer notre premier scout à l'aide de PowerShell, puis nous l'ajouterons à notre processus automatisé de construction de serveur dans Power Automate. Avec ces étapes, vous pouvez facilement créer vos propres scripts et les intégrer dans la plateforme DevOPs de votre choix.

• Utilisation de la clé API dans un script PowerShell

Maintenant que nous avons notre clé API, mettons-la en œuvre.

$headers = @{
            "x-scoutbees-key"='' ;
        }

Dans notre script, j'ai défini une variable headers qui contient ma clé API. Il s'agit d'une section d'en-tête HTML, qui sera analysée lors de l'exécution de notre code pour passer la clé API afin que le service Scoutbees puisse s'authentifier et vérifier que la clé est valide et associée à notre compte Scoutbees. Cela nous permettra de créer notre compte Scout.

Copiez et collez le code ci-dessus en haut de votre script PowerShell et remplacez <APIKey> avec la clé API que vous avez créée dans votre compte Scoutbees. Veillez à conserver les guillemets simples autour de votre clé API.

2.) Remplir le corps avec le paramètre Scoutbees Scout Parameter

Ensuite, j'ai défini un corps HTML dans le script PowerShell.

$body = @{
    "address" = "SERVER01.domain.com"
    "subType" = "net_ping" ;
    "hive" = "eu-central-1" ;
    "options" = @{
        "protocol" = "ICMP" ;
        "payload" = 32 ;
    }
    "scoutName"="SERVER01.domain.com Ping" ;
    "interval"=5 ;
}

Si vous êtes familier avec le langage HTML, vous connaissez déjà les balises d'en-tête et de corps. Alors qu'un en-tête est utilisé pour une section d'en-tête ou de sous-titre d'une page, le corps est généralement la section principale du contenu à afficher sur une page. Dans notre contexte, le corps contient les paramètres pertinents que nous voulons définir pour notre test ping.

Dans cet exemple, nous créons un Scout nommé SERVER01.domain.com Ping qui effectuera un test ping vers SERVER01.domain.com depuis notre ruche Scoutbees hébergée dans le nuage dans l'UE toutes les 5 minutes via le protocole ICMP.

Si vous souhaitez effectuer un test à partir d'un autre répertoire de stockage, vous pouvez simplement indiquer le nom du répertoire de stockage à partir duquel vous souhaitez effectuer le test. Par exemple :

3.) Invoke-RestMethod pour créer notre scout

Voici le script complet pour créer notre Scout. Si vous le mettez dans l'éditeur PowerShell de votre choix, entrez votre clé API et exécutez-le.

$headers = @{
            "x-scoutbees-key"='' ;
        }
$body = @{
    "address" = "SERVER01.domain.com"
    "subType" = "net_ping" ;
    "hive" = "eu-central-1" ;
    "options" = @{
        "protocol" = "ICMP" ;
        "payload" = 32 ;
    }
    "scoutName"="SERVER01.domain.com Ping Test" ;
    "interval"=5 ;
}
$CreateScout = Invoke-RestMethod -Method POST -Uri https://api.scoutbees.io/honeycomb/v1/scouts -Body $($body | ConvertTo-Json) -Headers $headers -ContentType "application/json"

Nous avons ajouté notre dernière section ci-dessus. J'ai tout décomposé dans cette image, afin que nous puissions voir ce qui se passe :

Maintenant, mettez-les ensemble et qu'est-ce que vous avez ? Avec un peu de chance, c'est le cas : 

• Un script PowerShell, structuré selon notre documentation API 
• Cela invoque une méthode REST 
• qui envoie une requête au service web RESTful de Scoutbees 
• Un scout réseau qui envoie un ping à votre serveur à partir d'un Cloud Hive sélectionné.

À ce stade, notre script PowerShell étant terminé, nous pouvons tester et exécuter le code pour confirmer qu'il fonctionne comme prévu.

Ajouter le script dans un flux Power Automate

Enfin, pour ce cas d'utilisation, nous avons placé une action de script "Exécuter PowerShell" dans notre flux Power Automate et collé le script. J'ai choisi cette action comme dernière action de mon flux, de sorte qu'elle ne s'exécute que lorsque les étapes de construction du serveur complet se sont achevées avec succès. 

Option de test à partir d'une ruche personnalisée

Si vous avez un œil d'aigle, vous avez peut-être remarqué que le script que j'ai collé dans Power Automate contenait un numéro au lieu du nom d'un Cloud Hive. Ce numéro correspond à l'ID d'un répertoire de stockage personnalisé dans mon organisation. Lorsque vous construisez un serveur, il est probable qu'il ne soit pas accessible depuis l'extérieur de votre réseau d'entreprise. C'est à ce moment-là qu'une configuration de ruche personnalisée sur une machine de votre réseau d'entreprise s'avère utile. 

Si vous souhaitez effectuer un test à partir d'un répertoire de stockage personnalisé, installez l'agent sur une machine Windows de votre réseau d'entreprise à l'aide de la commande ces instructions.

Récupérer votre identifiant de ruche personnalisé

$headers = @{
            "x-scoutbees-key"='' ;
        }
#obtenir la liste des éclaireurs du réseau
#$body = @{
 # "subType" = "net_ping" ;
#}
$scoutsQuery = Invoke-RestMethod -Method GET -Uri https://api.scoutbees.io/honeycomb/v1/hives -Body $body -Headers $headers

if ($scoutsQuery.total_pages -ne 1) {
    ## Plus de scouts que de données renvoyées
}

## Afficher la liste des ruches
$scouts = $scoutsQuery.Data

$scouts = $scoutsQuery.Data
## Convertir les données des éclaireurs en objets

write-host $scouts

Saisissez votre clé API dans le code ci-dessus et exécutez-le dans PowerShell pour récupérer une liste de vos scouts. Dans le résultat, copiez la valeur id= renvoyée dans votre script. Si vous disposez de plusieurs ruches personnalisées, sélectionnez l'identifiant de celle que vous souhaitez utiliser pour les tests, en veillant à ce qu'elle soit activée et connectée.

Il vous suffit maintenant de modifier votre script et de remplacer le nom de la ruche Cloud par le numéro d'identification que vous avez copié pour créer un scout qui effectue des tests à partir d'une ruche située à l'intérieur de votre réseau d'entreprise.

Prolonger la durée de vie de votre scout

Vous souhaitez peut-être faire plus qu'un simple test ping de votre serveur. Si vous souhaitez également configurer un Scout pour effectuer un Traceroute sur le port 443 pour un serveur Web ou 1433 pour un serveur SQL, il vous suffit d'ajouter le code suivant à votre script :

$headers = @{
            "x-scoutbees-key"='' ;
        }

$body = @{
    "address" = "SERVER01.domain.com"
    "subType" = "net_traceroute" ;
    "hive" = "CloudHiveouCustomHiveID" ;
    "options" = @{
        "protocol" = "TCP" ;
        "port" =  ;
        "timeout" = 3.6 ;
        "numpaths" = 10 ;
    }
    "scoutName"="SERVER01.domain.com  Test" ;
    "intervalle"=5 ;
}

Saisissez votre propre clé API, le répertoire de stockage que vous souhaitez utiliser pour les tests et le numéro de port dont vous souhaitez tester la disponibilité.

ControlUp Scoutbees s'est avéré être un outil inestimable dans la boîte à outils de nos clients depuis son lancement. Il s'agit sans doute du produit d'entreprise le plus simple à mettre en place au monde. En fait, vous pouvez configurer Scoutbees et commencer à l'utiliser en un peu plus de deux minutes !

Bonjour, 1TP5L'expérience numérique fam ! C'est l'heure d'un nouvel épisode de ControlUp. #TekTok, with THE @joelinthecloud. He's got the scoop on how to get started with Scoutbees, our super-smart, SaaS-based proactive synthetic testing app: https://t.co/AzddDdtBxg #DEX #ExpérienceTout le monde pic.twitter.com/JN6JimehEO

- ControlUp (@ControlUp) 4 novembre 2021

Nous espérons que vous avez apprécié cet article de blog et que, tout comme j'ai été inspirée pour l'essayer après avoir lu l'article sur le thème de l'eau. Blog sur l'intégration de ServiceNowSi vous n'êtes pas convaincu, vous serez peut-être inspiré d'ajouter cette méthode à votre processus automatisé de création de serveur ou à d'autres processus automatisés que vous utilisez dans votre travail quotidien. Démarrer avec ControlUp Scoutbees aujourd'hui !