createTracer (SPA API)

Sintaxis

newrelic.interaction().createTracer(string $name[, function $callback])

Cotiza los subcomponentes de una interacción SPA por separado, incluido el tiempo de espera y el tiempo de ejecución de JS.

Requisitos

• Browser Pro o agente Pro+SPA (v963 o superior)

• Si está utilizando npm para instalar el agente del navegador, debe habilitar la característica spa al crear una instancia de la clase BrowserAgent . En la matriz features , agregue lo siguiente:

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

  Copia

  Para obtener más información, consulte la documentación de instalación del navegador npm.

Descripción

Este método proporciona una forma de cronometrar los subcomponentes de una interacción SPA por separado en browser. Cada subcomponente medirá:

• Tiempo de espera hasta que se ejecute la devolución de llamada
• Tiempo de ejecución de JS de devolución de llamada una vez que se invoca

Este método también se puede utilizar para cerrar la brecha asincrónica creada por métodos asíncronos no instrumentados.

Si se guarda la interacción actual, New Relic creará un eventoBrowserTiming .

El método createTracer() devuelve un método de devolución de llamada ajustado, que debes invocar desde tu código. La devolución de llamada envuelta hará tres cosas cuando se invoque:

1. Registra el final de la parte asíncrona del rastreador personalizado.
2. Ejecuta la devolución de llamada original pasada a createTracer() con los mismos argumentos y contexto.
3. Veces la ejecución de la devolución de llamada original.

Un BrowserInteraction que ejecuta createTracer() creará un eventoBrowserTiming . Cualquier XHR nuevo o traza personalizada creada durante la devolución de llamada se incluirá como parte de la interacción.

Una interacción no se considerará completa hasta que finalice todo su rastreador. Esto es lo que permite al rastreador incluir funciones asíncronas que el agente del navegador no maneja de forma predeterminada.

Parámetros

Valores de retorno

Devuelve un método que envuelve la devolución de llamada original. Cuando se invoca este método, llama a la devolución de llamada original y finaliza el tiempo asíncrono.

Ejemplos

Crear rastreador

Si simplemente desea medir cuánto tiempo tarda una llamada a una función de JavaScript en particular, puede pasar la función a createTracer() como una devolución de llamada. Esto invoca inmediatamente la devolución de llamada del contenedor devuelto:

newrelic
  .interaction()
  .createTracer('customSegment', function myCallback () {
    // ... do your work ...
  })();

En este escenario, el rastreador personalizado resultante tendrá una duración de espera asíncrona insignificante, así como una duración síncrona igual al tiempo de ejecución de myCallback().

Traza un API asincrónico no instrumentado

De forma predeterminada, el agente del navegador incluye muchas de las funciones asincrónicas más comunes (como setTimeout()). Sin embargo, hay algunas funciones que no se manejan automáticamente (por ejemplo, requestAnimationFrame()). Además, se producen algunos casos en los que no se puede determinar fácilmente la causalidad (por ejemplo, una implementación RPC personalizada a través de websockets). Para estos casos, puede utilizar createTracer() para asegurarse de que la devolución de llamada a estas funciones no instrumentadas se considere parte de la interacción.

El uso de createTracer() no es necesario para ningún sistema de programación asíncrono basado en API asíncronas empaquetadas de forma nativa por el agente del navegador, como setTimeout(), setImmediate(), Promise(), fetch() y XMLHttpRequest(). El agente del navegador salvará automáticamente los límites asíncronos creados por estas API.

En el código de ejemplo siguiente, tiene una función, doAsyncWork(), que acepta una devolución de llamada y la ejecuta de forma asincrónica en algún momento en el futuro. Desea medir tanto el tiempo entre el momento en que se invoca doAsyncWork() y el momento en que la devolución de llamada comienza a ejecutarse (el tiempo de espera asíncrono) y el tiempo necesario para ejecutar la devolución de llamada (el tiempo de devolución de llamada sincrónica).

var wrappedCallback = newrelic
  .interaction()
  .createTracer('customSegment', doTheWork);

doAsyncWork(wrappedCallback);

function doTheWork() {
  // ... do your work ...
}

Aquí hay una línea de tiempo de eventos para el tiempo del rastreador: