interaction (API SPA)

Syntaxe

newrelic.interaction([JSON object $options])

Renvoie un nouvel objet handle lié à l'interaction SPA actuelle, ou une nouvelle interaction s'il n'en existe pas.

Exigences

• Agent navigateur Pro+SPA (v963 ou supérieur)

• Le paramètre $options nécessite v1.285.0+

• Si vous utilisez npm pour installer l'agent du navigateur, vous devez activer la fonctionnalité spa lors de l'instanciation de la classe BrowserAgent . Dans l'éventail features , ajoutez ce qui suit :

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

  Copier

  Pour plus d'informations, consultez la documentation d'installation du navigateur npm.

Description

L'appel de monitoring SPA interaction() renvoie un nouveau handle lié à l'interaction en cours.

• New interaction: Si cette fonction est appelée et qu'aucune interaction n'est ouverte ou en cours, une nouvelle interaction personnalisée est créée.

  • Une interaction personnalisée suivra toujours l'heuristique par défaut et se fermera automatiquement lors de la prochaine navigation complète, sauf si waitForEnd est spécifié.

• New object: Si cette fonction est appelée alors qu'une interaction est en cours, un nouveau handle référençant l'interaction en cours est créé.

  • Plusieurs poignées peuvent pointer vers la même interaction. Chaque appel .interaction crée un nouveau handle.
  • Le handle pointera vers l'interaction ouverte, qu'elle ait commencé à partir d'un événement utilisateur comme un click ou à partir d'un appel .interaction déclenché par l'API précédent.
  • Cette fonction ne peut pas remplacer son propre effet ou celui d'un événement utilisateur. Autrement dit, il ne peut pas écraser une interaction ouverte existante par une nouvelle interaction pilotée par l'API.

Paramètres

Valeurs de retour

Cette méthode renvoie un objet JS natif qui pointe vers un événementBrowserInteraction potentiel. Chaque fois que cette méthode est appelée pour le même BrowserInteraction alors qu'elle n'est pas encore terminée, un nouvel objet est créé, mais il fait toujours référence à la même interaction.

Exemples

Les méthodes API SPA doivent être utilisées sur newrelic.interaction(). Vous pouvez affecter la valeur renvoyée ou le handle à une autre variable pour une utilisation ultérieure. Par exemple:

let myInteraction = newrelic.interaction();
...
myInteraction.save();

Bien que le handle nommé puisse être enregistré et utilisé en dehors d'une interaction, notez que les méthodes SPA n'auront aucun effet une fois l'interaction terminée.

La durée de l’interaction peut également être personnalisée à l’aide de la méthode suivante :

// Say an interaction is already open from a user click.
const userInteraction = newrelic.interaction({ waitForEnd: true }); // grabs the current interaction in-progress & keep it open
// URL changes & DOM is modified. Because of those condition being met, interaction will be saved but is kept open.
fetch('myurl.com/endpoint').then(() => userInteraction.end()) // associate this request to the interaction before completing this BrowserInteraction
 
const myCustomIxn = newrelic.interaction({ waitForEnd: true }) // create a new api-triggered interaction
// This interaction will be kept open indefinitely until `.end` is called, and no new interaction will start, custom or otherwise. AjaxRequest will continue to buffer under this interaction until it is closed.