Performance Monitoring recopila seguimientos para ayudarle a monitorear el rendimiento de su aplicación. Un seguimiento es un informe de datos de rendimiento capturados entre dos puntos en el tiempo en su aplicación.
Puede crear sus propios seguimientos para monitorear los datos de rendimiento asociados con un código específico en su aplicación. Con un seguimiento de código personalizado , puede medir cuánto tiempo le toma a su aplicación completar una tarea específica o un conjunto de tareas, por ejemplo, cargar un conjunto de imágenes o consultar su base de datos.
La métrica predeterminada para un seguimiento de código personalizado es su "duración" (el tiempo entre los puntos de inicio y finalización del seguimiento), pero también puede agregar métricas personalizadas .
En su código, define el principio y el final de un seguimiento de código personalizado utilizando las API proporcionadas por el SDK de Performance Monitoring.
Los seguimientos de código personalizado se pueden iniciar en cualquier momento después de su creación y son seguros para subprocesos.
Dado que la métrica predeterminada recopilada para estos seguimientos es la "duración", a veces se les denomina "seguimientos de duración".
Puede ver los datos de estos seguimientos en la subpestaña Seguimientos personalizados de la tabla de seguimientos, que se encuentra en la parte inferior del panel de Rendimiento (obtenga más información sobre el uso de la consola más adelante en esta página).
Atributos predeterminados, atributos personalizados y métricas personalizadas
Para los seguimientos de código personalizados, Performance Monitoring registra automáticamente los atributos predeterminados (metadatos comunes como la versión de la aplicación, el país, el dispositivo, etc.) para que puedas filtrar los datos para el seguimiento en Firebase console. También puede agregar y monitorear atributos personalizados (como nivel de juego o propiedades de usuario).
Además, puede configurar un seguimiento de código personalizado para registrar métricas personalizadas para eventos relacionados con el rendimiento que ocurren dentro del alcance del seguimiento. Por ejemplo, puede crear una métrica personalizada para la cantidad de aciertos y errores de caché o la cantidad de veces que la interfaz de usuario deja de responder durante un período de tiempo considerable.
Los atributos y métricas personalizados se muestran en Firebase console junto con los atributos y métricas predeterminados para el seguimiento.
Agregar seguimientos de código personalizados
Utilice la API de seguimiento de monitoreo de rendimiento para agregar seguimientos de código personalizados para monitorear el código de una aplicación específica.
Tenga en cuenta lo siguiente:
- Una aplicación puede tener varios seguimientos de código personalizado.
- Se puede ejecutar más de un seguimiento de código personalizado al mismo tiempo.
- Los nombres para los seguimientos de código personalizado deben cumplir los siguientes requisitos: sin espacios en blanco al principio ni al final, sin carácter de guión bajo (
_) al inicio y una longitud máxima de 100 caracteres. - Los seguimientos de código personalizados admiten la adición de métricas y atributos personalizados .
Para iniciar y detener un seguimiento de código personalizado, ajuste el código que desea rastrear con un código similar al siguiente:
Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();
// Code you want to trace
await customTrace.stop();
Agregue métricas personalizadas a seguimientos de código personalizados
Utilice la API de seguimiento de supervisión de rendimiento para agregar métricas personalizadas a seguimientos de código personalizados.
Tenga en cuenta lo siguiente:
- Los nombres de las métricas personalizadas deben cumplir los siguientes requisitos: sin espacios en blanco al principio ni al final, sin carácter de guión bajo (
_) al inicio y una longitud máxima de 100 caracteres. - Cada seguimiento de código personalizado puede registrar hasta 32 métricas (incluida la métrica de Duración predeterminada).
Para agregar una métrica personalizada, agregue una línea de código similar a la siguiente cada vez que ocurra el evento. Por ejemplo, esta métrica personalizada cuenta los eventos relacionados con el rendimiento que ocurren en su aplicación, como aciertos de caché o reintentos.
Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();
// Code you want to trace
customTrace.incrementMetric("metric-name", 1);
// More code
await customTrace.stop();
Cree atributos personalizados para seguimientos de código personalizados
Para usar atributos personalizados, agregue código a su aplicación que defina el atributo y lo asocie con un seguimiento de código personalizado específico. Puede establecer el atributo personalizado en cualquier momento entre el momento en que se inicia el seguimiento y el momento en que se detiene.
Tenga en cuenta lo siguiente:
Los nombres de los atributos personalizados deben cumplir los siguientes requisitos: sin espacios en blanco al principio ni al final, sin carácter de subrayado (
_) al inicio y una longitud máxima de 32 caracteres.Cada seguimiento de código personalizado puede registrar hasta 5 atributos personalizados.
No debes utilizar atributos personalizados que contengan información que identifique personalmente a un individuo ante Google.
Performance Monitoring no recopila por sí misma ninguna información de identificación personal (PII), como nombres, direcciones de correo electrónico o números de teléfono. Los desarrolladores pueden recopilar datos adicionales mediante Performance Monitoring creando atributos personalizados en seguimientos de código personalizados. Dichos datos recopilados a través del Monitoreo del desempeño no deben contener información que identifique personalmente a un individuo ante Google.
A continuación se muestra un ejemplo de un mensaje de registro que no contiene información de identificación personal:
customTrace.putAttribute("experiment", "A"); // OKA continuación se muestra un ejemplo que contiene información de identificación personal (no utilice este tipo de atributo personalizado en su aplicación):
customTrace.putAttribute(("email", user.getEmailAddress()); // Don't do this!Los datos que exponen información de identificación personal están sujetos a eliminación sin previo aviso.
Trace trace = FirebasePerformance.instance.newTrace("test_trace");
// Update scenario.
trace.putAttribute("experiment", "A");
// Reading scenario.
String? experimentValue = trace.getAttribute("experiment");
// Delete scenario.
trace.removeAttribute("experiment");
// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();
Realice un seguimiento, vea y filtre datos de rendimiento
Realice un seguimiento de métricas específicas en su panel
Para conocer las tendencias de sus métricas clave, agréguelas a su tablero de métricas en la parte superior del panel de Rendimiento . Puede identificar rápidamente regresiones al ver los cambios semana tras semana o verificar que los cambios recientes en su código estén mejorando el rendimiento.
Para agregar una métrica a su tablero de métricas, vaya al panel de rendimiento en Firebase console y luego haga clic en la pestaña Panel . Haga clic en una tarjeta de métrica vacía, luego seleccione una métrica existente para agregarla a su tablero. Haga clic en los puntos suspensivos verticales ( ⋮ ) en una tarjeta de métrica completa para ver más opciones, como reemplazar o eliminar una métrica.
El tablero de métricas muestra los datos de métricas recopilados a lo largo del tiempo, tanto en forma gráfica como como un cambio porcentual numérico.
Obtenga más información sobre el uso del panel .
Ver trazas y sus datos.
Para ver sus seguimientos, vaya al panel de rendimiento en Firebase console, desplácese hacia abajo hasta la tabla de seguimientos y luego haga clic en la subpestaña correspondiente. La tabla muestra algunas métricas principales para cada seguimiento e incluso puede ordenar la lista por el cambio porcentual de una métrica específica.
Si hace clic en el nombre de un seguimiento en la tabla de seguimientos, puede hacer clic en varias pantallas para explorar el seguimiento y profundizar en las métricas de interés. En la mayoría de las páginas, puede utilizar el botón Filtrar (arriba a la izquierda de la pantalla) para filtrar los datos por atributo, por ejemplo:
- Filtre por versión de la aplicación para ver datos sobre una versión anterior o su última versión
- Filtre por dispositivo para saber cómo los dispositivos más antiguos manejan su aplicación
- Filtre por país para asegurarse de que la ubicación de su base de datos no afecte a una región específica
Obtenga más información sobre cómo ver datos de sus seguimientos .
Próximos pasos
Obtenga más información sobre el uso de atributos para examinar los datos de rendimiento.
Obtenga más información sobre cómo realizar un seguimiento de los problemas de rendimiento en Firebase console.
Configure alertas para cambios de código que degraden el rendimiento de su aplicación. Por ejemplo, puede configurar una alerta por correo electrónico para su equipo si la duración de un seguimiento de código personalizado específico excede un umbral que usted establezca.