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. # Erste Schritte mit der Scorekeep-Beispielanwendung **Anmerkung** SDK/Daemon X-Ray-Wartungshinweis — Am 25. Februar 2026 wechselt das AWS X-Ray SDKs/Daemon in den Wartungsmodus, in dem die Versionen von X-Ray SDK und Daemon auf Sicherheitsprobleme beschränkt AWS werden. Weitere Informationen zum Zeitplan für den Support finden Sie unter. [Zeitplan für die Support von X-Ray SDK und Daemon](xray-sdk-daemon-timeline.md) Wir empfehlen die Migration zu OpenTelemetry. Weitere Informationen zur Migration zu OpenTelemetry finden Sie unter [Migration von X-Ray-Instrumentierung zu OpenTelemetry Instrumentierung](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html). In diesem Tutorial wird der `xray-gettingstarted` Zweig der [Scorekeep-Beispielanwendung](xray-scorekeep.md) verwendet CloudFormation , mit dem die Ressourcen erstellt und konfiguriert werden, mit denen die Beispielanwendung und der X-Ray-Daemon auf Amazon ECS ausgeführt werden. Die Anwendung verwendet das Spring-Framework, um eine JSON-Web-API AWS SDK für Java zu implementieren und Daten in Amazon DynamoDB zu speichern. Ein Servlet-Filter in der Anwendung instrumentiert alle eingehenden Anfragen, die von der Anwendung bedient werden, und ein Anforderungshandler auf dem AWS SDK-Client instrumentiert Downstream-Aufrufe an DynamoDB. Sie können diesem Tutorial entweder mit dem oder dem AWS-Managementkonsole folgen. AWS CLI **Topics** + [Voraussetzungen](#xray-gettingstarted-prereqs) + [Installieren Sie die Scorekeep-Anwendung mit CloudFormation](#xray-gettingstarted-deploy) + [Generieren von Ablaufverfolgungsdaten](#xray-gettingstarted-generate-traces) + [Sehen Sie sich die Trace-Map im AWS-Managementkonsole](#xray-gettingstarted-console) + [Konfigurieren von Amazon-SNS-Benachrichtigungen](#xray-gettingstarted-notifications) + [Erkunden der Beispielanwendung](#xray-gettingstarted-sample) + [Optional: Richtlinie für geringste Rechte](#xray-gettingstarted-security) + [Bereinigen](#xray-gettingstarted-cleanup) + [Nächste Schritte](#xray-gettingstarted-nextsteps) ## Voraussetzungen In diesem Tutorial werden CloudFormation die Ressourcen erstellt und konfiguriert, auf denen die Beispielanwendung und der X-Ray-Daemon ausgeführt werden. Für die Installation und Ausführung des Tutorials sind die folgenden Voraussetzungen erforderlich: 1. Wenn Sie einen IAM-Benutzer mit eingeschränkten Rechten verwenden, fügen Sie die folgenden Benutzerrichtlinien in der [IAM-Konsole](https://console.aws.amazon.com/iam) hinzu: + `AWSCloudFormationFullAccess`— für den Zugriff und die Nutzung CloudFormation + `AmazonS3FullAccess`— um eine Vorlagendatei hochzuladen, CloudFormation um die AWS-Managementkonsole + `IAMFullAccess`— um die Amazon ECS- und Amazon EC2 EC2-Instance-Rollen zu erstellen + `AmazonEC2FullAccess`— um die Amazon EC2 EC2-Ressourcen zu erstellen + `AmazonDynamoDBFullAccess`— um die DynamoDB-Tabellen zu erstellen + `AmazonECS_FullAccess`— um Amazon ECS-Ressourcen zu erstellen + `AmazonSNSFullAccess`— um das Amazon SNS SNS-Thema zu erstellen + `AWSXrayReadOnlyAccess`— für die Erlaubnis, die Trace-Map und die Traces in der X-Ray-Konsole anzusehen 1. Um das Tutorial mit dem auszuführen AWS CLI, [installieren Sie die CLI-Version](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) 2.7.9 oder höher und [konfigurieren Sie die CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config) mit dem Benutzer aus dem vorherigen Schritt. Stellen Sie sicher, dass die Region konfiguriert ist, wenn Sie das AWS CLI mit dem Benutzer konfigurieren. Wenn eine Region nicht konfiguriert ist, müssen Sie sie `--region AWS-REGION` an jeden CLI-Befehl anhängen. 1. Stellen Sie sicher, dass [Git](https://github.com/git-guides/install-git) installiert ist, um das Beispielanwendungs-Repo zu klonen. 1. Verwenden Sie das folgende Codebeispiel, um den `xray-gettingstarted` Zweig des Scorekeep-Repositorys zu klonen: ``` git clone https://github.com/aws-samples/eb-java-scorekeep.git xray-scorekeep -b xray-gettingstarted ``` ## Installieren Sie die Scorekeep-Anwendung mit CloudFormation ------ #### [ AWS-Managementkonsole ] **Installieren Sie die Beispielanwendung mit dem AWS-Managementkonsole** 1. Öffnen Sie die [CloudFormation-Konsole](https://console.aws.amazon.com/cloudformation/). 1. Wählen Sie **Stack erstellen** und dann im Drop-down-Menü die Option **Mit neuen Ressourcen** aus. 1. Wählen Sie im Abschnitt **Specify template (Vorlage angeben)** die Option **Upload a template file (Vorlagendatei hochladen)** aus. 1. Wähle „**Datei auswählen**“, navigiere zu dem `xray-scorekeep/cloudformation` Ordner, der beim Klonen des Git-Repositorys erstellt wurde, und wähle die `cf-resources.yaml` Datei aus. 1. Wählen Sie **Next** (Weiter), um fortzufahren. 1. Geben Sie den Text `scorekeep` in das Textfeld **Stack-Name** ein und wählen Sie dann unten auf der Seite **Weiter** aus, um fortzufahren. Beachten Sie, dass im Rest dieses Tutorials davon ausgegangen wird, dass der Stack benannt `scorekeep` ist. 1. Scrollen Sie zum Ende der Seite „**Stack-Optionen konfigurieren**“ und wählen Sie **Weiter**, um fortzufahren. 1. **Scrollen Sie zum Ende der **Überprüfungsseite**, aktivieren Sie das Kontrollkästchen zur Bestätigung, dass CloudFormation möglicherweise IAM-Ressourcen mit benutzerdefinierten Namen erstellt werden, und wählen Sie Stack erstellen aus.** 1. Der CloudFormation Stack wird jetzt erstellt. Der Stack-Status wird `CREATE_IN_PROGRESS` etwa fünf Minuten lang angezeigt, bevor er zu wechselt`CREATE_COMPLETE`. Der Status wird regelmäßig aktualisiert, oder Sie können die Seite aktualisieren. ------ #### [ AWS CLI ] **Installieren Sie die Beispielanwendung mit dem AWS CLI** 1. Navigieren Sie zu dem `cloudformation` Ordner des `xray-scorekeep` Repositorys, den Sie zuvor im Tutorial geklont haben: ``` cd xray-scorekeep/cloudformation/ ``` 1. Geben Sie den folgenden AWS CLI Befehl ein, um den CloudFormation Stack zu erstellen: ``` aws cloudformation create-stack --stack-name scorekeep --capabilities "CAPABILITY_NAMED_IAM" --template-body file://cf-resources.yaml ``` 1. Warten Sie`CREATE_COMPLETE`, bis der CloudFormation Stack-Status lautet. Dies dauert etwa fünf Minuten. Verwenden Sie den folgenden AWS CLI Befehl, um den Status zu überprüfen: ``` aws cloudformation describe-stacks --stack-name scorekeep --query "Stacks[0].StackStatus" ``` ------ ## Generieren von Ablaufverfolgungsdaten Die Beispielanwendung enthält eine Front-End-Webanwendung. Verwenden Sie die Web-App, um Traffic zur API zu generieren und Trace-Daten an X-Ray zu senden. Rufen Sie zunächst die URL der Web-App mit dem AWS-Managementkonsole oder dem ab AWS CLI: ------ #### [ AWS-Managementkonsole ] **Suchen Sie die Anwendungs-URL mit dem AWS-Managementkonsole** 1. Öffnen Sie die [CloudFormation-Konsole](https://console.aws.amazon.com/cloudformation/). 1. Wählen Sie den `scorekeep` Stapel aus der Liste aus. 1. Wählen Sie auf der `scorekeep` Stack-Seite den Tab **Outputs** und anschließend den `LoadBalancerUrl` URL-Link, um die Webanwendung zu öffnen. ------ #### [ AWS CLI ] **Suchen Sie die Anwendungs-URL mithilfe des AWS CLI** 1. Verwenden Sie den folgenden Befehl, um die URL der Webanwendung anzuzeigen: ``` aws cloudformation describe-stacks --stack-name scorekeep --query "Stacks[0].Outputs[0].OutputValue" ``` 1. Kopieren Sie diese URL und öffnen Sie sie in einem Browser, um die Scorekeep-Webanwendung anzuzeigen. ------ **Verwenden Sie die Webanwendung, um Trace-Daten zu generieren** 1. Wählen Sie **Create** aus, um einen Benutzer und eine Sitzung zu erstellen. 1. Geben Sie einen **Game Name** ein, legen Sie die **Rules** auf **Tic Tac Toe** fest und wählen Sie anschließend **Create** aus, um ein Spiel zu erstellen. 1. Wählen Sie **Play**, um das Spiel zu starten. 1. Wählen Sie eine Kachel, um einen Spielzug zu machen, und ändern Sie den Spielestatus. Jeder dieser Schritte generiert HTTP-Anfragen an die API und Downstream-Aufrufe an DynamoDB, um Benutzer-, Sitzungs-, Spiel-, Bewegungs- und Statusdaten zu lesen und zu schreiben. ## Sehen Sie sich die Trace-Map im AWS-Managementkonsole Sie können die Trace-Map und die von der Beispielanwendung generierten Traces im X-Ray und in den CloudWatch Konsolen sehen. ------ #### [ X-Ray console ] **Verwenden Sie die X-Ray-Konsole** 1. Öffnen Sie die Trace-Map-Seite der [X-Ray-Konsole](https://console.aws.amazon.com/xray/home#/service-map). 1. Die Konsole zeigt eine Darstellung des Service-Graphen, den X-Ray aus den von der Anwendung gesendeten Trace-Daten generiert. Achten Sie darauf, den Zeitraum der Trace-Map bei Bedarf anzupassen, um sicherzustellen, dass alle Traces seit dem ersten Start der Webanwendung angezeigt werden. ![\[Zeitraum der Röntgen-Trace-Map\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/xray-console-time-period-15-minutes.png) Die Trace-Map zeigt den Web-App-Client, die in Amazon ECS ausgeführte API und jede DynamoDB-Tabelle, die die Anwendung verwendet. Jede Anforderung an die Anwendung, bis zu einer konfigurierbaren Höchstanzahl von Anforderungen pro Sekunde, wird verfolgt, und zwar wie sie auf die API trifft, Anforderungen an nachgelagerte Services generiert und abgeschlossen wird. Sie können jeden Knoten in der Service-Grafik wählen, um Ablaufverfolgungen für Anforderungen anzusehen, die Datenverkehr zu diesem Knoten generiert haben. Derzeit ist der Amazon SNS SNS-Knoten gelb. Zeigen Sie die Details an, um herauszufinden, warum. ![\[Trace-Map-Seite für die X-Ray-Konsole\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-servicemap-before-ECS.png) **So finden Sie die Ursache des Fehlers** 1. Wählen Sie den Knoten mit dem Namen **SNS**. Das Fenster mit den Knotendetails wird angezeigt. 1. Wählen Sie **View traces (Ablaufverfolgungen anzeigen)**, um auf den Bildschirm **Trace overview (Ablaufverfolgungsübersicht)** zuzugreifen. 1. Wählen Sie die Nachverfolgung aus der **Trace list**. Diese Ablaufverfolgung verfügt über keine Methode oder URL, da sie während des Startups und nicht als Reaktion auf eine eingehende Anforderung aufgezeichnet wurde. ![\[Wählen einer Ablaufverfolgung aus der Ablaufverfolgungsliste\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-tracelist-sns.png) 1. Wählen Sie das Fehlerstatussymbol im Amazon SNS SNS-Segment unten auf der Seite, um die Seite **Ausnahmen** für das SNS-Subsegment zu öffnen. ![\[Wählen Sie das Fehlerstatussymbol, um die Seite Ausnahmen für das Amazon SNS SNS-Subsegment zu öffnen.\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-timeline-sns-ecs.png) 1. Das X-Ray SDK erfasst automatisch Ausnahmen, die von instrumentierten AWS SDK-Clients ausgelöst werden, und zeichnet den Stack-Trace auf. ![\[Registerkarte "Exceptions (Ausnahmen)" mit erfassten Ausnahmen und aufgezeichneter Stack-Ablaufverfolgung\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-exception.png) ------ #### [ CloudWatch console ] **Verwenden Sie die Konsole CloudWatch** 1. Öffnen Sie die [X-Ray-Trace-Map-Seite](https://console.aws.amazon.com/cloudwatch/home#xray:service-map/map) der CloudWatch Konsole. 1. Die Konsole zeigt eine Darstellung des Service-Graphen, den X-Ray aus den von der Anwendung gesendeten Trace-Daten generiert. Achten Sie darauf, den Zeitraum der Trace-Map bei Bedarf anzupassen, um sicherzustellen, dass alle Traces seit dem ersten Start der Webanwendung angezeigt werden. ![\[CloudWatch Zeitraum der Trace-Map\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/cw-console-service-map-time-period-15-minutes.png) Die Trace-Map zeigt den Web-App-Client, die in Amazon EC2 ausgeführte API und jede DynamoDB-Tabelle, die die Anwendung verwendet. Jede Anforderung an die Anwendung, bis zu einer konfigurierbaren Höchstanzahl von Anforderungen pro Sekunde, wird verfolgt, und zwar wie sie auf die API trifft, Anforderungen an nachgelagerte Services generiert und abgeschlossen wird. Sie können jeden Knoten in der Service-Grafik wählen, um Ablaufverfolgungen für Anforderungen anzusehen, die Datenverkehr zu diesem Knoten generiert haben. Derzeit ist der Amazon SNS SNS-Knoten orange. Zeigen Sie die Details an, um herauszufinden, warum. ![\[Trace-Map-Seite für die X-Ray-Konsole\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-cw-servicemap-before-ECS.png) **So finden Sie die Ursache des Fehlers** 1. Wählen Sie den Knoten mit dem Namen **SNS**. Der Bereich mit den SNS-Knotendetails wird unter der Karte angezeigt. 1. Wählen Sie „**Traces anzeigen**“, um die Seite „**Traces“ aufzurufen**. 1. Fügen Sie das Ende der Seite hinzu und wählen Sie den Trace aus der **Traces-Liste** aus. Diese Ablaufverfolgung verfügt über keine Methode oder URL, da sie während des Startups und nicht als Reaktion auf eine eingehende Anforderung aufgezeichnet wurde. ![\[Wählen einer Ablaufverfolgung aus der Ablaufverfolgungsliste\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-cw-tracelist-sns-ecs.png) 1. Wählen Sie das Amazon SNS SNS-Untersegment unten in der Segment-Timeline und wählen Sie den Tab **Ausnahmen** für das SNS-Untersegment, um die Ausnahmedetails anzuzeigen. ![\[Die Registerkarte „Ausnahmen“ für das Amazon SNS SNS-Untersegment anzeigen\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-gettingstarted-cw-timeline-sns-ecs.png) ------ Die Ursache gibt an, dass die E-Mail-Adresse, die in einem Aufruf von `createSubscription` in der Klasse `WebConfig` angegeben wurde, ungültig ist. Im nächsten Abschnitt werden wir das beheben. ## Konfigurieren von Amazon-SNS-Benachrichtigungen Scorekeep verwendet Amazon SNS, um Benachrichtigungen zu senden, wenn Benutzer ein Spiel abgeschlossen haben. Wenn die Anwendung gestartet wird, versucht sie, ein Abonnement für eine E-Mail-Adresse zu erstellen, die in einem CloudFormation Stack-Parameter definiert ist. Dieser Anruf schlägt derzeit fehl. Konfigurieren Sie eine Benachrichtigungs-E-Mail, um Benachrichtigungen zu aktivieren und die in der Trace-Map hervorgehobenen Fehler zu beheben. ------ #### [ AWS-Managementkonsole ] **So konfigurieren Sie Amazon SNS SNS-Benachrichtigungen mit dem AWS-Managementkonsole** 1. Öffnen Sie die [CloudFormation-Konsole](https://console.aws.amazon.com/cloudformation/). 1. Wählen Sie das Optionsfeld neben dem `scorekeep` Stack-Namen in der Liste und wählen Sie dann **Aktualisieren**. 1. Vergewissern Sie sich, dass **Aktuelle Vorlage verwenden** ausgewählt ist, und klicken Sie dann auf der Seite **Stack aktualisieren** auf **Weiter**. 1. Suchen Sie den **E-Mail-Parameter** in der Liste und ersetzen Sie den Standardwert durch eine gültige E-Mail-Adresse. ![\[E-Mail-Konfiguration aktualisieren\]](http://docs.aws.amazon.com/de_de/xray/latest/devguide/images/scorekeep-cf-email-update.png) 1. Scrollen Sie ans Seitenende und wählen Sie **Next** (Weiter). 1. **Scrollen Sie zum Ende der **Überprüfungsseite**, aktivieren Sie das Kontrollkästchen zur Bestätigung, dass CloudFormation möglicherweise IAM-Ressourcen mit benutzerdefinierten Namen erstellt werden, und wählen Sie Stack aktualisieren aus.** 1. Der CloudFormation Stack wird jetzt aktualisiert. Der Stack-Status wird `UPDATE_IN_PROGRESS` etwa fünf Minuten lang angezeigt, bevor er zu wechselt`UPDATE_COMPLETE`. Der Status wird regelmäßig aktualisiert, oder Sie können die Seite aktualisieren. ------ #### [ AWS CLI ] **So konfigurieren Sie Amazon SNS SNS-Benachrichtigungen mit dem AWS CLI** 1. Navigieren Sie zu dem `xray-scorekeep/cloudformation/` Ordner, den Sie zuvor erstellt haben, und öffnen Sie die `cf-resources.yaml` Datei in einem Texteditor. 1. Suchen Sie den `Default` Wert im **E-Mail-Parameter** und ändern Sie ihn von *UPDATE\$1ME* in eine gültige E-Mail-Adresse. ``` Parameters: Email: Type: String Default: UPDATE_ME # <- change to a valid abc@def.xyz email address ``` 1. Aktualisieren `cloudformation` Sie den CloudFormation Stack im Ordner mit dem folgenden AWS CLI Befehl: ``` aws cloudformation update-stack --stack-name scorekeep --capabilities "CAPABILITY_NAMED_IAM" --template-body file://cf-resources.yaml ``` 1. Warten Sie`UPDATE_COMPLETE`, bis der CloudFormation Stack-Status lautet. Dies kann einige Minuten dauern. Verwenden Sie den folgenden AWS CLI Befehl, um den Status zu überprüfen: ``` aws cloudformation describe-stacks --stack-name scorekeep --query "Stacks[0].StackStatus" ``` ------ Wenn die Aktualisierung abgeschlossen ist, startet Scorekeep neu und erstellt ein Abonnement für das SNS-Thema. Überprüfen Sie Ihre E-Mail-Adresse und bestätigen Sie das Abonnement, um Aktualisierungen anzuzeigen, wenn Sie ein Spiel abgeschlossen haben. Öffnen Sie die Trace-Map, um zu überprüfen, ob die Aufrufe an SNS nicht mehr fehlschlagen. ## Erkunden der Beispielanwendung Die Beispielanwendung ist eine HTTP-Web-API in Java, die für die Verwendung des X-Ray-SDK SDK for Java konfiguriert ist. Wenn Sie die Anwendung mit der CloudFormation Vorlage bereitstellen, erstellt sie die DynamoDB-Tabellen, den Amazon ECS-Cluster und andere Dienste, die für die Ausführung von Scorekeep auf ECS erforderlich sind. Eine Aufgabendefinitionsdatei für ECS wird über erstellt. CloudFormation Diese Datei definiert die Container-Images, die pro Aufgabe in einem ECS-Cluster verwendet werden. Diese Bilder stammen aus dem offiziellen öffentlichen X-Ray ECR. Das Scorekeep API-Container-Image enthält die API, die mit Gradle kompiliert wurde. Das Container-Image des Scorekeep-Frontend-Containers bedient das Frontend mithilfe des Nginx-Proxyservers. Dieser Server leitet Anfragen an Pfade, die mit /api beginnen, an die API weiter. Zum Instrumentieren eingehender HTTP-Anforderungen fügt die Anwendung den vom SDK bereitgestellten `TracingFilter` hinzu. **Example src/main/java/scorekeep/WebConfig.java — Servlet-Filter** ``` import javax.servlet.Filter; import [com.amazonaws.xray.javax.servlet.AWSXRayServletFilter](https://docs.aws.amazon.com/xray-sdk-for-java/latest/javadoc/com/amazonaws/xray/javax/servlet/AWSXRayServletFilter.html); ... @Configuration public class WebConfig { @Bean public Filter TracingFilter() { return new AWSXRayServletFilter("Scorekeep"); } ... ``` Dieser Filter sendet Ablaufverfolgungsdaten über alle eingehenden Anforderungen, die die Anwendung verarbeitet, einschließlich Anforderungs-URL, Methode, Antwortstatus sowie Start- und Endzeit. Die Anwendung führt auch Downstream-Aufrufe an DynamoDB mithilfe von durch. AWS SDK für Java Um diese Aufrufe zu instrumentieren, verwendet die Anwendung einfach die AWS SDK-bezogenen Submodule als Abhängigkeiten, und das X-Ray SDK for Java instrumentiert automatisch alle AWS SDK-Clients. Die Anwendung verwendet`Docker`, um den Quellcode auf der Instanz mit der `Gradle Docker Image` und der `Scorekeep API Dockerfile` Datei zu erstellen, um die ausführbare JAR auszuführen, die Gradle in ihrer eigenen Datei generiert. `ENTRYPOINT` **Example Verwendung von Docker zum Erstellen über Gradle Docker Image** ``` docker run --rm -v /PATH/TO/SCOREKEEP_REPO/home/gradle/project -w /home/gradle/project gradle:4.3 gradle build ``` **Example Dockerfile ENTRYPOINT** ``` ENTRYPOINT [ "sh", "-c", "java -Dserver.port=5000 -jar scorekeep-api-1.0.0.jar" ] ``` Die `build.gradle`-Datei lädt die SDK-Untermodule von Maven während der Kompilierung herunter, indem sie zu Abhängigkeiten erklärt werden. **Example build.gradle – Abhängigkeiten** ``` ... dependencies { compile("org.springframework.boot:spring-boot-starter-web") testCompile('org.springframework.boot:spring-boot-starter-test') compile('com.amazonaws:aws-java-sdk-dynamodb') compile("com.amazonaws:aws-xray-recorder-sdk-core") compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk") compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk-instrumentor") ... } dependencyManagement { imports { mavenBom("com.amazonaws:aws-java-sdk-bom:1.11.67") mavenBom("com.amazonaws:aws-xray-recorder-sdk-bom:2.11.0") } } ``` Die Submodule Core, AWS SDK und AWS SDK Instrumentor sind alles, was erforderlich ist, um alle Downstream-Aufrufe, die mit dem SDK getätigt werden, automatisch zu instrumentieren. AWS Um die Rohsegmentdaten an die X-Ray-API weiterzuleiten, muss der X-Ray-Daemon den Datenverkehr auf dem UDP-Port 2000 abhören. *Zu diesem Zweck wird der X-Ray-Daemon in der Anwendung in einem Container ausgeführt, der zusammen mit der Scorekeep-Anwendung auf ECS als Sidecar-Container bereitgestellt wird.* Weitere Informationen finden Sie im Thema [X-Ray-Daemon](xray-daemon.md). **Example X-Ray-Daemon-Container-Definition in einer ECS-Aufgabendefinition** ``` ... Resources: ScorekeepTaskDefinition: Type: AWS::ECS::TaskDefinition Properties: ContainerDefinitions: ... - Cpu: '256' Essential: true Image: amazon/aws-xray-daemon MemoryReservation: '128' Name: xray-daemon PortMappings: - ContainerPort: '2000' HostPort: '2000' Protocol: udp ... ``` Das X-Ray-SDK SDK for Java bietet eine Klasse mit dem Namen`AWSXRay`, die den globalen Rekorder bereitstellt`TracingHandler`, mit dem Sie Ihren Code instrumentieren können. Sie können die globale Aufzeichnung so konfigurieren, dass der `AWSXRayServletFilter`, der Segmente für eingehende HTTP-Aufrufe erstellt, angepasst wird. Das Beispiel enthält einen statischen Block in der `WebConfig`-Klasse, der die globale Aufzeichnung mit Plugins und Samplingregeln konfiguriert. **Example src/main/java/scorekeep/WebConfig.java — Rekorder** ``` import com.amazonaws.xray.AWSXRay; import com.amazonaws.xray.AWSXRayRecorderBuilder; import com.amazonaws.xray.javax.servlet.AWSXRayServletFilter; import com.amazonaws.xray.plugins.ECSPlugin; import com.amazonaws.xray.plugins.EC2Plugin; import com.amazonaws.xray.strategy.sampling.LocalizedSamplingStrategy; ... @Configuration public class WebConfig { ... static { AWSXRayRecorderBuilder builder = AWSXRayRecorderBuilder.standard().withPlugin(new ECSPlugin()).withPlugin(new EC2Plugin()); URL ruleFile = WebConfig.class.getResource("/sampling-rules.json"); builder.withSamplingStrategy(new LocalizedSamplingStrategy(ruleFile)); AWSXRay.setGlobalRecorder(builder.build()); ... } } ``` In diesem Beispiel wird der Builder zum Laden von Samplingregeln aus einer Datei namens `sampling-rules.json` verwendet. Samplingregeln bestimmen die Rate, mit der das SDK Segmente für eingehende Anforderungen aufzeichnet. **Example src/main/java/resources/sampling-rules.json** ``` { "version": 1, "rules": [ { "description": "Resource creation.", "service_name": "*", "http_method": "POST", "url_path": "/api/*", "fixed_target": 1, "rate": 1.0 }, { "description": "Session polling.", "service_name": "*", "http_method": "GET", "url_path": "/api/session/*", "fixed_target": 0, "rate": 0.05 }, { "description": "Game polling.", "service_name": "*", "http_method": "GET", "url_path": "/api/game/*/*", "fixed_target": 0, "rate": 0.05 }, { "description": "State polling.", "service_name": "*", "http_method": "GET", "url_path": "/api/state/*/*/*", "fixed_target": 0, "rate": 0.05 } ], "default": { "fixed_target": 1, "rate": 0.1 } } ``` Die Samplingregeldatei definiert vier benutzerdefinierte Samplingregeln und die Standardregel. Für jede eingehende Anforderung wertet das SDK die benutzerdefinierten Regeln in der Reihenfolge aus, in der sie definiert sind. Das SDK wendet die erste Regel an, die der Methode, dem Pfad und dem Service-Namen der Anforderung entspricht. Bei Scorekeep fängt die erste Regel alle POST-Anforderungen (Aufrufe zum Erstellen von Ressourcen) ab, indem pro Sekunde ein festes Ziel einer einzelnen Anfrage und eine Rate von 1.0 angewendet wird bzw. 100 % der Anforderungen nach dem festen Ziel erfüllt sind. Die übrigen drei benutzerdefinierte Regeln wenden eine Rate von fünf Prozent ohne festes Ziel auf Sitzungs-, Spiel- und Statuslesevorgänge (GET-Anfragen) an. Dies minimiert die Anzahl der Ablaufverfolgungen für regelmäßige Aufrufe, die das Front-End automatisch alle paar Sekunden ausführt, um sicherzustellen, dass die Inhalte auf dem neuesten Stand sind. Für alle übrigen Anforderungen definiert die Datei eine Standardrate von einer einzelnen Anfrage pro Sekunde und einer Rate von 10 Prozent. Die Beispielanwendung zeigt auch, wie Sie erweiterte Funktionen wie die manuelle SDK-Client-Instrumentierung verwenden sowie zusätzliche Untersegmente und ausgehende HTTP-Aufrufe erstellen. Weitere Informationen finden Sie unter [AWS X-Ray Musteranwendung](xray-scorekeep.md). ## Optional: Richtlinie für geringste Rechte Die Scorekeep ECS-Container greifen mithilfe von Vollzugriffsrichtlinien wie und auf Ressourcen zu. `AmazonSNSFullAccess` `AmazonDynamoDBFullAccess` Die Verwendung von Richtlinien für vollen Zugriff ist nicht die beste Methode für Produktionsanwendungen. Im folgenden Beispiel wird die DynamoDB-IAM-Richtlinie aktualisiert, um die Sicherheit der Anwendung zu verbessern. Weitere Informationen zu bewährten Sicherheitsmethoden in IAM-Richtlinien finden Sie unter [Identitäts- und Zugriffsmanagement für AWS X-Ray](security-iam.md). **Example Vorlage cf-resources.yaml Rollendefinition ECSTask** ``` ECSTaskRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Principal: Service: - "ecs-tasks.amazonaws.com" Action: - "sts:AssumeRole" ManagedPolicyArns: - "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" - "arn:aws:iam::aws:policy/AmazonSNSFullAccess" - "arn:aws:iam::aws:policy/AWSXrayFullAccess" RoleName: "scorekeepRole" ``` Um Ihre Richtlinie zu aktualisieren, identifizieren Sie zunächst den ARN Ihrer DynamoDB-Ressourcen. Anschließend verwenden Sie den ARN in einer benutzerdefinierten IAM-Richtlinie. Schließlich wenden Sie diese Richtlinie auf Ihr Instanzprofil an. **So identifizieren Sie den ARN Ihrer DynamoDB-Ressource:** 1. Öffnen Sie die [DynamoDB-Konsole](https://console.aws.amazon.com/dynamodbv2). 1. Wählen Sie in der linken Navigationsleiste **Tabellen** aus. 1. Wählen Sie eine der Optionen`scorekeep-*`, um die Tabellendetailseite anzuzeigen. 1. Wählen Sie auf der Registerkarte **Übersicht** die Option **Zusätzliche Informationen** aus, um den Abschnitt zu erweitern und den Amazon-Ressourcennamen (ARN) anzuzeigen. Kopieren Sie diesen Wert. 1. Fügen Sie den ARN in die folgende IAM-Richtlinie ein und ersetzen Sie die `AWS_ACCOUNT_ID` Werte `AWS_REGION` und durch Ihre spezifische Region und Konto-ID. Diese neue Richtlinie erlaubt nur die angegebenen Aktionen und nicht die `AmazonDynamoDBFullAccess` Richtlinie, die alle Aktionen zulässt. **Example** ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "ScorekeepDynamoDB", "Effect": "Allow", "Action": [ "dynamodb:PutItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem", "dynamodb:GetItem", "dynamodb:Scan", "dynamodb:Query" ], "Resource": "arn:aws:dynamodb:us-east-1:111122223333:table/scorekeep-*" } ] } ``` ------ Die Tabellen, die über die Anwendung erstellt werden, folgen einer einheitlichen Namenskonvention. Sie können das `scorekeep-*` Format verwenden, um alle Scorekeep-Tabellen anzugeben. **Ändern Sie Ihre IAM-Richtlinie** 1. Öffnen Sie die [Scorekeep-Aufgabenrolle (ScorekeepRole) von der IAM-Konsole aus.](https://console.aws.amazon.com/iamv2/home#/roles/details/scorekeepRole) 1. **Aktivieren Sie das Kontrollkästchen neben der Richtlinie und wählen Sie Entfernen, um diese `AmazonDynamoDBFullAccess` Richtlinie zu entfernen.** 1. Wählen Sie „**Berechtigungen hinzufügen**“, dann „**Richtlinien anhängen**“ und schließlich „**Richtlinie erstellen**“. 1. Wählen Sie die Registerkarte **JSON** und fügen Sie die oben erstellte Richtlinie ein. 1. Wählen Sie unten auf der Seite „**Weiter: Tags**“. 1. Wählen Sie unten auf der Seite „**Weiter: Bewertung**“. 1. Geben Sie unter **Name** einen Namen für die Richtlinie ein. 1. Wählen Sie unten auf der Seite **Richtlinie erstellen** aus. 1. Hängen Sie die neu erstellte Richtlinie an die `scorekeepRole` Rolle an. Es kann einige Minuten dauern, bis die angehängte Richtlinie wirksam wird. Wenn Sie die neue Richtlinie an die `scorekeepRole` Rolle angehängt haben, müssen Sie sie trennen, bevor Sie den CloudFormation Stapel löschen, da diese angehängte Richtlinie das Löschen des Stacks verhindert. Die Richtlinie kann automatisch getrennt werden, indem die Richtlinie gelöscht wird. **Entfernen Sie Ihre benutzerdefinierte IAM-Richtlinie** 1. Öffnen Sie die [IAM-Konsole](https://console.aws.amazon.com/iam). 1. Wählen Sie in der linken Navigationsleiste **Richtlinien** aus. 1. Suchen Sie nach dem benutzerdefinierten Richtliniennamen, den Sie zuvor in diesem Abschnitt erstellt haben, und wählen Sie das Optionsfeld neben dem Richtliniennamen, um ihn hervorzuheben. 1. Wählen Sie das Drop-down-Menü **Aktionen** und dann **Löschen** aus. 1. Geben Sie den Namen der benutzerdefinierten Richtlinie ein und wählen Sie dann **Löschen**, um den Löschvorgang zu bestätigen. Dadurch wird die Richtlinie automatisch von der `scorekeepRole` Rolle getrennt. ## Bereinigen Gehen Sie wie folgt vor, um die Ressourcen der Scorekeep-Anwendung zu löschen: **Anmerkung** Wenn Sie mithilfe des vorherigen Abschnitts dieses Tutorials benutzerdefinierte Richtlinien erstellt und angehängt haben, müssen Sie die Richtlinie aus dem entfernen, `scorekeepRole` bevor Sie den CloudFormation Stack löschen. ------ #### [ AWS-Managementkonsole ] **Löschen Sie die Beispielanwendung mit dem AWS-Managementkonsole** 1. Öffnen Sie die [CloudFormation-Konsole](https://console.aws.amazon.com/cloudformation/). 1. Wählen Sie das Optionsfeld neben dem `scorekeep` Stack-Namen in der Liste und wählen Sie dann **Löschen** aus. 1. Der CloudFormation Stapel wird jetzt gelöscht. Der Stack-Status bleibt `DELETE_IN_PROGRESS` einige Minuten lang bestehen, bis alle Ressourcen gelöscht sind. Der Status wird regelmäßig aktualisiert, oder Sie können die Seite aktualisieren. ------ #### [ AWS CLI ] **Löschen Sie die Beispielanwendung mit dem AWS CLI** 1. Geben Sie den folgenden AWS CLI Befehl ein, um den CloudFormation Stack zu löschen: ``` aws cloudformation delete-stack --stack-name scorekeep ``` 1. Warten Sie, bis der CloudFormation Stapel nicht mehr existiert. Dies dauert etwa fünf Minuten. Verwenden Sie den folgenden AWS CLI Befehl, um den Status zu überprüfen: ``` aws cloudformation describe-stacks --stack-name scorekeep --query "Stacks[0].StackStatus" ``` ------ ## Nächste Schritte Erfahre mehr über X-Ray im nächsten Kapitel,[AWS X-Ray Konzepte](xray-concepts.md). Um Ihre eigene App zu instrumentieren, erfahren Sie mehr über das X-Ray SDK for Java oder eines der anderen X-Ray SDKs: + **X-Ray SDK for Java** — [AWS X-Ray SDK for Java](xray-sdk-java.md) + **X-Ray-SDK für Node.js** — [AWS X-Ray-SDK für Node.js](xray-sdk-nodejs.md) + **X-Ray SDK for .NET** — [AWS X-Ray SDK for .NET](xray-sdk-dotnet.md) Informationen zum lokalen oder eingeschalteten Ausführen des X-Ray-Daemons finden Sie unter[AWS X-Ray Dämon](xray-daemon.md). AWS Wie Sie zur Beispielanwendung beitragen können GitHub, finden Sie unter [eb-java-scorekeep](https://github.com/awslabs/eb-java-scorekeep/tree/xray-gettingstarted).