View a markdown version of this page

Activer les messages de débogage - Amazon Bedrock AgentCore
Exemples de réponses de passerelle avec le débogage activé et désactivé

Activer les messages de débogage

Pendant le développement de votre passerelle, vous pouvez activer les messages de débogage pour renvoyer des informations détaillées sur les problèmes de configuration de la cible, notamment les erreurs de fonction lambda, les erreurs d'autorisation de sortie, les erreurs de validation des paramètres de spécification cible. Après avoir activé les messages de débogage, si un problème survient lorsque vous appelez votre passerelle, la réponse renverra des messages pour vous aider à effectuer le débogage.

Pour activer les messages de débogage, effectuez l'une des opérations suivantes :

  • Si vous utilisez la AgentCore CLI pour créer une passerelle, le débogage est automatiquement activé.

  • Si vous utilisez la console AWS de gestion pour créer une passerelle, le débogage est activé par défaut. L'option se trouve sous Configurations supplémentaires dans la section Détails de la passerelle.

  • Si vous utilisez la AWS CLI ou un AWS SDK, définissez la exceptionLevel valeur comme DEBUG lorsque vous faites une UpdateGatewaydemande CreateGatewayou.

Lorsque vous avez terminé de déboguer votre passerelle, vous pouvez la mettre à jour pour désactiver les messages de débogage, de telle sorte que le message envoyé à l'utilisateur final n'affiche qu'une erreur interne non spécifiée.

Pour désactiver les messages de débogage, effectuez l'une des opérations suivantes :

  • Dans la console AWS de gestion, développez Configurations supplémentaires dans la section Détails de la passerelle lorsque vous créez ou modifiez une passerelle et décochez la case à côté de Débogage au niveau des exceptions.

  • Dans la AWS CLI ou dans un AWS SDK, omettez le exceptionLevel champ lorsque vous faites une UpdateGateway demande CreateGateway ou demandez de désactiver le débogage.

Exemples de réponses de passerelle avec le débogage activé et désactivé

Supposons par exemple que l'utilisateur ne soit pas autorisé à invoquer une fonction Lambda ciblée par la passerelle. Une requête qui appelle cette fonction renverra un message différent selon que le débogage est activé ou non :

  • Débogage activé — Un message d'erreur détaillé serait renvoyé dans le text champ du contenu ainsi que dans le _meta champ de la réponse, comme dans l'exemple suivant :

    {
  "jsonrpc": "2.0",
  "id": 24,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "Access denied while invoking Lambda function arn:aws:lambda:us-west-2:123456789012:function:TestGatewayLambda. Check the permissions on the Lambda function and Gateway execution role, and retry the request."
      }
    ],
    "_meta": {
      "debug": {
        "type": "text",
        "text": "Access denied while invoking Lambda function arn:aws:lambda:us-west-2:123456789012:function:TestGatewayLambda. Check the permissions on the Lambda function and Gateway execution role, and retry the request."
      }
    },
    "isError": true
  }
}

  • Débogage désactivé — Un message d'erreur générique serait renvoyé dans le text champ de contenu de la réponse, comme dans l'exemple suivant :

    {
  "jsonrpc": "2.0",
  "id": 24,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "An internal error occurred. Please retry later."
      }
    ],
    "isError": true
  }
}