Création d'un Canary

Important

Assurez-vous d'utiliser Synthetics Canaries pour surveiller uniquement les points de terminaison dont vous êtes propriétaire ou APIs autorisé. Selon les paramètres de fréquence des scripts Canary, ces points de terminaison peuvent connaître un trafic accru.

Lorsque vous utilisez la CloudWatch console pour créer un canari, vous pouvez utiliser un plan fourni par CloudWatch pour créer votre canari ou vous pouvez écrire votre propre script. Pour plus d’informations, consultez Utilisation des modèles de scripts Canary.

Vous pouvez également créer un canari en utilisant AWS CloudFormation si vous utilisez votre propre script pour le canari. Pour plus d'informations, consultez AWS: :Synthetics : :Canary dans le guide de l'utilisateur.AWS CloudFormation

Si vous écrivez votre propre script, vous pouvez utiliser plusieurs fonctions intégrées par CloudWatch Synthetics dans une bibliothèque. Pour plus d’informations, consultez Versions d'exécution Synthetics.

Note

Lorsque vous créez un canari, l'une des couches créées est une couche Synthetics précédée de. Synthetics Cette couche appartient au compte de service Synthetics et contient le code d'exécution.

Pour créer un script Canary

1. Ouvrez la CloudWatch console à l'adresse https://console.aws.amazon.com/cloudwatch/.

2. Dans le volet de navigation, choisissez Application Signals, Synthetics Canaries.

3. Choisissez Create Canary (Créer un script Canary).

4. Sélectionnez l'une des méthodes suivantes :

   • Pour baser votre script Canary sur un modèle de script, choisissez Use a blueprint (Utiliser un modèle), puis le type de script Canary que vous souhaitez créer. Pour de plus amples informations sur les activités de chaque type de modèle, veuillez consulter Utilisation des modèles de scripts Canary.

   • Pour télécharger votre propre script Node.js afin de créer un script Canary personnalisé, choisissez Upload a script (Charger un script).

     Vous pouvez ensuite faire glisser votre script dans la zone Script ou choisir Browse files (Parcourir les fichiers) pour accéder au script dans votre système de fichiers.

   • Pour importer votre script à partir d'un compartiment S3, choisissez Import from S3 (Importer à partir de S3). Sous Source location (Emplacement source), saisissez le chemin d'accès complet à votre script Canary ou choisissez Browse S3 (Parcourir S3).

     Vous devez disposer d'autorisations s3:GetObject et s3:GetObjectVersion pour le compartiment S3 que vous utilisez. Le bucket doit se trouver dans la même AWS région que celle où vous créez le canari.

5. Sous Nom, entrez le nom du script Canary. Le nom est utilisé sur de nombreuses pages, donc nous vous recommandons de lui donner un nom descriptif qui le distingue des autres scripts Canary.

6. Sous Application ou point de terminaison URL, entrez celui URL que vous souhaitez que le canari teste. Cela URL doit inclure le protocole (tel que https ://).

   Si vous souhaitez que le Canary teste un point de terminaison sur unVPC, vous devez également saisir les informations vous concernant VPC ultérieurement dans cette procédure.

7. Si vous utilisez votre propre script pour le script Canary, sous le Lambda handler (Gestionnaire Lambda), saisissez le point d'entrée à partir duquel le script Canary doit commencer. Si vous utilisez une exécution antérieure à syn-nodejs-puppeteer-3.4 ou à syn-python-selenium-1.1, la chaîne que vous saisissez doit se terminer par .handler. Si vous utilisez syn-nodejs-puppeteer-3.4, syn-python-selenium-1.1 ou une exécution ultérieure, cette restriction ne s'applique pas.

8. Si vous utilisez des variables d'environnement dans votre script, choisissez Environment variables (Variables d'environnement), puis spécifiez une valeur pour chaque variable d'environnement définie dans votre script. Pour plus d’informations, consultez Variables d’environnement.

9. Sous Schedule (Planification), choisissez si vous souhaitez exécuter ce script Canary une seule fois, l'exécuter en continu à l'aide d'une expression rate ou le planifier à l'aide d'une expression cron.

   • Lorsque vous utilisez la CloudWatch console pour créer un canari qui fonctionne en continu, vous pouvez choisir un débit compris entre une fois par minute et une fois par heure.

   • Pour plus d'informations sur l'écriture d'une expression cron pour la planification d'un script Canary, consultez Planification d'exécutions de scripts Canary à l'aide de cron.

10. (Facultatif) Pour définir une valeur de délai d'attente pour le canary, choisissez Configuration supplémentaire puis spécifiez la valeur du délai d'attente. Ne pas dépasser 15 secondes pour permettre les démarrages à froid Lambda et le temps nécessaire pour démarrer l'instrumentation canary.

11. Sous Conservation des données, spécifiez la durée de conservation des informations sur les exécutions de scripts Canary échouées et réussies. La plage va de 1 à 455 jours.

    Ce paramètre affecte uniquement les données que CloudWatch Synthetics stocke et affiche dans la console. Cela n'affecte pas les données stockées dans vos compartiments Amazon S3, ni les journaux ou les mesures publiés par Canary.

