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.

Spécifier des métadonnées personnalisées

CloudWatch RUM attache des données supplémentaires à chaque événement sous forme de métadonnées. Les métadonnées d'événement se composent d'attributs sous forme de paires clé-valeur. Vous pouvez utiliser ces attributs pour rechercher ou filtrer des événements dans la console CloudWatch RUM. Par défaut, CloudWatch RUM crée des métadonnées pour vous. Pour en savoir plus sur les métadonnées par défaut, consultez Métadonnées des événements RUM.

Vous pouvez également utiliser le client Web CloudWatch RUM pour ajouter des métadonnées personnalisées aux événements CloudWatch RUM. Les métadonnées personnalisées peuvent inclure des attributs de session et des attributs de page.

Pour ajouter des métadonnées personnalisées, vous devez utiliser la version 1.10.0 ou ultérieure du client Web CloudWatch RUM.

Exigences et syntaxe

Chaque événement peut inclure jusqu'à 10 attributs personnalisés dans les métadonnées. Les exigences syntaxiques pour les attributs personnalisés sont les suivantes :

Mots-clés réservés

Vous ne pouvez pas utiliser les mots-clés réservés suivants comme noms de clés complets. Vous pouvez utiliser les mots-clés suivants comme partie d'un nom de clé plus long, tel que applicationVersion.

Ajout d'un attribut de session

Si vous configurez des attributs de session personnalisés, ils sont ajoutés à tous les événements d'une session. Vous configurez les attributs de session soit lors de l'initialisation du client Web CloudWatch RUM, soit lors de l'exécution à l'aide de la addSessionAttributes commande.

Par exemple, vous pouvez ajouter la version de votre application comme attribut de session. Ensuite, dans la console CloudWatch RUM, vous pouvez filtrer les erreurs par version afin de déterminer si un taux d'erreur accru est associé à une version particulière de votre application.

Ajout d'un attribut de session pendant l'initialisation, exemple NPM

La section de code en gras ajoute l'attribut de session.

import { AwsRum, AwsRumConfig } from 'aws-rum-web';

try {
  const config: AwsRumConfig = {
    allowCookies: true,
    endpoint: "https://dataplane.rum.us-west-2.amazonaws.com",
    guestRoleArn: "arn:aws:iam::000000000000:role/RUM-Monitor-us-west-2-000000000000-00xx-Unauth",
    identityPoolId: "us-west-2:00000000-0000-0000-0000-000000000000",
    sessionSampleRate: 1,
    telemetries: ['errors', 'performance'],
    sessionAttributes: {
        applicationVersion: "1.3.8"
    }
  };

  const APPLICATION_ID: string = '00000000-0000-0000-0000-000000000000';
  const APPLICATION_VERSION: string = '1.0.0';
  const APPLICATION_REGION: string = 'us-west-2';

  const awsRum: AwsRum = new AwsRum(
    APPLICATION_ID,
    APPLICATION_VERSION,
    APPLICATION_REGION,
    config
  );
} catch (error) {
  // Ignore errors thrown during CloudWatch RUM web client initialization
}

Ajout d'un attribut de session au moment de l'exécution, exemple NPM

awsRum.addSessionAttributes({ 
    applicationVersion: "1.3.8"    
})

Ajout d'un attribut de session pendant l'initialisation, exemple de script intégré

La section de code en gras ajoute l'attribut de session.

<script>
    (function(n,i,v,r,s,c,u,x,z){...})(
        'cwr',
        '00000000-0000-0000-0000-000000000000',
        '1.0.0',
        'us-west-2',
        'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
        {
            sessionSampleRate:1,
            guestRoleArn:'arn:aws:iam::000000000000:role/RUM-Monitor-us-west-2-000000000000-00xx-Unauth',
            identityPoolId:'us-west-2:00000000-0000-0000-0000-000000000000',
            endpoint:'https://dataplane.rum.us-west-2.amazonaws.com',
            telemetries:['errors','http','performance'],
            allowCookies:true,
            sessionAttributes: {
                applicationVersion: "1.3.8"
            }
        }
    );
</script>

Ajout d'un attribut de session au moment de l'exécution, exemple de script intégré

<script>
    function addSessionAttribute() {
        cwr('addSessionAttributes', {
            applicationVersion: "1.3.8"
        })
    }
            
</script>

Ajout d'attributs de page

Si vous configurez des attributs de page personnalisés, ils sont ajoutés à tous les événements de la page actuelle. Vous configurez les attributs de page soit lors de l'initialisation du client Web CloudWatch RUM, soit lors de l'exécution à l'aide de la recordPageView commande.

Par exemple, vous pouvez ajouter votre modèle de page comme attribut de page. Ensuite, dans la console CloudWatch RUM, vous pouvez filtrer les erreurs par modèles de page afin de déterminer si un taux d'erreur accru est associé à un modèle de page particulier de votre application.

Ajout d'un attribut de page pendant l'initialisation, exemple NPM

La section de code en gras ajoute l'attribut de page.

const awsRum: AwsRum = new AwsRum(
    APPLICATION_ID,
    APPLICATION_VERSION,
    APPLICATION_REGION,
    { disableAutoPageView:  true // optional }
);
awsRum.recordPageView({  
    pageId:'/home',  
    pageAttributes: {
      template: 'artStudio'
    }
});
const credentialProvider = new CustomCredentialProvider();
if(awsCreds) awsRum.setAwsCredentials(credentialProvider);

Ajout d'un attribut de page au moment de l'exécution, exemple NPM

awsRum.recordPageView({ 
    pageId: '/home', 
    pageAttributes: {
        template: 'artStudio'
    } 
});

Ajout d'un attribut de page pendant l'initialisation, exemple de script intégré

La section de code en gras ajoute l'attribut de page.

<script>
    (function(n,i,v,r,s,c,u,x,z){...})(
        'cwr',
        '00000000-0000-0000-0000-000000000000',
        '1.0.0',
        'us-west-2',
        'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
        {
            disableAutoPageView: true //optional
        }
    );
    cwr('recordPageView', { 
       pageId: '/home',  
       pageAttributes: {
           template: 'artStudio'
       }
    });
    const awsCreds = localStorage.getItem('customAwsCreds');
    if(awsCreds) cwr('setAwsCredentials', awsCreds)
</script>

Ajout d'un attribut de page au moment de l'exécution, exemple de script intégré

<script>
    function recordPageView() {
        cwr('recordPageView', { 
            pageId: '/home', 
            pageAttributes: {
                template: 'artStudio'
            }
        });
    }        
</script>

Filtrage par attributs de métadonnées dans la console

Pour filtrer les visualisations de la console CloudWatch RUM avec un attribut de métadonnées intégré ou personnalisé, utilisez la barre de recherche. Dans la barre de recherche, vous pouvez spécifier jusqu'à 20 termes de filtre sous la forme clé=valeur à appliquer aux visualisations. Par exemple, pour filtrer les données concernant uniquement le navigateur Chrome, vous pouvez ajouter le terme de filtre browserName=Chrome.

Par défaut, la console CloudWatch RUM récupère les 100 clés et valeurs d'attributs les plus courants à afficher dans le menu déroulant de la barre de recherche. Pour ajouter d'autres attributs de métadonnées comme termes de filtre, saisissez la clé et la valeur complètes de l'attribut dans la barre de recherche.

Un filtre peut inclure jusqu'à 20 termes de filtre, et vous pouvez enregistrer jusqu'à 20 filtres par moniteur d'application. Lorsque vous enregistrez un filtre, il est sauvegardé dans la liste déroulante Saved filters (Filtres enregistrés). Vous pouvez également supprimer un filtre enregistré.