setUserId

Sintaxe

newrelic.setUserId(value: string|null)

Adiciona uma string de identificador definida pelo usuário ao evento subsequente na página.

Requisitos

• Agente browser Lite, Pro ou Pro+SPA (v1.230.0 ou superior)

• Se estiver usando o npm para instalar o agente browser, você deverá ativar pelo menos um recurso ao instanciar a classe BrowserAgent . Por exemplo, adicione o seguinte na matrizfeatures :

  import { Metrics } from '@newrelic/browser-agent/features/metrics'
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      Metrics
    ]
  }

  Copiar

  Para obter mais informações, consulte a documentação de instalação do browser npm.

Descrição

Ao executar esta função com um valor válido, o agente browser registra o valor como o atributo enduser.id com todos os eventos até que o atributo seja desdefinido manualmente. O identificador será armazenado no browser, para que as visitas subsequentes à página da mesma origem o anexem no evento within a session span. Observe que esta funcionalidade pode variar dependendo das configurações de privacidade do browser do usuário final. Se esta função for chamada com value = null, qualquer ID de usuário existente será excluído de both o evento e o armazenamento da página atual.

O ID será anexado ao evento JavaScriptError em particular para uso Errors Inbox . Se você estiver usando o monitoramento SPA com uma versão de agente compatível, o ID do usuário também será incluído no evento newrelic.interaction .

A partir da versão 1.307.0 do agente, se o atributo resetSession estiver definido como true, quando o identificador do usuário for atualizado, a sessão do agente do navegador será reiniciada. No entanto, a sessão não é reiniciada se o atributo enduser.id ainda não estiver especificado.

Parâmetro

Exemplos - um usuário por máquina/dispositivo

Marcando o início de uma sessão do usuário

newrelic.setUserId('user-1234')

Parar de atribuir eventos ao usuário atual

// Note: events are still attributed to the same session id
newrelic.setUserId(null)

Exemplos - vários usuários por máquina/dispositivo

Marcando o início de uma sessão do usuário

// Note: associates the specified userid to the current session id
newrelic.setUserId('user-1234', true)

Mudando para outra sessão de usuário

// Note: resets the session, events will be attributed to a new user + session id
newrelic.setUserId('user-567', true)

Encerrando uma sessão de usuário

// Note: resets the session, effectively ending it.  Events will be attributed to a new session id going forward.
newrelic.setUserId(null, true)