12. Sous Data Storage (Stockage de données), sélectionnez le compartiment S3 à utiliser pour stocker les données provenant des exécutions des tests du script Canary. Le nom du compartiment ne peut pas contenir de point (.). Si vous laissez ce champ vide, un compartiment S3 par défaut est utilisé ou créé.

    Si vous utilisez l'environnement d'exécution syn-nodejs-puppeteer-3.0 ou une version ultérieure, lorsque vous entrez le URL nom du bucket dans la zone de texte, vous pouvez spécifier un bucket dans la région actuelle ou dans une autre région. Si vous utilisez une version d'exécution antérieure, le compartiment doit se trouver dans la région actuelle.

13. (Facultatif) Par défaut, les canaris stockent leurs artefacts sur Amazon S3, et les artefacts sont chiffrés au repos à l'aide d'une AWS clé gérée AWS KMS . Vous pouvez utiliser une autre option de chiffrement en choisissant Additional configuration (Configuration supplémentaire) dans la section Data Storage (Stockage de données). Vous pouvez ensuite choisir le type de clé à utiliser pour le chiffrement. Pour plus d’informations, consultez Chiffrement des artefacts de script Canary.

14. Sous Autorisations d'accès, choisissez de créer un IAM rôle pour exécuter le Canary ou d'utiliser un rôle existant.

    Si CloudWatch Synthetics crée le rôle, il inclut automatiquement toutes les autorisations nécessaires. Si vous souhaitez créer le rôle vous-même, consultez Rôles et autorisations requis pour les scripts Canary pour plus d'informations sur les autorisations nécessaires.

    Si vous utilisez la CloudWatch console pour créer un rôle pour un canari lorsque vous créez le canari, vous ne pouvez pas réutiliser le rôle pour d'autres canaris, car ces rôles sont spécifiques à un seul canari. Vous pouvez utiliser un rôle existant, si vous avez créé manuellement un rôle qui fonctionne pour plusieurs scripts Canary.

    Pour utiliser un rôle existant, vous devez avoir l'autorisation iam:PassRole de transmettre ce rôle à Synthetics et à Lambda. Vous devez également avoir l'autorisation iam:GetRole.

15. (Facultatif) Sous Alarmes, indiquez si vous souhaitez que des CloudWatch alarmes par défaut soient créées pour ce canari. Si vous choisissez de créer des alertes, elles sont créées selon la convention de nom suivante :Synthetics-Alarm-canaryName-index

    index est un numéro représentant chaque alerte créée pour ce script Canary. La première alerte a un index de 1, la deuxième alerte a un index de 2, et ainsi de suite.

16. (Facultatif) Pour que ce Canary teste un point de terminaison situé sur unVPC, choisissez VPCles paramètres, puis procédez comme suit :

    1. Sélectionnez celui VPC qui héberge le point de terminaison.

    2. Sélectionnez un ou plusieurs sous-réseaux sur votreVPC. Vous devez sélectionner un sous-réseau privé, car une instance Lambda ne peut pas être configurée pour s'exécuter dans un sous-réseau public lorsqu'une adresse IP ne peut pas être attribuée à l'instance Lambda lors de l'exécution. Pour plus d'informations, consultez Configuration d'une fonction Lambda pour accéder aux ressources d'un. VPC

    3. Sélectionnez un ou plusieurs groupes de sécurité sur votreVPC.

    Si le point de terminaison se trouve sur unVPC, vous devez autoriser votre Canary à envoyer des informations à CloudWatch Amazon S3. Pour plus d’informations, consultez Faire courir un canari sur un VPC.

17. (Facultatif ) Sous Tags (Balises), ajoutez une ou plusieurs paires clé/valeur comme balises pour ce script Canary. Les balises peuvent vous aider à identifier et à organiser vos AWS ressources et à suivre vos AWS coûts. Pour plus d’informations, consultez Marquer vos ressources Amazon CloudWatch .

18. (Facultatif) Sous Active tracing (Suivi actif), choisissez d'activer ou non le suivi X-Ray actif pour ce script Canary. Cette option est disponible uniquement si le script Canary utilise la version d'exécution syn-nodejs-2.0 ou ultérieure. Pour plus d’informations, consultez Scripts Canary et suivi X-Ray.

Ressources créées pour les scripts Canary

Lorsque vous créez un script Canary, les ressources suivantes sont créées :

• Un IAM rôle avec le nom CloudWatchSyntheticsRole-canary-name-uuid (si vous utilisez la CloudWatch console pour créer le canari et que vous spécifiez qu'un nouveau rôle sera créé pour le canari)

• Une stratégie IAM portant le nom CloudWatchSyntheticsPolicy-canary-name-uuid

• Un compartiment S3 portant le nom cw-syn-results-accountID-region.

• Des alertes portant le nom Synthetics-Alarm-MyCanaryName (si vous voulez créer des alertes pour le script Canary)

• Fonctions et couches Lambda, si vous utilisez un modèle pour créer le script Canary. Ces ressources ont le préfixe cwsyn-MyCanaryName.

• CloudWatch Enregistre les groupes de journaux avec le nom/aws/lambda/cwsyn-MyCanaryName-randomId.