Surveiller l'exécution du workflow

Amazon CloudWatch surveille vos AWS ressources et les applications que vous exécutez AWS Cloud en temps réel. Vous pouvez utiliser Amazon CloudWatch pour collecter et suivre des métriques, qui sont des variables que vous pouvez mesurer pour vos flux de travail. Vous pouvez consulter les statistiques du flux de travail et les journaux consolidés à l'aide d'Amazon CloudWatch.

CloudWatch journalisation d'un flux de travail

CloudWatch fournit un audit et une journalisation consolidés de la progression et des résultats du flux de travail.

AWS Transfer Family propose deux méthodes pour fournir des journaux d'exécution des flux de travail gérés à Amazon CloudWatch :

• Un groupe de journaux que vous spécifiez (destination des journaux structurés)  : vous spécifiez un groupe de CloudWatch journaux comme destination des journaux structurés pour le flux de travail, et Transfer Family fournit les journaux d'exécution du flux de travail à ce groupe de journaux pour vous. Cette option ne nécessite pas de rôle de journalisation. Pour l'utiliser, indiquez le nom de ressource Amazon (ARN) d'un groupe de journaux dans le StructuredLogDestinations paramètre lorsque vous créez le flux de travail (voir StructuredLogDestinations dans la référence de l'AWS Transfer Family API). Le groupe de journaux doit se trouver dans le même environnement Compte AWS Région AWS que le flux de travail.

  Pour configurer une destination de journal structurée, la politique IAM du principal qui crée le flux de travail doit contenir les autorisations suivantes :

  • logs:CreateLogDelivery

  • logs:DeleteLogDelivery

  • logs:DescribeLogGroups

  • logs:DescribeResourcePolicies

  • logs:GetLogDelivery

  • logs:ListLogDeliveries

  • logs:PutResourcePolicy

  • logs:UpdateLogDelivery

• Un rôle de journalisation  : vous attachez un rôle de journalisation IAM au serveur auquel le flux de travail est rattaché. Transfer Family assume le rôle d'écrire les journaux d'exécution du flux de travail dans un groupe de journaux nommé/aws/transfer/server-id. Pour plus de détails, consultez Configurer le rôle de CloudWatch journalisation.

Les deux mécanismes écrivent le même contenu du journal d'exécution du flux de travail dans le même format JSON. La différence réside uniquement dans l'endroit où les journaux sont livrés : au groupe de journaux que vous spécifiez ou au groupe de /aws/transfer/server-id journaux sur le serveur via le rôle de journalisation.

Afficher les CloudWatch journaux Amazon pour les flux de travail

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

2. Dans le volet de navigation de gauche, choisissez Logs, puis Log groups.

3. Sur la page Groupes de journaux, dans la barre de navigation, choisissez la région appropriée pour votre AWS Transfer Family serveur.

4. Choisissez le groupe de journaux qui contient les journaux de votre flux de travail.

   • Si le flux de travail utilise une destination de journal structurée, choisissez le groupe de journaux dont vous avez spécifié l'ARN dans le StructuredLogDestinations paramètre du flux de travail.

   • Si le flux de travail utilise un rôle de journalisation sur le serveur, choisissez le groupe de journaux correspondant à votre serveur. Par exemple, si l'ID de votre serveur ests-1234567890abcdef0, votre groupe de journaux l'est/aws/transfer/s-1234567890abcdef0.

5. Sur la page des détails du groupe de journaux, les flux de journaux les plus récents sont affichés. Le nom du flux de journaux pour le flux de travail dépend du mécanisme de journalisation utilisé par le flux de travail :

   • Pour une destination de journal structurée, le flux de journal du flux de travail est nomméworkflowID/executionID. Par exemple :

     w-abcdef01234567890/021345abcdef6789

   • Pour un rôle de journalisation, le groupe de journaux du serveur contient deux flux de journaux pour l'utilisateur que vous explorez : un pour chaque session SFTP (Secure Shell) File Transfer Protocol (SSH) et un pour le flux de travail en cours d'exécution. Le format du flux de journal du flux de travail estusername.workflowID.uniqueStreamSuffix.

   Par exemple, si votre utilisateur l'estmary-major, vous disposez des flux de journaux suivants :

   mary-major-east.1234567890abcdef0
   mary.w-abcdef01234567890.021345abcdef6789

   Note

   Les identifiants alphanumériques à 16 chiffres répertoriés dans cet exemple sont fictifs. Les valeurs que vous voyez sur Amazon CloudWatch sont différentes.

La page Journaliser les événements d'un flux de journal de flux de travail contient les détails relatifs à l'exécution du flux de travail. Si le flux de travail utilise un rôle de journalisation, le mary-major-usa-east.1234567890abcdef0 flux affiche les détails de chaque session utilisateur et le mary.w-abcdef01234567890.021345abcdef6789 flux contient les détails du flux de travail. Si le flux de travail utilise une destination de journal structurée, le w-abcdef01234567890/021345abcdef6789 flux contient les détails du flux de travail.

Voici un exemple de flux de journal pourmary.w-abcdef01234567890.021345abcdef6789, basé sur un workflow (w-abcdef01234567890) qui contient une étape de copie.

{
    "type": "ExecutionStarted",
    "details": {
        "input": {
            "initialFileLocation": {
                "bucket": "amzn-s3-demo-bucket",
                "key": "mary/workflowSteps2.json",
                "versionId": "version-id",
                "etag": "etag-id"
            }
        }
    },
    "workflowId":"w-abcdef01234567890",
    "executionId":"execution-id",
    "transferDetails": {
        "serverId":"s-server-id",
        "username":"mary",
        "sessionId":"session-id"
    }
},
{
    "type":"StepStarted",
    "details": {
        "input": {
            "fileLocation": {
                "backingStore":"S3",
                "bucket":"amzn-s3-demo-bucket",
                "key":"mary/workflowSteps2.json",
                "versionId":"version-id",
                "etag":"etag-id"
            }
        },
        "stepType":"COPY",
        "stepName":"copyToShared"
    },
    "workflowId":"w-abcdef01234567890",
    "executionId":"execution-id",
    "transferDetails": {
        "serverId":"s-server-id",
        "username":"mary",
        "sessionId":"session-id"
    }
},
{
    "type":"StepCompleted",
    "details":{
        "output":{},
        "stepType":"COPY",
        "stepName":"copyToShared"
    },
    "workflowId":"w-abcdef01234567890",
    "executionId":"execution-id",
    "transferDetails":{
        "serverId":"server-id",
        "username":"mary",
        "sessionId":"session-id"
    }
},
{
    "type":"ExecutionCompleted",
    "details": {},
    "workflowId":"w-abcdef01234567890",
    "executionId":"execution-id",
    "transferDetails":{
        "serverId":"s-server-id",
        "username":"mary",
        "sessionId":"session-id"
    }
}

CloudWatch métriques pour les flux de travail

AWS Transfer Family fournit plusieurs mesures pour les flux de travail. Vous pouvez consulter les statistiques relatives au nombre d'exécutions de flux de travail démarrées, terminées avec succès et ayant échoué au cours de la minute précédente. Toutes les CloudWatch mesures relatives à Transfer Family sont décrites dansUtilisation de CloudWatch métriques pour les serveurs Transfer Family.