Especificar metadados personalizados

O CloudWatch RUM anexa dados adicionais a cada evento como metadados. Metadados de eventos consistem em atributos sob a forma de pares chave-valor. Você pode usar esses atributos para pesquisar ou filtrar eventos no console do CloudWatch RUM. Por padrão, o CloudWatch RUM cria alguns metadados para você. Para obter mais informações sobre metadados padrão, consulte Metadados de evento do RUM.

Você também pode usar o cliente da Web do CloudWatch RUM para adicionar metadados personalizados aos eventos do CloudWatch RUM. Os metadados personalizados podem incluir atributos de sessão e atributos de página.

Para adicionar metadados personalizados, você deve usar a versão 1.10.0 ou posterior do cliente da Web do CloudWatch RUM.

Requisitos e sintaxe

Cada evento pode incluir até 10 atributos personalizados nos metadados. Os requisitos de sintaxe para atributos personalizados são os seguintes:

Palavras-chave reservadas

Você não pode usar as palavras-chave reservadas a seguir como nomes de chave inteiros. Você pode usar as palavras-chave a seguir como parte de um nome de chave mais longo, como applicationVersion.

Adicionar atributos de sessão

Se você configurar atributos de sessão personalizados, eles serão adicionados a todos os eventos de uma sessão. Você configura os atributos de sessão durante a inicialização do cliente da Web do CloudWatch RUM ou no runtime usando o comando addSessionAttributes.

Por exemplo, você pode adicionar a versão da aplicação como um atributo de sessão. Em seguida, no console do CloudWatch RUM, você pode filtrar os erros por versão para descobrir se uma taxa de erro maior está associada a uma determinada versão da aplicação.

Adicionar um atributo de sessão na inicialização, exemplo de NPM

A seção de código em negrito adiciona o atributo de sessão.

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
}

Adicionar um atributo de sessão no runtime, exemplo de NPM

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

Adicionar um atributo de sessão na inicialização, exemplo de script integrado

A seção de código em negrito adiciona o atributo de sessão.

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

Adicionar um atributo de sessão no runtime, exemplo de script integrado

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

Adicionar atributos de página

Se você configurar atributos de página personalizados, eles serão adicionados a todos os eventos na página atual. Você configura os atributos de página durante a inicialização do cliente da Web do CloudWatch RUM ou no runtime usando o comando recordPageView.

Por exemplo, você pode adicionar seu modelo de página como um atributo de página. Em seguida, no console do CloudWatch RUM, você pode filtrar os erros por modelos de página para descobrir se uma taxa de erro maior está associada a um determinado modelo de página da aplicação.

Adicionar um atributo de página na inicialização, exemplo de NPM

A seção de código em negrito adiciona o atributo de página.

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

Adicionar um atributo de página no runtime, exemplo de NPM

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

Adicionar um atributo de página na inicialização, exemplo de script integrado

A seção de código em negrito adiciona o atributo de página.

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

Adicionar um atributo de página no runtime, exemplo de script integrado

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

Filtrar por atributos de metadados no console

Para filtrar as visualizações no console do CloudWatch RUM com qualquer atributo de metadados integrado ou personalizado, use a barra de pesquisa. Na barra de pesquisa, você pode especificar até 20 termos de filtro sob a forma de chave=valor para aplicar às visualizações. Por exemplo, para filtrar dados somente para o navegador Chrome, você pode adicionar o termo de filtro browserName=Chrome.

Por padrão, o console do CloudWatch RUM recupera as 100 chaves de atributos e valores mais comuns para serem exibidos no menu suspenso na barra de pesquisa. Para adicionar mais atributos de metadados como termos de filtro, insira a chave e o valor do atributo inteiros na barra de pesquisa.

Um filtro pode incluir até 20 termos de filtro e você pode salvar até 20 filtros por monitor de aplicações. Quando você salva um filtro, ele é salvo na lista suspensa Saved filters (Filtros salvos). Também é possível excluir um filtro salvo.