Benutzerdefinierte Metadaten angeben - Amazon CloudWatch

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.

Benutzerdefinierte Metadaten angeben

CloudWatch RUM fügt jedem Ereignis zusätzliche Daten als Metadaten hinzu. Ereignismetadaten bestehen aus Attributen in Form von Schlüssel-Wert-Paaren. Sie können diese Attribute verwenden, um Ereignisse in der CloudWatch RUM-Konsole zu suchen oder zu filtern. Standardmäßig erstellt CloudWatch RUM einige Metadaten für Sie. Weitere Informationen zu Standard-Metadaten erhalten Sie unter RUM-Ereignismetadaten.

Sie können den CloudWatch RUM-Webclient auch verwenden, um benutzerdefinierte Metadaten zu CloudWatch RUM-Ereignissen hinzuzufügen. Die benutzerdefinierten Metadaten können Sitzungsattribute und Seitenattribute enthalten.

Um benutzerdefinierte Metadaten hinzuzufügen, müssen Sie Version 1.10.0 oder höher des CloudWatch RUM-Webclients verwenden.

Anforderungen und Syntax

Jedes Ereignis kann bis zu 10 benutzerdefinierte Attribute in den Metadaten enthalten. Die Syntaxanforderungen für benutzerdefinierte Attribute lauten wie folgt:

  • Schlüssel

    • Maximal 128 Zeichen

    • Kann alphanumerische Zeichen, Doppelpunkte (:) und Unterstriche (_) enthalten

    • Darf nicht mit aws: beginnen.

    • Darf nicht vollständig aus einem der reservierten Schlüsselwörter bestehen, die im folgenden Abschnitt aufgeführt sind. Kann diese Schlüsselwörter als Teil eines längeren Schlüsselnamens verwenden.

  • Werte

    • Maximal 256 Zeichen

    • Müssen Zeichenfolgen, Zahlen oder boolesche Werte sein

Reservierte Schlüsselwörter

Sie können die folgenden reservierten Schlüsselnamen nicht als vollständige Schlüsselnamen verwenden. Sie können die folgenden Schlüsselwörter als Teil eines längeren Schlüsselnamens, wie z. B. applicationVersion, verwenden.

  • browserLanguage

  • browserName

  • browserVersion

  • countryCode

  • deviceType

  • domain

  • interaction

  • osName

  • osVersion

  • pageId

  • pageTags

  • pageTitle

  • pageUrl

  • parentPageId

  • platformType

  • referrerUrl

  • subdivisionCode

  • title

  • url

  • version

Anmerkung

CloudWatch RUM entfernt benutzerdefinierte Attribute aus RUM-Ereignissen, wenn ein Attribut einen ungültigen Schlüssel oder Wert enthält oder wenn das Limit von 10 benutzerdefinierten Attributen pro Ereignis bereits erreicht wurde.

Sitzungsattribute hinzufügen

Wenn Sie benutzerdefinierte Sitzungsattribute konfigurieren, werden sie allen Ereignissen in einer Sitzung hinzugefügt. Sie konfigurieren Sitzungsattribute entweder während der Initialisierung des CloudWatch RUM-Webclients oder zur Laufzeit mithilfe des addSessionAttributes Befehls.

Beispielsweise können Sie die Version Ihrer Anwendung als Sitzungsattribut hinzufügen. Anschließend können Sie in der CloudWatch RUM-Konsole Fehler nach Version filtern, um herauszufinden, ob eine erhöhte Fehlerrate mit einer bestimmten Version Ihrer Anwendung zusammenhängt.

Hinzufügen eines Sitzungsattributs bei der Initialisierung, NPM-Beispiel

Der fett gedruckte Codeabschnitt fügt das Sitzungsattribut hinzu.

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 }

Hinzufügen eines Sitzungsattributs zur Laufzeit, NPM-Beispiel

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

Hinzufügen eines Sitzungsattributs bei der Initialisierung, Beispiel für eingebettetes Skript

Der fett gedruckte Codeabschnitt fügt das Sitzungsattribut hinzu.

<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>

Hinzufügen eines Sitzungsattributs zur Laufzeit, Beispiel für eingebettetes Skript

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

Seitenattribute hinzufügen

Wenn Sie benutzerdefinierte Seitenattribute konfigurieren, werden sie allen Ereignissen in einer Sitzung hinzugefügt. Sie konfigurieren Seitenattribute entweder während der Initialisierung des CloudWatch RUM-Webclients oder zur Laufzeit mithilfe des recordPageView Befehls.

Beispielsweise können Sie Ihre Seitenvorlage als Seitenattribut hinzufügen. Anschließend können Sie in der CloudWatch RUM-Konsole Fehler nach Seitenvorlagen filtern, um herauszufinden, ob eine erhöhte Fehlerrate mit einer bestimmten Seitenvorlage Ihrer Anwendung verknüpft ist.

Hinzufügen eines Seitenattributs bei der Initialisierung, NPM-Beispiel

Der fett gedruckte Codeabschnitt fügt das Seitenattribut hinzu.

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);

Hinzufügen eines Seitenattributs zur Laufzeit, NPM-Beispiel

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

Hinzufügen eines Seitenattributs bei der Initialisierung, Beispiel für eingebettetes Skript

Der fett gedruckte Codeabschnitt fügt das Seitenattribut hinzu.

<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>

Hinzufügen eines Seitenattributs zur Laufzeit, Beispiel für eingebettetes Skript

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

Filtern nach Metadatenattributen in der Konsole

Verwenden Sie die Suchleiste, um die Visualisierungen in der CloudWatch RUM-Konsole mit einem beliebigen integrierten oder benutzerdefinierten Metadatenattribut zu filtern. In der Suchleiste können Sie bis zu 20 Filterbegriffe in der Form key=value (Schlüssel=Wert) angeben, die auf die Visualisierungen angewendet werden sollen. Um beispielsweise Daten nur für den Chrome-Browser zu filtern, könnten Sie den Filterbegriff browserName=Chrome (Browsername=Chrome) hinzufügen.

Standardmäßig ruft die CloudWatch RUM-Konsole die 100 häufigsten Attributschlüssel und -werte ab, die in der Dropdownliste in der Suchleiste angezeigt werden. Um weitere Metadatenattribute als Filterbegriffe hinzuzufügen, geben Sie den vollständigen Attributschlüssel und -wert in die Suchleiste ein.

Ein Filter kann bis zu 20 Filterbegriffe enthalten und Sie können bis zu 20 Filter pro Anwendungsmonitor speichern. Wenn Sie einen Filter speichern, wird er in der Dropdownliste Saved filters (Gespeicherte Filter). Sie können einen gespeicherten Filter auch löschen.