Comment ajouter des informations associées à la télémétrie personnalisée envoyée à CloudWatch - Amazon CloudWatch
Entité KeyAttributesAttributs d'entité

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Comment ajouter des informations associées à la télémétrie personnalisée envoyée à CloudWatch

Lorsque vous publiez vos propres métriques et journaux sur CloudWatch, les informations d'entité nécessaires à la télémétrie associée ne s'y trouvent pas par défaut. Lorsque vous envoyez des métriques CloudWatch ou des CloudWatch journaux à Logs (avec les PutLogEventsopérations PutMetricDataor), vous pouvez ajouter des informations d'entité à ces journaux ou métriques. Les informations d'entité sont associées à la télémétrie et utilisées dans la fonctionnalité associée à Explore pour rechercher la télémétrie associée à la même entité.

L'entité envoyée avec la télémétrie représente une ressource ou un service auquel la télémétrie est associée. Par exemple, une métrique concernant un service ou provenant d'une AWS ressource. Pour identifier l'entité associée dans votre code, vous devez créer un ensemble KeyAttributes Attributes d'entités facultatives.

Note

CloudWatch ne peut trouver les ressources associées que pour les entités auxquelles des données de télémétrie ont été envoyées au cours des trois heures précédentes. Si votre ressource n'émet que des données télémétriques éparses (moins d'une fois toutes les 3 heures), vous souhaiterez peut-être envoyer des données télémétriques supplémentaires pour que l'entité reste active à l'intérieur. CloudWatch

Les sections suivantes décrivent comment créer le KeyAttributes et Attributes afin d' CloudWatch identifier les ressources et les services associés à la télémétrie.

La KeyAttributes propriété des objets Entity (dans CloudWatch ou dans CloudWatch les journaux) identifie de manière unique l'entité pour laquelle CloudWatch. Il s'agit d'une liste de paires clé-valeur. Les entités présentant les mêmes caractéristiques KeyAttributes sont considérées comme la même entité. La télémétrie associée à la même entité est considérée comme liée et peut être facilement trouvée dans le volet associé Explore.

Note

Dans le CloudWatch API, la propriété est appeléeKeyAttributes. Dans les CloudWatch journauxAPI, la propriété est appeléekeyAttributes. Ici, ils sont traités comme la même propriété.

Il existe cinq types d'objets que l'homme Entity peut représenter.

  • AWS: :Resource — L'entité représente une AWS ressource, telle qu'une table DynamoDB ou une instance Amazon. EC2

  • AWS: :Service — L'entité représente un AWS service, tel qu'Amazon S3. Cela peut être utilisé, par exemple, lors de l'appel de l'ListBucketsopération, qui n'est pas associée à une ressource Amazon S3 spécifique.

  • Service : l'entité représente une charge de travail exécutée sur votre compte. Par exemple, une application ou un service que vous gérez.

  • Ressource : l'entité représente une ressource qui n'est pas gérée AWS, par exemple, par les ressources du système d'exploitation, telles que les processus ou les volumes de fichiers.

  • RemoteService— L'entité représente un service externe dans un appel à distance. Par exemple, un appel à distance vers une base de données, un cache externe ou un point de terminaison externe.

Selon le type ci-dessus que vous essayez de représenter, vous devez fournir les paires clé-valeur correctes pour le. KeyAttributes Vous trouverez ci-dessous une description de chaque type.

AWS::Resource

Pour spécifier une AWS ressource, vous devez inclure les trois paires clé-valeur suivantes :

  • "Type": "AWS::Resource"— Cette paire clé-valeur identifie l'entité en tant AWS que ressource.

  • "ResourceType": "<resource-type>"— La valeur de chaîne de ResourceType est la chaîne de type de AWS CloudFormation ressource. Par exemple, AWS::DynamoDB::Table.

  • "Identifier": "<resource-id>"— Identifiant principal de la ressource. Pour plus d'informations, consultez primaryIdentifierle guide de développement d'extensions pour CloudFormation l'utilisateur.

AWS::Service

Pour spécifier un AWS service, vous devez inclure les deux paires clé-valeur suivantes :

  • "Type": "AWS::Service"— Cette paire clé-valeur identifie l'entité en tant AWS que service.

  • "Name": "<service-name>"— La valeur de Name est la chaîne du nom du AWS CloudFormation service. Par exemple, AWS::DynamoDB.

Service

Pour spécifier un service qui n'est pas géré par AWS, vous devez inclure les trois paires clé-valeur suivantes :

  • "Type": "Service"— Cette paire clé-valeur identifie l'entité en tant que service.

  • "Name": "<service-name>"— Cela représente le nom du service qui envoie les métriques. Par exemple, my-service-frontend ou api.myservice.com.

  • "Environment": "<environment-name>"— Cet attribut indique où le service est hébergé ou l'environnement auquel il appartient. Par exempleus-west-2, oumyservice.production.

Resource

