Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Effectuer des mises à jour sécurisées des scripts Canary

CloudWatch Synthetics Safe Canary Updates vous permet de tester les mises à jour sur vos canaris existants avant d'appliquer les modifications. Cette fonctionnalité vous aide à valider la compatibilité du script Canary avec les nouvelles versions d’exécution ainsi qu’avec d’autres modifications de configuration, comme les modifications de code ou de mémoire. Cela permet de réduire au minimum les risques de perturbations du suivi de surveillance en cas d’erreur lors des mises à jour.

Grâce aux mises à jour sécurisées des scripts Canary, vous pouvez tester les mises à jour de version d’exécution, vérifier les modifications de configuration, valider les modifications de code, réduire les risques d’erreur, maintenir une surveillance continue et réduire au minimum la durée d’indisponibilité.

Conditions préalables

Assurez-vous que les prérequis sont remplis.

Bonnes pratiques

Voici quelques bonnes pratiques à suivre lorsque vous exécutez un script Canary.

Test d’un script Canary à l’aide d’un test à blanc

Vous pouvez tester la mise à jour du script Canary à l’aide des options suivantes :

Utilisation du flux de travail AWS Management Console's Edit

Utilisation du AWS Management Console pour mettre à jour les canaris par lots

Utilisation de la AWS CLI ou du SDK

L’API lance le test à blanc pour le nom de script Canary fourni MyCanary et met à jour la version d’exécution vers syn-nodejs-puppeteer-10.0.

aws synthetics start-canary-dry-run \
    --name MyCanary \
    --runtime-version syn-nodejs-puppeteer-10.0
      
      // Or if you wanted to update other configurations:

aws synthetics start-canary-dry-run \
    --name MyCanary \
    --execution-role-arn arn:aws:iam::123456789012:role/NewRole

L’API renvoie le DryRunId dans la DryRunConfigOutput.

Appelez GetCanary avec le DryRunId fourni pour obtenir la configuration du test à blanc du script Canary ainsi qu’un champ supplémentaire DryRunConfig indiquant l’état du test à blanc, affiché sous forme de LastDryRunExecutionStatus.

aws synthetics get-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

Pour plus de détails, utilisez GetCanaryRuns avec le DryRunId fourni pour extraire les informations d’exécution et les détails supplémentaires.

aws synthetics get-canary-runs \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

Après un test à blanc réussi, vous pouvez ensuite utiliser UpdateCanary avec le DryRunId correspondant pour valider définitivement vos modifications.

aws synthetics update-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

En cas d'échec pour quelque raison que ce soit (le résultat de GetCanaryRuns contiendra les détails), l'emplacement du résultat GetCanaryRuns contient un artefact contenant les journaux à déboguer. S’il n’y a aucun journal, cela signifie que le test à blanc n’a pas pu être créé. Vous pouvez valider en utilisant GetCanary.

aws synthetics get-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

L'état StateReason, et StateReasonCodeaffiche l'état du cycle à sec.

En utilisant CloudFormation

Dans votre modèle de script Canary Synthetics, ajoutez le champ DryRunAndUpdate, qui accepte une valeur booléenne true ou false.

Lorsque la valeur est true, chaque mise à jour exécute automatiquement un test à blanc afin de valider les modifications avant de mettre à jour le script Canary. Lorsque le dry run échoue, Canary ne se met pas à jour et échoue au déploiement et CloudFormation au déploiement pour une raison valable. Pour déboguer ce problème, utilisez la console AWS  Synthetics ou, si vous utilisez une API, récupérez le ArtifactS3Location à l’aide de l’API GetCanaryRuns, puis téléchargez les fichiers *-log.txt afin d’examiner les journaux d’exécution du script Canary et identifier les erreurs. Après validation, modifiez le CloudFormation modèle et réessayez le déploiement ou utilisez l'API ci-dessus pour valider.

Lorsque la valeur est false, Synthetics n’exécute pas de test à blanc pour valider les modifications et applique directement vos mises à jour.

Pour plus d’informations sur la résolution des défaillances d’un script Canary, consultez Dépannage d'un script Canary ayant échoué.

Exemple de modèle .

SyntheticsCanary:
    Type: 'AWS::Synthetics::Canary'
    Properties:
      Name: MyCanary
      RuntimeVersion: syn-nodejs-puppeteer-10.0
      Schedule: {Expression: 'rate(5 minutes)', DurationInSeconds: 3600}
      ...
      DryRunAndUpdate: true

Limitations