Sintaxis
newrelic.start(value: string[]|undefined)
API browser utilizada para iniciar la característica del agente cuando se ejecuta en un estado diferido.
Requisitos
Browser Lite, Pro o Pro+SPA agente (v1.239.0 o superior)
Importante
La configuración requerida para usar esta API no está conectada actualmente al sistema de despliegue más grande dentro de New Relic. Como tal, llamar a esta API solo tendrá efecto al copiar/pegar o en la instalación browser npm hasta que se realicen más cambios.
Descripción
La característica se puede cargar en un estado deferred
, que se puede controlar estableciendo la propiedad autoStart
de la característica apropiada en false
en el bloque de configuración NREUM.init.<feature>
utilizado por el agente. Este estado característico significa que el evento se observará y almacenará en el agente, pero no se recopilará en NR1 hasta que se le indique que lo haga con el método API .start()
. Consulte Nombres de características para obtener una lista de nombres de características. Consulte Ejemplos para ver ejemplos que muestran cómo configurar una característica en un estado diferido.
Al ejecutar esta función con un valor válido, el agente del navegador iniciará las características relevantes que hayan sido diferidas por la configuración autoStart: false
. Si se llama sin argumentos, el método iniciará todas las características que se hayan aplazado. Si se llama con una lista de cadenas que representan los nombres de las características, se iniciarán los nombres de las características que coincidan con las cadenas. Consulte Nombres de características para obtener una lista de nombres de características.
Parámetros
Parámetro | Descripción |
---|---|
cadena [] O indefinido | Opcional. Una matriz de cadenas relacionadas con una lista de características que se iniciarán. |
Nombres característicos
- ajax
- jserrors
- métrica
- generic_events
- page_view_event
- page_view_timing
- session_replay
- session_trace
- spa
Casos de uso
- Quiere esperar para recopilar datos hasta que un usuario haya dado su consentimiento con un modal en su sitio
- Desea esperar para recopilar datos hasta que su sitio haya configurado un atributo personalizado
Ejemplos
Cargando todas las características en estado diferido (copiar/pegar, NPM)
// Change the init portion of the configuration block to add `autoStart: false` to any features desired to load in a deferred stateNREUM.init = { // feature configurations ajax: {autoStart: false}, jserrors: {autoStart: false}, metrics: {autoStart: false}, generic_events: {autoStart: false}, page_view_event: {autoStart: false}, page_view_timing: {autoStart: false}, session_replay: {autoStart: false}, session_trace: {autoStart: false}, spa: {autoStart: false}, // other configurations // ...}
"Iniciando" todas las características diferidas
newrelic.start()// all deferred features in the agent will now start harvesting