J'ai créé une API dans Amazon API Gateway et je veux activer les journaux CloudWatch pour celle-ci. Quelle est la marche à suivre ?

Avec Amazon API Gateway, vous pouvez créer une API à l'aide de la console API Gateway, de l'interface de ligne de commande AWS, de l'API REST du service de contrôle API Gateway et des kits SDK spécifiques à la plate-forme ou au langage. L'exemple donné dans cet article a été créé à l'aide de la console Amazon API Gateway, comme décrit dans Création et test d'une API API Gateway à partir d'un exemple. Cet article décrit également comment activer les journaux CloudWatch à l'aide de la console AWS CloudWatch.

1.    Si vous ne disposez pas encore d'un compte AWS, consultez Préparation à l'utilisation d'Amazon API Gateway et Inscription à AWS.

2.    Effectuez les étapes de la section Création d'un utilisateur, d'un groupe ou d'un rôle IAM dans votre compte AWS.

3.    Effectuez les étapes de la section Attribution aux utilisateurs IAM d'autorisations d'accès aux services de contrôle et d'exécution Access API Gateway, comme requis.

4.    Ouvrez la console AWS IAM et sélectionnez Roles.

5.    Sélectionnez le nom d'un rôle existant ou créez un nouveau rôle et sélectionnez son nom pour afficher la page Role Summary du rôle. Assurez-vous que l'onglet Permissions est sélectionné sur la page Role Summary, puis associez la stratégie AmazonAPIGatewayPushToCloudWatchLogs au rôle. Si vous créez un nouveau rôle, choisissez le type de rôle Amazon API Gateway dans l'assistant de rôle ; la stratégie appropriée s'affiche lorsque vous êtes invité à associer une stratégie au rôle. Cette stratégie accorde au rôle des autorisations complètes pour la création de journaux CloudWatch, nécessaires pour activer les journaux CloudWatch pour les API. Notez l'ARN du rôle en haut de la page, car vous devrez le spécifier sous CloudWatch log role ARN sur la page Settings de la console API Gateway. Ce rôle IAM doit avoir la stratégie d'approbation suivante :

{

    "Version":"2012-10-17",

    "Statement": [

        {

            "Sid": "",

            "Effect":"Allow",

            "Principal": {

                "Service": "apigateway.amazonaws.com"

            },

            "Action": "sts:AssumeRole"

        }

    ]

}

6.    Après avoir accordé à un utilisateur IAM les autorisations requises pour API Gateway, connectez-vous à la console Amazon API Gateway avec l'identité de l'utilisateur IAM et suivez les étapes décrites dans Création et test d'une API API Gateway à partir d'un exemple si vous n'avez pas encore créé d'API API Gateway. Si vous l'avez déjà créée, assurez-vous de l'avoir déployée à une étape.

Ouvrez la console API Gateway et procédez comme suit pour activer les journaux CloudWatch pour vos API API Gateway :

1.    Dans le volet de navigation de gauche, choisissez Settings et entrez l'ARN du rôle auquel vous avez associé la stratégie AmazonAPIGatewayPushToCloudWatchLogs .

2.    Choisissez Save.

3.    Sélectionnez votre API dans la liste de gauche, puis sélectionnez la catégorie Stages pour celle-ci.

4.    Dans le volet du milieu, sélectionnez l'étape requise. Dans le volet de droite de la console API Gateway, sous CloudWatch Settings, cochez la case Enable CloudWatch Logs. Définissez ensuite Log Level sur INFO ou ERROR , à votre convenance, et choisissez Save Changes.

Il est également possible de contrôler la journalisation au niveau d'une méthode individuelle, indépendamment du paramètre défini pour l'ensemble de l'étape :

1.    Dans le volet central de la console API Gateway, sélectionnez le triangle en regard de la première étape de l'API afin de développer sa hiérarchie de méthodes et d'options. Si vous avez créé et développé l'exemple d'API, sélectionnez la méthode GET répertoriée à l'étape /pets/{petId} au bas de la hiérarchie.

2.    Dans le volet de droite, sous Settings, choisissez Override for this method. Une nouvelle option Enable CloudWatch Logs s'affiche. Activez la case à cocher, puis définissez la valeur Log Level requise, comme précédemment.

Lorsque vous activez la journalisation ici, les appels à cette méthode sont enregistrés dans les journaux et ce, même si la journalisation est désactivée au niveau de l'étape.

Notez l'URL répertoriée en haut de la page en regard de Invoke URL:. Cette URL doit être similaire à la suivante si vous avez créé l'exemple d'API API Gateway :

https://uid.execute-api.regionidentifier.amazonaws.com/test/pets/{petId}

Vous pouvez utiliser cette URL pour appeler la méthode /pets/{petId} de l'exemple d'API en ouvrant un navigateur et en remplaçant {petId} par une valeur entière, par exemple /pets/555.

Ouvrez la console CloudWatch, puis choisissez Logs dans le volet de navigation de gauche. Si vous avez correctement activé les journaux CloudWatch pour API Gateway, l'entrée /aws/apigateway/welcome est répertoriée dans la section Log Groups du volet de droite.

Remarque : Après l'activation des journaux CloudWatch à partir de la console API Gateway, vous devrez peut-être redéployer l'API pour que les journaux soient visibles dans la console CloudWatch.

Votre API aura un Log Group nommé API-Gateway-Execution-Logs_api-id/ contenant de nombreux flux de journaux.

Amazon API Gateway, API, journaux, CloudWatch, métriques, IAM, AmazonAPIGatewayPushToCloudWatchLogs, rôle, stratégie, paramètres, surveillance


Cette page vous a-t-elle été utile ? Oui | Non

Retour au Centre de connaissances AWS Support

Vous avez besoin d'aide ? Consultez le site du Centre AWS Support

Date de publication : 25/08/2016