Wie füge ich verwandte Informationen zur benutzerdefinierten Telemetrie hinzu, die an gesendet wird CloudWatch

Wenn Sie Ihre eigenen Metriken und Protokolle veröffentlichen, sind die Entitätsinformationen CloudWatch, die für die zugehörige Telemetrie benötigt werden, standardmäßig nicht vorhanden. Wenn Sie Metriken an CloudWatch oder Logs an CloudWatch Logs senden (mit den PutLogEventsOperationen PutMetricDataoder), können Sie Entitätsinformationen zu diesen Logs oder Metriken hinzufügen. Die Entitätsinformationen werden mit der Telemetrie verknüpft und in der zugehörigen Funktion „Erkunden“ verwendet, um verwandte Telemetriedaten zu finden, die derselben Entität zugeordnet sind.

Die mit der Telemetrie gesendete Entität stellt eine Ressource oder einen Dienst dar, mit dem die Telemetrie verknüpft ist. Zum Beispiel eine Metrik über einen Dienst oder eine Metrik, die von einer AWS Ressource stammt. Um die Entität zu identifizieren, die mit Ihrem Code verknüpft ist, erstellen Sie eine Gruppe von KeyAttributes und optional Attributes die Entität.

Anmerkung

CloudWatch kann nur verwandte Ressourcen für Entitäten finden, an die innerhalb der letzten drei Stunden Telemetriedaten gesendet wurden. Wenn Ihre Ressource nur spärliche Telemetriedaten sendet (weniger als einmal alle 3 Stunden), möchten Sie möglicherweise zusätzliche Heartbeat-Telemetriedaten senden, damit die Entität innerhalb dieser Zeit aktiv bleibt. CloudWatch

Informationen zum Hinzufügen von Entitätsinformationen finden Sie unter. Entitätsinformationen im EMF-Format

In den folgenden Abschnitten wird beschrieben, wie das KeyAttributes und erstellt wird, Attributes CloudWatch sodass die mit der Telemetrie verbundenen Ressourcen und Dienste identifiziert werden können.

Identifizieren der Entität mit dem KeyAttributes Objekt

Die KeyAttributes Eigenschaft der Entity-Objekte (in CloudWatch oder in CloudWatch Protokollen) identifiziert die Entität für eindeutig CloudWatch. Es ist eine Liste von Schlüssel-Wert-Paaren. Entitäten mit derselben KeyAttributes Entität werden als dieselbe Entität betrachtet. Telemetriedaten, die derselben Entität zugeordnet sind, werden als verwandt betrachtet und können leicht im Bereich „Verwandtes Erkunden“ gefunden werden.

Anmerkung

In der CloudWatch API wird die Eigenschaft aufgerufenKeyAttributes. In der CloudWatch Logs-API wird die Eigenschaft aufgerufenkeyAttributes. Hier werden sie als dieselbe Eigenschaft behandelt.

Es gibt fünf mögliche Objekttypen, die ein Mensch darstellen Entity kann.

• AWS::Resource— Die Entität stellt eine AWS Ressource dar, z. B. eine DynamoDB-Tabelle oder eine EC2 Amazon-Instance.

• AWS::Service— Die Entität repräsentiert einen AWS Service wie Amazon S3. Dies kann beispielsweise verwendet werden, wenn der ListBuckets Vorgang aufgerufen wird, der keiner bestimmten Amazon S3 S3-Ressource zugeordnet ist.

• Service — Die Entität stellt einen Workload dar, der in Ihrem Konto ausgeführt wird. Zum Beispiel eine Anwendung oder ein Dienst, den Sie verwalten.

• Ressource — Die Entität stellt eine Ressource dar AWS, die nicht von Betriebssystemressourcen wie Prozessen oder Dateivolumes verwaltet wird.

• RemoteService— Die Entität stellt einen externen Dienst in einem Fernanruf dar. Zum Beispiel ein Remote-Aufruf einer Datenbank, eines externen Caches oder eines externen Endpunkts.

Je nachdem, welchen der oben genannten Typen Sie darstellen möchten, müssen Sie die richtigen Schlüssel-Wert-Paare für angeben. KeyAttributes Im Folgenden werden die einzelnen Typen beschrieben.

AWS::Resource

Um eine AWS Ressource anzugeben, müssen Sie die folgenden drei Schlüsselwertpaare angeben:

• "Type": "AWS::Resource"— Dieses Schlüssel-Wert-Paar identifiziert die Entität als AWS Ressource.

• "ResourceType": "<resource-type>"— Der Zeichenkettenwert von ResourceType ist der AWS CloudFormation Ressourcentyp string. Beispiel, AWS::DynamoDB::Table.

• "Identifier": "<resource-id>"— Der primäre Bezeichner für die Ressource. Weitere Informationen finden Sie unter PrimaryIdentifier im Handbuch zur Entwicklung von Erweiterungen für CloudFormation Benutzer.

AWS::Service

Um einen AWS Dienst anzugeben, müssen Sie die folgenden zwei Schlüssel-Wert-Paare angeben:

• "Type": "AWS::Service"— Dieses Schlüssel-Wert-Paar identifiziert die Entität als AWS Dienst.

• "Name": "<service-name>"— Der Wert von Name ist die Zeichenfolge mit dem AWS CloudFormation Dienstnamen. Beispiel, AWS::DynamoDB.

Service

Um einen Dienst anzugeben, der nicht von betrieben wird AWS, müssen Sie die folgenden drei Schlüsselwertpaare angeben:

• "Type": "Service"— Dieses Schlüssel-Wert-Paar identifiziert die Entität als Dienst.

• "Name": "<service-name>"— Dies steht für den Namen des Dienstes, der die Metriken sendet. Zum Beispiel my-service-frontend oder api.myservice.com.

