Syntaxe
newrelic.start()
API Browser utilisée pour démarrer la fonctionnalité de l'agent lors de l'exécution dans un état différé.
Exigences
Agent navigateur Lite, Pro ou Pro+SPA (v1.239.0 ou supérieur)
Important
La configuration requise pour utiliser cette API n'est actuellement pas connectée au système de déploiement plus vaste de New Relic. En tant que tel, l'appel de cette API n'aura d'effet que sur les installations par copier/coller ou par navigateur npm jusqu'à ce que d'autres modifications soient apportées.
Description
La fonctionnalité peut être chargée dans un état deferred
, qui peut être contrôlé en définissant la propriété autoStart
de la fonctionnalité appropriée sur false
dans le bloc configuration NREUM.init.<feature>
utilisé par l'agent. Cet état de fonctionnalité signifie que l'événement sera observé et stocké dans l'agent, mais ne sera pas récolté sur NR1 jusqu'à ce qu'il soit indiqué de le faire avec la méthode API .start()
. Voir Noms des fonctionnalités pour une liste des noms de fonctionnalités. Voir Exemples pour des exemples montrant comment définir une fonctionnalité dans un état différé.
Lors de l'exécution de cette fonction avec une valeur valide, l'agent du navigateur démarrera la fonctionnalité pertinente qui a été différée par la configuration autoStart: false
. Lorsqu'elle est appelée, la méthode démarrera toutes les fonctionnalités qui ont été différées. Consultez les noms de fonctionnalités pour obtenir une liste des noms de fonctionnalités qui peuvent être démarrés dans un état différé.
Noms des fonctionnalités
ajax
jserrors
metrics
generic_events
page_view_event
page_view_timing
session_replay
session_trace
spa
Important
Le corps de la réponse de la récolte
page_view_event
contient des informations critiques pour l'exécution de l'autre fonctionnalité. Le report du début depage_view_event
entraînera l'attente de toutes les autres fonctionnalités jusqu'à ce que.start()
soit appelé.
Cas d'utilisation
- Vous souhaitez attendre de récolter des données jusqu'à ce qu'un utilisateur ait donné son consentement avec une fenêtre modale sur votre site
- Vous souhaitez attendre pour récolter des données que votre site ait défini des attributs personnalisés
Exemples
Chargement de toutes les fonctionnalités dans un état différé (copier/coller, 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 // ...}
"Démarrage" toutes fonctionnalités différées
newrelic.start()// all deferred features in the agent will now start harvesting