502 Bad Gateway – TooBigHeaders

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

Symptom

Die Clientanwendung erhält den HTTP-Statuscode 502 Bad Gateway mit Fehlercode protocol.http.TooBigHeaders als Antwort auf API Aufrufe.

Fehlermeldung

Die Clientanwendung erhält den folgenden Antwortcode:

HTTP/1.1 502 Bad Gateway

Außerdem wird möglicherweise die folgende Fehlermeldung angezeigt:

{
   "fault":{
      "faultstring":"response headers size exceeding 25,600",
      "detail":{
         "errorcode":"protocol.http.TooBigHeaders"
      }
   }
}

Mögliche Ursachen

Dieser Fehler tritt auf, wenn die Gesamtgröße der Header, die vom Ziel-/Backend Server als Teil der HTTP-Antwort an Apigee Edge gesendet werden, das zulässige zulässige Limit in Apigee Edge überschreitet.

Mögliche Ursachen für diesen Fehler:

Allgemeine Diagnoseschritte

Verwenden Sie eines der folgenden Tools/Verfahren, um diesen Fehler zu diagnostizieren:

Ursache: Die Größe der Header in der Antwort überschreitet das zulässige Limit.

Diagnose

1. Ermitteln Sie den Fehlercode, die Fehlerquelle und die Größe der Antwortnutzlast für den beobachteten Fehler mithilfe des API-Monitorings, des Trace-Tools oder der NGINX-Zugriffsprotokolle, wie unter Allgemeine Diagnoseschritte beschrieben.
2. Wenn die Fehlerquelle den Wert target hat, bedeutet das, dass die Antwort, die vom Ziel-/Backend-Server an Apigee gesendet wurde, Header enthält, deren Größe das zulässige Limit in Apigee Edge überschreitet.
3. Sie können mit einer der folgenden Methoden prüfen, ob die Antwort vom Ziel-/Backend-Server Header enthält, deren Größe das zulässige Limit überschreitet:

   Fehlermeldung

   So prüfen Sie die Inhaberschaft einer Property mit einer Fehlermeldung:

   Wenn Sie Zugriff auf die vollständige Fehlermeldung haben, die Sie von Apigee Edge erhalten haben, dann sehen Sie sich den faultstring an. Der faultstring gibt an, dass die Größe des Antwortheaders das zulässige Limit überschritten hat.

   Beispiel für eine Fehlermeldung:

   "faultstring":"response headers size exceeding 25,600"

   Beachten Sie in der obigen Fehlermeldung im faultstring, dass die Antwort Header enthält, deren Gesamtgröße das zulässige Limit überschreitet.

   Tatsächliche Anfrage

   So prüfen Sie die Inhaberschaft einer Property mit der tatsächlichen Anfrage:

   Wenn Sie Zugriff auf die tatsächliche Anfrage haben, die an den Ziel-/Backend-Server gesendet wurde, führen Sie die folgenden Schritte aus:

   1. Wenn Sie Nutzer der Public Cloud/Private Cloud sind, stellen Sie eine Anfrage direkt an den Backend-Server vom Backend-Server selbst oder von einem anderen Computer aus, von dem aus Sie die Anfrage an den Backend-Server senden dürfen.
   2. Wenn Sie Nutzer der Private Cloud sind, können Sie die Anfrage auch von einem der Message Processors an den Backend-Server senden.
   3. Untersuchen Sie die vom Backend-Server empfangene Antwort und berechnen und prüfen Sie insbesondere die Gesamtgröße der in der Antwort übergebenen Header.

   4. Wenn Sie feststellen, dass die Größe der Header in der Antwortnutzlast das zulässige Limit in Apigee Edge überschreitet, ist dies die Ursache des Problems.

      Beispielantwort vom Zielserver:

      curl -v https://TARGET_SERVER_HOST/test
      

      * About to connect() to 10.1.0.10 port 9000 (#0)
      *   Trying 10.1.0.10...
      * Connected to 10.1.0.10 (10.1.0.10) port 9000 (#0)
      > GET /test HTTP/1.1
      > User-Agent: curl/7.29.0
      > Host: 10.1.0.10:9000
      > Accept: */*
      <
      < HTTP/1.1 200 OK
      < Accept-Ranges: bytes
      < Content-Length: 0
      < Content-Type: text/plain; charset=utf-8
      < Last-Modified: Tue, 20 Jul 2021 09:23:56 GMT
      < Testheader1: XVlBzgba—-<snipped>---THctcuAx
      < Testheader2: hxKQFDaFpLSj—-<snipped>---FbcXoEFfRsWxP
      < Date: Fri, 23 Jul 2021 09:51:22 GMT
      <
      * Connection #0 to host 10.1.0.10 left intact
      

      Im obigen Beispiel haben Testheader1 und Testheader2 größere Größen, was die Ursache für diesen Fehler ist, da das zulässige Limit in Apigee Edge überschritten wird.

   Message Processor-Logs

   So prüfen Sie die Inhaberschaft einer Property mit Message Processor-Logs:

   Wenn Sie Nutzer der Private Cloud sind, können Sie Message Processor-Logs verwenden, um zu prüfen, ob die Größe der Antwortheader das zulässige Limit in Apigee Edge überschritten hat.

   1. Prüfen Sie die Message Processor-Logs:

      /opt/apigee/var/log/edge-message-processor/logs/system.log

   2. Suchen Sie nach 502-Fehlern in einem bestimmten Zeitraum (wenn das Problem in der Vergangenheit aufgetreten ist) oder nach Anfragen, die immer noch mit 502 fehlschlagen. Sie können die folgende Suchanfrage verwenden:

      grep -ri "response headers size exceeding"
      

   3. Sie finden Zeilen aus system.log, die den folgenden ähneln. Die Größe der Antwortheader kann in Ihrem Fall variieren:

      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest rev:1
      messageid:r23ijb1b-1  NIOThread@1 ERROR HTTP.CLIENT -
      HTTPClient$Context$3.onException() :  ClientChannel[Connected:
      Remote:3.7.1.1:9000 Local:192.168.2.1:56098]@8414 useCount=1
      bytesRead=0 bytesWritten=207 age=640ms  lastIO=0ms  isOpen=true.onExceptionRead
      exception: {}
      com.apigee.errors.http.server.BadGateway: response headers size exceeding 25,600
      
      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest
      rev:1 messageid:r23ijb1b-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError
      (HTTPResponse@31f3ef88, response headers size exceeding 25,600)

   4. Sobald der Message Processor die Antwort vom Backend-/Ziel server erhält und feststellt, dass die Gesamtgröße der Header 25 KB überschreitet, wird der Vorgang beendet und der folgende Fehler ausgelöst:

      response headers size exceeding 25,600

      Das bedeutet, dass die Gesamtgröße des Headers mehr als 25 KB beträgt und Apigee den Fehler auslöst, wenn die Größe das Limit von 25 KB mit dem Fehlercode als protocol.http.TooBigHeaders überschreitet.

Auflösung

Limits

Apigee erwartet, dass die Clientanwendung und der Backend-Server keine Headergrößen senden, die das zulässige Limit überschreiten, wie unter Größe von Anfrage-/Antwortheadern in Apigee Edge-Limits dokumentiert.

1. Wenn Sie Nutzer der Public Cloud sind, gilt das in Apigee Edge-Limits unter Größe von Anfrage-/Antwortheadern dokumentierte Limit für die Größe von Anfrage- und Antwortheadern.
2. Wenn Sie Nutzer der Private Cloud sind, haben Sie möglicherweise das Standardlimit für die Größe von Anfrage- und Antwortheadern geändert (obwohl dies nicht empfohlen wird). Sie können das Limit für die maximale Größe von Antwortheadern ermitteln, indem Sie die Anleitung unter Aktuelles Limit prüfen befolgen.

Aktuelles Limit prüfen

In diesem Abschnitt wird erläutert, wie Sie prüfen, ob die Property HTTPResponse.headers.limit mit einem neuen Wert auf den Message Processors aktualisiert wurde.

1. Suchen Sie auf dem Message Processor-Computer im Verzeichnis /opt/apigee/edge-message-processor/conf nach der Property HTTPResponse.headers.limit und prüfen Sie, welcher Wert festgelegt wurde, wie unten dargestellt:

   grep -ri "HTTPResponse.headers.limit" /opt/apigee/edge-message-processor/conf
   

2. Das Beispielergebnis des obigen Befehls sieht so aus:

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPResponse.headers.limit=25k

3. Beachten Sie in der obigen Beispielausgabe, dass die Property HTTPResponse.headers.limit in http.properties auf den Wert 25k gesetzt wurde.

   Das bedeutet, dass das in Apigee für Private Cloud konfigurierte Limit für die Größe der Antwortnutzlast 25 KB beträgt.

Wenn Sie weiterhin Unterstützung vom Apigee-Support benötigen, gehen Sie zu Erfassen von Diagnoseinformationen erforderlich.

Erfassen von Diagnoseinformationen erforderlich

Erfassen Sie die folgenden Diagnoseinformationen und wenden Sie sich dann an den Apigee Edge-Support:

Wenn Sie Nutzer der Public Cloud sind, geben Sie die folgenden Informationen an:

• Name der Organisation
• Name der Umgebung
• Name des API-Proxys
• Vollständiger curl-Befehl, der zum Reproduzieren des Fehlers 502 verwendet wurde
• Trace-Datei für die API-Anfragen
• Vollständige Ausgabe der Antwort vom Ziel-/Backend-Server zusammen mit der Größe der Header

Wenn Sie Nutzer der Private Cloud sind, geben Sie die folgenden Informationen an:

• Vollständige Fehlermeldung für die fehlgeschlagenen Anfragen
• Name der Organisation
• Name der Umgebung
• API-Proxy-Bundle
• Trace-Datei für die fehlgeschlagenen API-Anfragen
• Vollständiger curl-Befehl, der zum Reproduzieren des Fehlers 502 verwendet wurde
• Vollständige Ausgabe der Antwort vom Ziel-/Backend-Server zusammen mit der Größe der Header

• NGINX-Zugriffsprotokolle /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Dabei werden: ORG, ENV und PORT# durch tatsächliche Werte ersetzt.

• Message Processor-Systemprotokolle /opt/apigee/var/log/edge-message-processor/logs/system.log