• "Environment": "<environment-name>"— Dieses Attribut gibt an, wo der Service gehostet wird oder zu welcher Umgebung er gehört. Zum Beispielus-west-2, odermyservice.production.

Resource

Um eine Ressource anzugeben, die nicht von bereitgestellt wird AWS, müssen Sie die folgenden drei Schlüssel-Wert-Paare angeben:

• "Type": "Resource"— Dieses Schlüssel-Wert-Paar identifiziert die Entität als Ressource.

• "ResourceType": "<resource-type>"— Eine Zeichenfolge, die den Ressourcentyp angibt. Zum Beispiel K8s::Pod für einen Kubernetes-Pod.

• "Identifier": "<resource-id>"— Eine Zeichenketten-ID für die Ressource. Kann mehrere Namen enthalten, die durch Pipes getrennt sind. Ein Kubernetes-Pod kann beispielsweise durch seinen Clusternamen, seinen Namespace und seinen Pod-Namen dargestellt werden, z. B. MyCluster|MyNamespace|MyPod

RemoteService

Um einen Remotedienst anzugeben, müssen Sie die folgenden zwei Schlüsselwertpaare angeben:

• "Type": "RemoteService"— Dieses Schlüssel-Wert-Paar identifiziert die Entität als Remotedienst.

• "Name": "<remote-service-name>"— Gibt an, wie sich die Anwendung bei einem Fernaufruf auf den externen Dienst bezieht. Beispiel, api.test.myservice.com.

Bereitstellung zusätzlicher Details über die Entität mit dem Attributes-Objekt

Sie können zusätzliche Details zu den Daten angebenEntity, die Sie mit Ihrer Telemetrie bereitstellen. Dies kann Details über die Plattform, die Ressource, die Anwendung oder den Telemetrieanbieter beinhalten. In den folgenden Tabellen werden die Schlüsselwörter beschrieben, die Sie für jeden dieser Datentypen verwenden können.

Anmerkung

In der CloudWatch API wird die Eigenschaft aufgerufenAttributes. In der CloudWatch Logs-API wird die Eigenschaft aufgerufenattributes. Hier werden sie als dieselbe Eigenschaft behandelt.

Plattformdetails

Stichwort	Verwendung	Bereich der Werte	Beispiele
PlatformType	Definiert die gehostete Plattform.	AWS::EKS, AWS::ECS, AWS::EC2, AWS::Lambda, K8s, Generisch	AWS::EC2
EKS.Cluster	Name des Amazon EKS-Clusters.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	FlyingSquad
K8s.Cluster	Name des selbst gehosteten Kubernetes-Clusters.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	minicube
K8s.Namespace	Name des Kubernetes-Namespace in Amazon EKS- oder K8s-Clustern.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	default, pet-clinic
K8s.Workload	Name des Kubernetes-Workloads in Amazon EKS- und K8s-Clustern.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	frontend
K8s.Node	Identität des Kubernetes-Knotens in Amazon EKS- und K8s-Clustern.	K8s-Knotenname (z. B. DNS-Name der EC2 Amazon-Instanz).	ip-11-22-33-44.ec2.internal
K8s.Pod	Identität des Kubernetes-Pods in Amazon EKS- und K8s-Clustern.	K8s-Pod-ID.	frontend-1234abcd56-ef7890
EC2.AutoScalingGroup	Name der EC2 AutoScaling Amazon-Gruppe.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	my-asg-name-1
EC2.InstanceId	Identität der EC2 Amazon-Instance.	EC2 Amazon-Instanz-ID.	i-1234abcd5678ef90
ECS.Cluster	Identität des Amazon ECS-Clusters.	Name des Amazon ECS-Clusters.	MyCluster
ECS.Service	Identität des Amazon ECS-Service.	Name des Amazon ECS-Service.	MyService
ECS.Task	Identität der Amazon ECS-Aufgabe.	Amazon ECS-Aufgaben-ID.	task-123abc
Lambda.Function	Identität der Lambda-Funktion.	Name der Lambda-Funktion.	MyFunction
Host	Name des Hosts für alle Plattformtypen.	Format der Subdomain.	ip-111-22-33-44.example.com

Angaben zur Ressource

Stichwort	Verwendung	Bereich der Werte	Beispiele
AWS.Resource.ARN	ARN für die AWS Ressource.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	arn:aws:dynamodb:us-east-1:123456789012:table/myDynamoDBTable

Angaben zur Bewerbung

Stichwort	Verwendung	Bereich der Werte	Beispiele
AWS.Application	Name der Anwendung in AppRegistry.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	PetClinicApp
AWS.Application.ARN	ARN der Anwendung in AppRegistry.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	arn:aws:servicecatalog:us-east-1:1234567890:/applications/...

Einzelheiten zum Telemetrieanbieter

Stichwort	Verwendung	Domäne der Werte	Beispiele
Telemetry.SDK	Der Fingerabdruck der OTEL SDK-Version für instrumentierte Dienste.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	opentelemetry,1.32.0-aws-SNAPSHOT,java,Auto
Telemetry.Agent	Der Fingerabdruck des Agenten, der zum Sammeln und Senden von Telemetriedaten verwendet wird.	Alphanumerische Zeichenfolge mit einfachen Trennzeichen.	CWAgent/1.300026.3, ADOTCollector/1.x
Telemetry.Source	Gibt den Anwendungspunkt an, an dem die Telemetriedaten erfasst wurden oder was als Quelle der Telemetriedaten verwendet wurde.	ServerSpan, ClientSpan, ProducerSpan, LocalRoot Spanien ConsumerSpan, JMX, OS.	ClientSpan, JMX