Pour spécifier une ressource qui n'est pas fournie par AWS, vous devez inclure les trois paires clé-valeur suivantes :

  • "Type": "Resource"— Cette paire clé-valeur identifie l'entité en tant que ressource.

  • "ResourceType": "<resource-type>"— Chaîne spécifiant le type de ressource. Par exemple, K8s::Pod pour un Kubernetes Pod.

  • "Identifier": "<resource-id>"— Identifiant de chaîne pour la ressource. Peut contenir plusieurs noms, séparés par des tubes. Par exemple, un pod Kubernetes peut être représenté par son nom de cluster, son espace de noms et son nom de pod, tels que. MyCluster|MyNamespace|MyPod

RemoteService

Pour spécifier un service distant, vous devez inclure les deux paires clé-valeur suivantes :

  • "Type": "RemoteService"— Cette paire clé-valeur identifie l'entité en tant que service distant.

  • "Name": "<remote-service-name>"— Spécifie la manière dont l'application fait référence au service externe lors d'un appel à distance. Par exemple, api.test.myservice.com.

Vous pouvez fournir des informations supplémentaires sur les informations Entity que vous fournissez avec votre télémétrie. Cela peut inclure des détails sur la plate-forme, la ressource, l'application ou le fournisseur de télémétrie. Les tableaux suivants décrivent les mots clés que vous pouvez utiliser pour chacun de ces types de données.

Note

Dans le CloudWatch API, la propriété est appeléeAttributes. Dans les CloudWatch journauxAPI, la propriété est appeléeattributes. Ici, ils sont traités comme la même propriété.

Platform details (Détails de la plateforme)

Mot clé Utilisation Domaine des valeurs Exemples

PlatformType

Définit la plate-forme hébergée.

AWS: :EKS, AWS::ECS, AWS::EC 2, K8s AWS::Lambda, Générique

AWS::EC2

EKS.Cluster

Nom du EKS cluster Amazon.

Chaîne alphanumérique avec délimiteurs de base.

FlyingSquad

K8s.Cluster

Nom du cluster Kubernetes auto-hébergé.

Chaîne alphanumérique avec délimiteurs de base.

minicube

K8s.Namespace

Nom de l'espace de noms Kubernetes dans les clusters EKS Amazon ou K8s.

Chaîne alphanumérique avec délimiteurs de base.

default, pet-clinic

K8s.Workload

Nom de la charge de travail Kubernetes dans les clusters Amazon EKS et K8s.

Chaîne alphanumérique avec délimiteurs de base.

frontend

K8s.Node

Identité du nœud Kubernetes dans les clusters Amazon EKS et K8s.

Nom du nœud K8s (par exemple, nom de l'EC2instance DNS Amazon).

ip-11-22-33-44.ec2.internal

K8s.Pod

Identité du pod Kubernetes dans les clusters Amazon EKS et K8s.

Identifiant du pod K8s.

frontend-1234abcd56-ef7890

EC2.AutoScalingGroup

Nom du EC2 AutoScaling groupe Amazon.

Chaîne alphanumérique avec délimiteurs de base.

my-asg-name-1

EC2.InstanceId

Identité de l'EC2instance Amazon.

Identifiant EC2 d'instance Amazon.

i-1234abcd5678ef90

ECS.Cluster

Identité du ECS cluster Amazon.

Nom ECS du cluster Amazon.

MyCluster

ECS.Service

Identité du ECS service Amazon.

Nom ECS du service Amazon.

MyService

ECS.Task

Identité de la ECS tâche Amazon.

ID de ECS tâche Amazon.

task-123abc

Lambda.Function

Identité de la fonction Lambda.

Nom de la fonction Lambda.

MyFunction

Host

Nom de l'hôte pour tous les types de plateformes.

Format de sous-domaine.

ip-111-22-33-44.example.com

Détails de la ressource

Mot clé Utilisation Domaine des valeurs Exemples

AWS.Resource.ARN

ARNpour la AWS ressource.

Chaîne alphanumérique avec délimiteurs de base.

arn:aws:dynamodb:us-east-1:123456789012:table/myDynamoDBTable

Détails de l'application

Mot clé Utilisation Domaine des valeurs Exemples

AWS.Application

Nom de l'application dans AppRegistry.

Chaîne alphanumérique avec délimiteurs de base.

PetClinicApp

AWS.Application.ARN

ARNde l'application dans AppRegistry.

Chaîne alphanumérique avec délimiteurs de base.

arn:aws:servicecatalog:us-east-1:1234567890:/applications/...

Informations sur le fournisseur de télémétrie

Mot clé Utilisation Domaine des valeurs Exemples

Telemetry.SDK

L'empreinte de la OTEL SDK version pour les services instrumentés.

Chaîne alphanumérique avec délimiteurs de base.

opentelemetry,1.32.0-aws-SNAPSHOT,java,Auto

Telemetry.Agent

Empreinte digitale de l'agent utilisé pour collecter et envoyer les données de télémétrie.

Chaîne alphanumérique avec délimiteurs de base.

CWAgent/1.300026.3, ADOTCollector/1.x

Telemetry.Source

Spécifie le point d'application où la télémétrie a été collectée ou ce qui a été utilisé comme source de données de télémétrie.

ServerSpan, ClientSpan, ProducerSpan, ConsumerSpan, LocalRoot SpanJMX, OS.

ClientSpan, JMX