Instrumentieren von eingehenden HTTP-Anforderungen mit dem X-Ray-SDK SDK for Go

Sie können mit dem X-Ray-SDK eingehende HTTP-Anforderungen verfolgen, die Ihre Anwendung auf einer EC2 Instance in Amazon EC2 verarbeitet.AWS Elastic Beanstalkoder Amazon ECS.

Verwenden Sie xray.Handler, um eingehende HTTP-Anforderungen zu instrumentieren. Das X-Ray-SDK SDK for Go implementiert die Standard-Go-Bibliothekhttp.Handler-Schnittstelle imxray.HandlerKlasse zum Abfangen von Webanfragen. Die xray.Handler-Klasse umschließt den bereitgestellten http.Handler mit xray.Capture, wobei der Anfragekontext genutzt, eingehende Header analysiert und bei Bedarf Antwort-Header hinzugefügt werden, und legt HTTP-spezifische Ablaufverfolgungsfelder fest.

Wenn Sie diese Klasse zur Verarbeitung von HTTP-Anforderungen und -Antworten verwenden, erzeugt das X-Ray-SDK SDK for Go ein Segment für jede gesampelte Anfrage. Dieses Segment umfasst Dauer, Methode und Status der HTTP-Anforderung. Die zusätzliche Instrumentierung schafft Untersegmente zu diesem Segment.

Anmerkung

FürAWS Lambdafür jede gesampelte Anfrage erzeugt Lambda ein Segment. Weitere Informationen finden Sie unter AWS Lambda und AWS X-Ray.

Das folgende Beispiel fängt Anfragen auf Port 8000 ab und gibt "Hello!" als Antwort zurück. Es erzeugt das Segment myApp und instrumentiert Aufrufe über jede beliebige Anwendung.

Beispiel main.go

func main() {
  http.Handle("/", xray.Handler(xray.NewFixedSegmentNamer("MyApp"), http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello!"))
  })))

  http.ListenAndServe(":8000", nil)
}

Jedes Segment hat einen Namen, der Ihre Anwendung in der Service-Map identifiziert. Das Segment kann statisch benannt werden, oder Sie können das SDK so konfigurieren, dass es basierend auf dem Host-Header in der eingehenden Anforderung dynamisch benennt. Mit der dynamischen Benennung können Sie Traces basierend auf dem Domänennamen in der Anforderung gruppieren und einen Standardnamen anwenden, wenn der Name nicht mit einem erwarteten Muster übereinstimmt (z. B. wenn der Host-Header gefälscht ist).

Weitergeleitete Anfragen

Wenn ein Load Balancer oder ein anderer Vermittler eine Anfrage an Ihre Anwendung weiterleitet, übernimmt X-Ray die Client-IP von derX-Forwarded-ForHeader in der Anforderung statt von der Quell-IP im IP-Paket. Die Client-IP, die für eine weitergeleitete Anfrage aufgezeichnet wird, kann gefälscht werden und sollte daher nicht vertrauenswürdig sein.

Wenn eine Anforderung weitergeleitet wird, legt das SDK ein zusätzliches Feld im Segment fest, um dies anzugeben. Wenn das Segment das Feld enthältx_forwarded_foreingestellt auftruewurde die Client-IP von derX-Forwarded-ForHeader in der HTTP-Anforderung.

Der Handler erzeugt für jede eingehende Anfrage ein Segment mit einem http-Block mit folgenden Informationen:

• HTTP method (HTTP-Methode)— HOLEN, POSTEN, PUTEN, LÖSCHEN usw.

• Client-Adresse— Die IP-Adresse des Clients, der die Anforderung gesendet hat.

• Antwortcode— Der HTTP-Antwortcode für die abgeschlossene Anfrage.

• Timing— Die Startzeit (zu der die Anforderung empfangen wurde) und die Endzeit (zu der die Antwort gesendet wurde).

• Benutzer-Agent— Dieuser-agentaus der Anfrage.

• Inhaltslänge— Diecontent-lengthaus der Antwort.

Konfiguration einer Segmentbenennungsstrategie

AWS X-Rayverwendet einService-Nameum Ihre Anwendung zu identifizieren und von den anderen Anwendungen, Datenbanken, externen APIs zu unterscheiden undAWS-Ressourcen, die Ihre Anwendung verwendet. Wenn das X-Ray SDK Segmente für eingehende Anfragen generiert, zeichnet es den Dienstnamen Ihrer Anwendung im Segment aufName-Feldaus.

Das X-Ray SDK kann Segmente nach dem Hostnamen im HTTP-Anforderungsheader benennen. Dieser Header kann jedoch gefälscht werden, was zu unerwarteten Knoten in Ihrer Service-Map führen kann. Um zu verhindern, dass das SDK Segmente aufgrund von Anforderungen mit gefälschten Host-Headern falsch benennt, müssen Sie einen Standardnamen für eingehende Anfragen angeben.

Wenn Ihre Anwendung Anfragen für mehrere Domänen bereitstellt, können Sie das SDK so konfigurieren, dass es eine dynamische Benennungsstrategie verwendet, die dies in Segmentnamen widerspiegelt. Eine dynamische Benennungsstrategie ermöglicht es dem SDK, den Hostnamen für Anfragen zu verwenden, die einem erwarteten Muster entsprechen, und den Standardnamen auf Anfragen anzuwenden, die dies nicht tun.

Sie haben beispielsweise möglicherweise eine einzige Anwendung, die Anforderungen an drei Subdomains verarbeitet.www.example.com,api.example.com, undstatic.example.comaus. Sie können eine dynamische Benennungsstrategie mit dem Muster verwenden*.example.comum Segmente für jede Subdomain mit einem anderen Namen zu identifizieren, was zu drei Serviceknoten auf der Service-Map führt. Wenn Ihre Anwendung Anfragen mit einem Hostnamen erhält, der nicht mit dem Muster übereinstimmt, wird auf der Service-Map ein vierter Knoten mit einem von Ihnen angegebenen Fallback-Namen angezeigt.

Wenn Sie denselben Namen für alle Anfragesegmente verwenden möchten, geben Sie bei der Erstellung des Handlers den Namen Ihrer Anwendung ein, wie im vorherigen Abschnitt gezeigt.

Anmerkung

Sie können den mit der AWS_XRAY_TRACING_NAME-Umgebungsvariablen in Code definierten standardmäßigen Dienstnamen überschreiben.

Eine dynamische Benennungsstrategie definiert ein Muster, dem Hostnamen entsprechen sollten, sowie einen Standardnamen, der verwendet wird, wenn der Hostname in der HTTP-Anforderung nicht mit diesem Muster übereinstimmt. Um Segmente dynamisch zu benennen, verwenden Sie NewDynamicSegmentNamer zur Konfiguration des Standardnamens und Musters zum Abgleich.

Beispiel main.go

Wenn der Hostname in der Anforderung dem Muster *.example.com entspricht, verwenden Sie den Hostnamen. Verwenden Sie andernfalls MyApp.

func main() {
  http.Handle("/", xray.Handler(xray.NewDynamicSegmentNamer("MyApp", "*.example.com"), http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello!"))
  })))

  http.ListenAndServe(":8000", nil)
}