AWS X-Ray SDK für Ruby - AWS X-Ray

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS X-Ray SDK für Ruby

Das X-Ray-SDK ist eine Bibliothek für Ruby-Webanwendungen, die Klassen und Methoden zum Generieren und Senden von Ablaufverfolgungsdaten zum X-Ray-Daemon bereitstellt. Ablaufverfolgungsdaten umfassen Informationen zu eingehenden HTTP-Anforderungen, die von der Anwendung beantwortet werden, sowie Aufrufe, die die Anwendung an nachgelagerte Services mithilfe desAWSSDK, HTTP-Clients oder ein aktiver Datensatz-Client. Sie können Segmente auch manuell erstellen und Debug-Informationen Anmerkungen und Metadaten hinzufügen.

Sie können das SDK herunterladen, indem Sie es Ihrer Gemfile-Datei hinzufügen und bundle install ausführen.

Beispiel Gemfile

gem 'aws-sdk'

Wenn Sie Rails verwenden, beginnen Sie damitHinzufügen der X-Ray-SDK-Middlewareum eingehende Anfragen nachverfolgen zu können. Ein Anforderungsfilter erstellt ein Segment. Während das Segment geöffnet ist, können Sie die SDK-Client-Methoden nutzen, um dem Segment Informationen hinzuzufügen, Untersegmente zu erstellen und nachgelagerte Aufrufe rückzuverfolgen. Das SDK erfasst auch automatisch Ausnahmen, die Ihre Anwendung ausgibt, während das Segment geöffnet ist. Bei anderen Anwendungen als Rails können Sie Segmente manuell erstellen.

Verwenden Sie als Nächstes das X-Ray-SDK zur Instrumentierung IhrerAWS SDK for Ruby, HTTP- und SQL-Clients vonKonfigurieren des Recorder-Gerätsum die zugehörigen Bibliotheken zu patchen. Wann immer Sie einen Downstream anrufenAWSService oder Ressource mit einem instrumentierten Client erfasst das SDK Informationen über den Aufruf in einem Untersegment.AWS-Services und die Ressourcen, auf die Sie innerhalb der Services zugreifen, erscheinen in der Service-Übersicht als nachgelagerte Knoten, um Ihnen bei der Identifikation von Fehlern und der Ablehnung von Problemen mit individuellen Verbindungen zu helfen.

Sobald Sie die ersten Schritte mit dem SDK gemacht haben, können Sie das Verhalten durch die Konfiguration des Recorders individualisieren. Sie können Plugins zum Festhalten von Daten über die Datenverarbeitungsressourcen, auf denen Ihre Anwendung ausgeführt wird, hinzufügen, das Samplingverhalten durch Samplingregeln anpassen und einen Logger bereitstellen, um mehr oder weniger Informationen von dem SDK in Ihren Anwendungsprotokollen zu sehen.

Zeichnen Sie zusätzliche Informationen zu Anforderungen und den Aufgaben, die Ihre Anwendung ausführt, in Anmerkungen und Metadaten auf. Anmerkungen sind einfache Schlüsselwertpaare, die für die Verwendung mit Filterausdrücken indiziert werden, damit Sie nach Ablaufverfolgen mit bestimmten Daten suchen können. Metadateneinträge sind weniger einschränkend und können ganze Objekte und Arrays aufzeichnen – alle Daten, die in eine JSON zusammengefasst werden können.

Anmerkungen und Metadaten

Anmerkungen und Metadaten sind beliebiger Text, den Sie Segmenten mit dem X-Ray-SDK hinzufügen. Anmerkung werden für die Verwendung mit Filterausdrücken indiziert. Metadaten werden nicht indiziert, können aber im Rohsegment mit der X-Ray-Konsole oder API angezeigt werden. Jeder, dem Sie Lesezugriff auf X-Ray gewähren, kann diese Daten anzeigen.

Wenn Sie viele instrumentierten Clients in Ihrem Code haben, kann ein einzelnes Anforderungssegmente viele Untersegmente enthalten, eines für jeden Aufruf mit einem instrumentierten Client. Sie können Untersegmente organisieren und gruppieren, indem Sie Client-Aufrufe in benutzerdefinierten Untersegmenten zusammenfassen. Sie können ein benutzerdefiniertes Untersegment für eine ganze Funktion oder eine Code-Abschnitt erstellen und Metadaten und Anmerkungen im Untersegment festhalten, anstatt alles im übergeordneten Segment aufzuzeichnen.

Die Referenzdokumentation zu den SDK-Klassen und -Methoden finden Sie unterAWS X-RayReferenz zu SDK for Ruby Ruby-APIaus.

Voraussetzungen

Das X-Ray-SDK erfordert Ruby 2.3 oder höher und ist kompatibel mit den folgenden Bibliotheken:

  • AWS SDK for Ruby-Version 3.0 oder höher

  • Rails Version 5.1 oder höher