Tentukan metadata kustom - Amazon CloudWatch

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Tentukan metadata kustom

CloudWatch RUM melampirkan data tambahan ke setiap peristiwa sebagai metadata. Metadata peristiwa terdiri atas atribut dalam bentuk pasangan nilai kunci. Anda dapat menggunakan atribut ini untuk mencari atau memfilter peristiwa di konsol CloudWatch RUM. Secara default, CloudWatch RUM membuat beberapa metadata untuk Anda. Untuk informasi selengkapnya tentang metadata instans, silakan lihat Metadata peristiwa RUM.

Anda juga dapat menggunakan klien web CloudWatch RUM untuk menambahkan metadata khusus ke acara CloudWatch RUM. Metadata kustom dapat mencakup atribut sesi dan atribut halaman.

Untuk menambahkan metadata kustom, Anda harus menggunakan versi 1.10.0 atau yang lebih baru dari klien web RUM. CloudWatch

Persyaratan dan sintaks

Setiap peristiwa dapat menyertakan sebanyak 10 atribut khusus dalam metadata. Persyaratan sintaks untuk atribut kustom adalah sebagai berikut:

  • Kunci

    • Maksimal 128 karakter

    • Dapat menyertakan karakter alfanumerik, titik bawah (:), dan garis bawah (_)

    • Tidak bisa mulai dengan aws:.

    • Tidak dapat sepenuhnya terdiri atas salah satu kata kunci yang dicadangkan yang tercantum di bagian berikut. Dapat menggunakan kata kunci tersebut sebagai bagian dari nama kunci yang lebih panjang.

  • Nilai-nilai

    • Maksimal 256 karakter

    • Harus berupa string, angka, atau nilai Boolean

Kata Kunci Cadangan

Anda tidak dapat menggunakan kata kunci berikut sebagai nama kunci lengkap. Anda dapat menggunakan kata kunci berikut sebagai bagian dari nama kunci yang lebih panjang, seperti applicationVersion.

  • browserLanguage

  • browserName

  • browserVersion

  • countryCode

  • deviceType

  • domain

  • interaction

  • osName

  • osVersion

  • pageId

  • pageTags

  • pageTitle

  • pageUrl

  • parentPageId

  • platformType

  • referrerUrl

  • subdivisionCode

  • title

  • url

  • version

catatan

CloudWatch RUM menghapus atribut kustom dari peristiwa RUM jika atribut menyertakan kunci atau nilai yang tidak valid, atau jika batas 10 atribut kustom per peristiwa telah tercapai.

Tambahkan atribut sesi

Jika Anda mengonfigurasi atribut sesi kustom, atribut tersebut akan ditambahkan ke semua peristiwa dalam sesi. Anda mengonfigurasi atribut sesi baik selama inisialisasi klien web CloudWatch RUM atau saat runtime dengan menggunakan perintah. addSessionAttributes

Sebagai contoh, Anda dapat menambahkan versi aplikasi Anda sebagai atribut sesi. Kemudian, di konsol CloudWatch RUM, Anda dapat memfilter kesalahan berdasarkan versi untuk mengetahui apakah tingkat kesalahan yang meningkat dikaitkan dengan versi tertentu dari aplikasi Anda.

Menambahkan atribut sesi pada inisialisasi, contoh NPM

Bagian kode dalam huruf tebal menambahkan atribut sesi.

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 }

Menambahkan atribut sesi pada runtime, contoh NPM

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

Menambahkan atribut sesi pada inisialisasi, contoh skrip tersemat

Bagian kode dalam huruf tebal menambahkan atribut sesi.

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

Menambahkan atribut sesi pada runtime, contoh skrip tersemat

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

Menambahkan atribut halaman

Jika Anda mengonfigurasi atribut sesi kustom, atribut tersebut akan ditambahkan ke semua peristiwa di halaman saat ini. Anda mengonfigurasi atribut halaman baik selama inisialisasi klien web CloudWatch RUM atau saat runtime dengan menggunakan perintah. recordPageView

Sebagai contoh, Anda dapat menambahkan template Anda sebagai atribut halaman. Kemudian, di konsol CloudWatch RUM, Anda dapat memfilter kesalahan berdasarkan templat halaman untuk mengetahui apakah tingkat kesalahan yang meningkat dikaitkan dengan templat halaman tertentu dari aplikasi Anda.

Menambahkan atribut halaman pada inisialisasi, contoh NPM

Bagian kode dalam huruf tebal menambahkan atribut halaman.

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

Menambahkan atribut halaman pada runtime, contoh NPM

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

Menambahkan atribut halaman pada inisialisasi, contoh skrip yang ditanamkan

Bagian kode dalam huruf tebal menambahkan atribut halaman.

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

Menambahkan atribut halaman pada runtime, contoh skrip yang ditanamkan

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

Memfilter berdasarkan atribut metadata di konsol

Untuk memfilter visualisasi di konsol CloudWatch RUM dengan atribut metadata bawaan atau kustom, gunakan bilah pencarian. Di bilah pencarian, Anda dapat menentukan sebanyak 20 istilah filter dalam bentuk key=value untuk diterapkan pada visualisasi. Misalnya, untuk memfilter data hanya untuk browser Chrome, Anda dapat menambahkan istilah filter browserName=Chrome.

Secara default, konsol CloudWatch RUM mengambil 100 kunci dan nilai atribut paling umum untuk ditampilkan di dropdown di bilah pencarian. Untuk menambahkan lebih banyak atribut metadata sebagai istilah filter, masukkan kunci atribut lengkap dan nilai ke dalam bilah pencarian.

Filter dapat mencakup sebanyak 20 istilah filter, dan Anda dapat menyimpan hingga 20 filter per monitor aplikasi. Saat Anda menyimpan filter, itu disimpan di dropdown Filter yang disimpan. Anda juga dapat menghapus filter yang disimpan.