sam logs

Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)sam logs.

Pour une introduction à la AWS SAMCLI, voirQu'est-ce que c'est AWS SAMCLI ?.

La sam logs commande récupère les journaux générés par vos AWS Lambda fonctions.

Utilisation

$ sam logs <options>

Options

--config-env TEXT

Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez Fichier de configuration CLI AWS SAM.

--config-file PATH

Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez Fichier de configuration CLI AWS SAM.

--cw-log-group LIST

Inclut les CloudWatch journaux des groupes de journaux que vous spécifiez. Si vous spécifiez cette option avecname, AWS SAM inclut les journaux des groupes de journaux spécifiés en plus des journaux des ressources nommées.

--debug

Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages.

---end-time, e TEXT

Récupère les journaux jusqu’à ce moment. L'heure peut être des valeurs relatives comme « il y a 5 minutes », « hier », ou un horodatage formaté comme « 2018-01-01 10:10:10 ».

--filter TEXT

Vous permet de spécifier une expression pour rechercher rapidement des journaux qui correspondent à des termes, des phrases ou des valeurs dans les journaux d’événements. Il peut s'agir d'un simple mot clé (par exemple, « erreur ») ou d'un modèle pris en charge par Amazon CloudWatch Logs. Pour connaître la syntaxe, consultez la documentation Amazon CloudWatch Logs.

--help

Affiche ce message, puis se ferme.

--include-traces

Inclut des traces X-Ray dans la sortie du journal.

--name, -n TEXT

Le nom de la ressource pour laquelle vous souhaitez récupérer des journaux. Si cette ressource fait partie d'une AWS CloudFormation pile, il peut s'agir de l'ID logique de la ressource fonctionnelle dans le AWS SAM modèle AWS CloudFormation/. Plusieurs noms peuvent être fournis en répétant à nouveau le paramètre. Si la ressource se trouve dans une pile imbriquée, le nom peut être précédé du nom de la pile imbriquée pour extraire les journaux de cette ressource (/). NestedStackLogicalId ResourceLogicalId Si le nom de la ressource n'est pas fourni, la pile donnée sera analysée et les informations de journal seront extraites pour toutes les ressources prises en charge. Si vous ne spécifiez pas cette option, AWS SAM extrait les journaux de toutes les ressources de la pile que vous spécifiez. Les types de ressources suivants sont pris en charge :

• AWS::Serverless::Function

• AWS::Lambda::Function

• AWS::Serverless::Api

• AWS::ApiGateway::RestApi

• AWS::Serverless::HttpApi

• AWS::ApiGatewayV2::Api

• AWS::Serverless::StateMachine

• AWS::StepFunctions::StateMachine

--output TEXT

Spécifie le format de sortie pour les journaux. Pour imprimer des journaux formatés, spécifiez text. Pour imprimer les journaux au format JSON, spécifiez json.

--profile TEXT

Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification.

--region TEXT

AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1.

--save-params

Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration.

--stack-name TEXT

Nom de la AWS CloudFormation pile dont fait partie la ressource.

--start-time, -s TEXT

Récupère les journaux à partir de ce moment. L'heure peut être des valeurs relatives comme « il y a 5 minutes », « hier », ou un horodatage formaté comme « 2018-01-01 10:10:10 ». La valeur par défaut est « il y a 10 minutes ».

--tail, -t

Suit la sortie du journal. Cela ignore l’argument de fin d’heure et continue de récupérer les journaux à mesure qu’ils deviennent disponibles.

Exemples

Lorsque vos fonctions font partie d'une AWS CloudFormation pile, vous pouvez récupérer les journaux en utilisant l'identifiant logique de la fonction lorsque vous spécifiez le nom de la pile.

$ sam logs -n HelloWorldFunction --stack-name myStack

Consultez les journaux pour une plage de temps spécifique à l'aide des options -s (--start-time) et -e (--end-time).

$ sam logs -n HelloWorldFunction --stack-name myStack -s '10min ago' -e '2min ago'

Vous pouvez également ajouter la --tail possibilité d'attendre les nouveaux journaux et de les voir à leur arrivée.

$ sam logs -n HelloWorldFunction --stack-name myStack --tail

Utilisez --filter cette option pour trouver rapidement les journaux correspondant aux termes, expressions ou valeurs de vos événements de journal.

$ sam logs -n HelloWorldFunction --stack-name myStack --filter "error"

Consultez les journaux d'une ressource dans une pile enfant.

$ sam logs --stack-name myStack -n childStack/HelloWorldFunction

Journaux de suivi de toutes les ressources prises en charge dans votre application.

$ sam logs --stack-name sam-app --tail

Récupérez les journaux d'une fonction Lambda et d'une API API Gateway spécifiques dans votre application.

$ sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi

Récupérez les journaux de toutes les ressources prises en charge dans votre application, ainsi que des groupes de journaux spécifiés.

$ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456