Configuration de la journalisation CloudWatch pour les API REST dans API Gateway

Pour vous aider à déboguer les problèmes liés à l’exécution de demandes ou à l’accès client à votre API, vous pouvez activer Amazon CloudWatch Logs pour enregistrer les appels d’API. Pour plus d’informations sur CloudWatch, consultez Surveillance de l’exécution d’une API REST à l’aide des métriques Amazon CloudWatch.

Formats des journaux CloudWatch pour API Gateway

Il existe deux types de journalisation d’API dans Amazon CloudWatch : la journalisation des exécutions et celle des accès. Dans la journalisation des exécutions, API Gateway gère CloudWatch Logs. Le processus comprend la création de groupes de journaux et de flux de journaux, et la génération de rapports dans les flux de journaux sur toutes les demandes et réponses des utilisateurs.

Les données journalisées incluent les erreurs ou les suivis d’exécution (comme valeurs des paramètres des demandes ou réponses, ou données utiles), les données utilisées par les mécanismes d’autorisation Lambda (anciennement appelés mécanismes d’autorisation personnalisée), et indiquent, entre autres, si des clés d’API sont requises, si les plans d’utilisation sont activés, ainsi que d’autres informations. API Gateway supprime les en-têtes d’autorisation, les valeurs des clés d’API et d’autres paramètres de demande sensibles similaires des données journalisées.

Lorsque vous déployez une API, API Gateway crée un groupe de journaux et, sous celui-ci, les flux de journaux. Le groupe de journaux est nommé selon le format API-Gateway-Execution-Logs_{rest-api-id}/{stage_name}. Dans chaque groupe de journaux, les journaux sont ensuite divisés en flux de journaux, qui sont ordonnés par Heure du dernier événement à mesure que les données sont rapportées.

Dans la journalisation des accès, vous, en tant que développeur d’API, souhaitez enregistrer qui a accédé à votre API et comment l’appelant à eu accès à l’API. Vous pouvez créer votre propre groupe de journaux ou en choisir un existant, qui peut être géré par API Gateway. Pour spécifier les détails d’accès, vous devez sélectionner des variables $context, un format de journal et une destination de groupe de journaux.

Le format du journal d’accès doit inclure au moins $context.requestId ou $context.extendedRequestId. À titre de bonne pratique, incluez $context.requestId et $context.extendedRequestId dans le format de votre journal.

Choisissez un format de journal également adopté par votre backend analytique, comme Common Log Format (CLF), JSON, XML ou CSV. Vous pouvez ensuite y renseigner les journaux d’accès directement pour que vos mesures soient calculées et renvoyées. Pour définir le format des journaux, définissez l’ARN du groupe de journaux sur la propriété accessLogSettings/destinationArn lors de l’étape. Vous pouvez obtenir un ARN de groupe de journaux dans la console CloudWatch. Pour définir le format des journaux d’accès, définissez celui choisi sur la propriété accessLogSetting/format lors de l’étape.

Quelques exemples de certains formats de journaux d’accès utilisés couramment sont affichés dans la console API Gateway et répertoriés ci-dessous.

Autorisations pour la journalisation CloudWatch

Pour activer CloudWatch Logs, vous devez accorder l’autorisation API Gateway pour lire et écrire les journaux dans CloudWatch pour votre compte. AmazonAPIGatewayPushToCloudWatchLogs dispose de toutes les autorisations requises.

Pour accorder ces autorisations à votre compte, créez un rôle IAM avec apigateway.amazonaws.com comme entité approuvée, attachez la politique précédente au rôle IAM et définissez l’ARN du rôle IAM sur la propriété cloudWatchRoleArn de votre compte. Vous devez définir la propriété CloudWatchroLearn séparément pour chaque Région AWS dans laquelle vous souhaitez activer CloudWatch Logs.

Si vous recevez une erreur lors de la configuration de l’ARN de rôle IAM, vérifiez les paramètres de votre compte AWS Security Token Service pour vous assurer que AWS STS est activé dans la Région que vous utilisez. Pour en savoir plus sur l’activation de AWS STS, consultez Gestion d’AWS STS dans une région AWS dans le Guide de l’utilisateur IAM.

Configuration de la journalisation de l’API CloudWatch à l’aide de la console API Gateway

Pour configurer la journalisation d’API CloudWatch, vous devez avoir déployé l’API jusqu’à une étape. Vous devez également avoir configuré un ARN de rôle CloudWatch Logs approprié pour votre compte.

API Gateway est maintenant prêt à enregistrer les demandes adressées à votre API. Vous n’avez pas besoin de redéployer l’API lorsque vous mettez à jour les paramètres de l’étape, les journaux ou variables de l’étape.

Configurez la journalisation de l’API CloudWatch à l’aide de AWS CloudFormation

Utilisez le modèle d’exemple AWS CloudFormation suivant pour créer un groupe de journaux Amazon CloudWatch Logs et configurer la journalisation de l’exécution et des accès pour une étape. Pour activer CloudWatch Logs, vous devez accorder l’autorisation API Gateway pour lire et écrire les journaux dans CloudWatch pour votre compte. Pour en savoir plus, consultez Associer le compte au rôle IAM dans le Guide de l’utilisateur AWS CloudFormation.

  TestStage:
    Type: AWS::ApiGateway::Stage
    Properties:
      StageName: test
      RestApiId: !Ref MyAPI
      DeploymentId: !Ref Deployment
      Description: "test stage description"
      MethodSettings:
        - ResourcePath: "/*"
          HttpMethod: "*"
          LoggingLevel: INFO
      AccessLogSetting:
        DestinationArn: !GetAtt MyLogGroup.Arn
        Format: $context.extendedRequestId $context.identity.sourceIp $context.identity.caller $context.identity.user [$context.requestTime] "$context.httpMethod $context.resourcePath $context.protocol" $context.status $context.responseLength $context.requestId
  MyLogGroup:
    Type: AWS::Logs::LogGroup
    Properties:
      LogGroupName: !Join
        - '-'
        - - !Ref MyAPI
          - access-logs