View a markdown version of this page

Debugging-Meldungen einschalten - Amazon Grundgestein AgentCore
Beispiel für Gateway-Antworten mit aktiviertem und deaktiviertem Debugging

Debugging-Meldungen einschalten

Während sich Ihr Gateway in der Entwicklung befindet, können Sie Debugging-Nachrichten aktivieren, um Details zu Problemen mit der Zielkonfiguration zurückzugeben, darunter Lambda-Funktionsfehler, Fehler bei der Autorisierung von Ausgangsdaten und Fehlern bei der Validierung von Zielspezifikationsparametern. Wenn nach dem Einschalten der Debugging-Nachrichten beim Aufrufen des Gateways ein Problem auftritt, gibt die Antwort Meldungen zurück, die Ihnen beim Debuggen helfen.

Gehen Sie wie folgt vor, um Debugging-Nachrichten zu aktivieren:

  • Wenn Sie die AgentCore CLI verwenden, um ein Gateway zu erstellen, wird das Debugging automatisch aktiviert.

  • Wenn Sie die AWS Management Console verwenden, um ein Gateway zu erstellen, ist das Debugging standardmäßig aktiviert. Die Option befindet sich im Abschnitt Gateway-Details unter Zusätzliche Konfigurationen.

  • Wenn Sie die AWS CLI oder ein AWS SDK verwenden, legen Sie den exceptionLevel Wert so fest, wie DEBUG Sie eine CreateGatewayUpdateGatewayOder-Anfrage stellen.

Wenn Sie mit dem Debuggen Ihres Gateways fertig sind, können Sie das Gateway so aktualisieren, dass Debugging-Nachrichten deaktiviert werden, sodass die Nachricht an den Endbenutzer nur einen nicht näher bezeichneten internen Fehler anzeigt.

Gehen Sie wie folgt vor, um das Debuggen von Nachrichten zu deaktivieren:

  • Erweitern Sie in der AWS Management Console im Abschnitt Gateway-Details den Bereich Zusätzliche Konfigurationen, wenn Sie ein Gateway erstellen oder bearbeiten, und deaktivieren Sie das Kontrollkästchen neben Debug auf Ausnahmeebene.

  • Lassen Sie in der AWS CLI oder einem AWS SDK das exceptionLevel Feld weg, wenn Sie eine CreateGateway UpdateGateway Oder-Anfrage zum Deaktivieren des Debuggings stellen.

Beispiel für Gateway-Antworten mit aktiviertem und deaktiviertem Debugging

Nehmen wir als Beispiel an, dass der Benutzer nicht berechtigt ist, eine Lambda-Funktion aufzurufen, auf die das Gateway abzielt. Eine Anfrage, die diese Funktion aufruft, würde je nachdem, ob das Debuggen aktiviert oder deaktiviert ist, eine andere Nachricht zurückgeben:

  • Debugging on — Eine detaillierte Fehlermeldung würde im text Inhaltsfeld und auch in dem _meta Feld in der Antwort zurückgegeben werden, wie im folgenden Beispiel:

    {
  "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
  }
}

  • Debugging off — In der Antwort würde eine generische Fehlermeldung im text Inhaltsfeld zurückgegeben werden, wie im folgenden Beispiel:

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