Monitor your web page's total memory usage with meterMemory ()

Learn how to measure the memory usage of your web page in production to detect regressions.

Apr 13, 2020

Los navegadores gestionan la memoria de las páginas web de forma automática. Siempre y cuando una página web crea un objeto, el navegador asigna una parte de la memoria «debajo del capó» para guardar el objeto. Ya que la memoria es un recurso finito, el navegador realiza una recolección de basura para detectar cuando un objeto ya no hace falta y para liberar el bloque de memoria subyacente. A pesar de todo, la detección no es perfecta y
It was tested que la detección perfecta es una tarea imposible. Por ende, los navegadores aproximan la noción de «un objeto hace falta» con la noción de «un objeto es alcanzable». Si la página web no puede llegar a un objeto a través de sus variables y los campos de otros objetos accesibles, entonces el navegador puede recuperar el objeto de forma segura. La diferencia entre estas dos nociones conduce a pérdidas de memoria como se ilustra en el siguiente ejemplo.

const object = { a : new Array ( 1000 ) , b : new Array ( 2000 ) } ;
 setInterval ( ( ) => console . log ( object . a ) , 1000 ) ;

Here the largest matrix b ya no hace falta, pero el navegador no lo recupera debido a que aún es alcanzable a través de object.b en la devolución de llamada. Por ende, se filtra la memoria de la matriz más grande.

Memory leaks are prevalent on the web. Es fácil introducir uno olvidándose de anular el registro de un detector de eventos, capturando accidentalmente objetos de un iframe, no cerrando un empleado, acumulando objetos en matrices, etc. Si una página web tiene pérdidas de memoria, su uso de memoria aumenta con el tiempo y la página web parece lenta e hinchada para los usuarios.

El primer paso para solucionar este problema es medirlo. El nuevo
performance.measureMemory () API posibilita a los desarrolladores medir el uso de memoria de sus páginas web en producción y así detectar pérdidas de memoria que se escapan a través de pruebas locales.

How is it performance.measureMemory () distinto al legado performance.memory API?

If you are familiar with the existing non-standard performance.memory API, es factible que se pregunte en qué se diferencia la nueva API. La principal diferencia es que la API anterior devuelve el tamaño del montón de JavaScript, mientras que la nueva API estima el uso de memoria de toda la página web. Esta diferencia se torna importante cuando Chrome comparte el mismo montón con varias páginas web (o varias instancias de la misma página web). En tales casos, el resultado de la antigua API puede estar arbitrariamente apagado. Ya que la antigua API se establece en términos específicos de implementación como «montón», estandarizarla es inútil.

Otra diferencia es que la nueva API realiza mediciones de memoria durante la recolección de basura. Esto reduce el ruido en los resultados, pero puede llevar un tiempo hasta que se produzcan los resultados. Tenga en cuenta que otros navegadores pueden elegir poner en práctica la nueva API sin depender de la recolección de basura.

Suggested use cases

El uso de memoria de una página web depende del momento de los eventos, las acciones del usuario y las recolecciones de basura. Es es por esto que que la API de medición de memoria está diseñada para agregar datos de uso de memoria de producción. Los resultados de las llamadas individuales son menos útiles. Casos de uso de ejemplo:

• Detección de regresión durante el lanzamiento de una versión nueva de la página web para detectar nuevas fugas de memoria.
• Prueba A / B de una nueva función para examinar su impacto en la memoria y detectar pérdidas de memoria.
• Correlate memory usage to session duration to verify the presence or absence of memory leaks.
• Correlacionar el uso de la memoria con las métricas del usuario para entender el impacto general del uso de la memoria.

Browser compatibility

En este momento, la API solo es compatible con Chrome 83 como prueba de origen. El resultado de la API depende en gran medida de la implementación debido a que los navegadores disponen diferentes formas de representar objetos en la memoria y diferentes formas de estimar el uso de la memoria. Los navegadores pueden excluir algunas regiones de memoria de la contabilidad si la contabilidad adecuada es demasiado cara o inviable. Por ende, los resultados no se pueden comparar entre navegadores. Solo tiene sentido comparar los resultados para el mismo navegador.

Actual state

Using performance.measureMemory ()

Enable support during origin testing stage

the performance.measureMemory () La API se encuentra disponible como prueba de origen a partir de Chrome 83. Se espera que la prueba de origen finalice en Chrome 86 a principios de noviembre de 2020.

Origin testing allows you to test new features and provide feedback on their usability, practicality, and effectiveness to the web standards community. For more information, see the Origin testing guide for web developers. To enroll in this or any other proof of origin, visit the registration page.

Register for proof of origin

1. Request a token by your origin.
2. Add the token to your pages. There are two ways to do it:
   • Add a origin-trial tag to the header of each page. As an example, this might look like this:
     
   • If you can configure your server, you can additionally add the token using a Origin-Trial HTTP header. The resulting response header should look like this:
     Origin-Trial: TOKEN_GOES_HERE

Enabling via chrome: // flags

To experiment with performance.measureMemory () without a proof of origin token, enable the #experimental-web-platform-features flag on chrome://flags.

Feature detection

the performance.measureMemory () the function may fail with a
Security error si el entorno de ejecución no alcanza con los requerimientos de seguridad para prevenir fugas de información de origen cruzado. Durante la prueba de origen en Chrome, la API necesita que Site isolation is enabled. When the API is submitted, it will depend on
cross-origin isolation. Una página web puede elegir por el aislamiento de origen cruzado configurando COOP + COEP headers.

if ( performance . measureMemory ) {
 let result ;
 try {
 result = await performance . measureMemory ( ) ;
 } catch ( error ) {
 if ( error instanceof DOMException &&
 mistake . name === "SecurityError" ) {
 console . log ( "The context is not secure." ) ;
 } else {
 throw error ;
 }
 }
 console . log ( result ) ;
 }

Local tests

Chrome realiza la medición de la memoria durante la recolección de basura. Esto significa que la API no resuelve la promesa de resultado de inmediato y, en cambio, espera la próxima recolección de basura. La API fuerza una recolección de basura luego de un tiempo de espera, que en este momento está establecido en 20 segundos. Iniciando Chrome con el
--enable-blink-features = 'ForceEagerMeasureMemory' The command line prompt reduces the wait time to zero and is useful for local debugging and testing.

Example

El uso recomendado de la API es establecer un monitor de memoria global que muestree el uso de memoria de toda la página web y envíe los resultados a un servidor para su agregación y análisis. La forma más sencilla es tomar muestras de forma periódica, a modo de ejemplo, cada M minutos. A pesar de todo, esto introduce un sesgo en los datos debido a que pueden producirse picos de memoria entre las muestras. El siguiente ejemplo muestra cómo realizar mediciones de memoria insesgadas usando un Procedimiento de Poisson, ensuring that samples are equally likely to occur at any time (manifestation, source).

Primero, defina una función que programe la próxima medición de memoria utilizando
setTimeout () con un intervalo aleatorio. La función debe llamarse luego de cargar la página en la ventana principal.

function scheduleMeasurement ( ) {
 if ( ! performance . measureMemory ) {
 console . log ( "performance.measureMemory () is not available." ) ;
 return ;
 }
 const interval = measurementInterval ( ) ;
 console . log ( "Scheduling memory measurement in" +
 Math . round ( interval / 1000 ) + "seconds." ) ;
 setTimeout ( performMeasurement , interval ) ;
 }

 window . onload = function ( ) {
 scheduleMeasurement ( ) ;
 }

the measurementInterval () The function calculates a random interval in milliseconds so that, on average, there is a measurement every five minutes. Watch Exponential distribution if you are interested in the math behind the function.

function measurementInterval ( ) {
 const MEAN_INTERVAL_IN_MS = 5 * 60 * 1000 ;
 return - Math . log ( Math . random ( ) ) * MEAN_INTERVAL_IN_MS ;
 }

En resumen, el async performMeasurement () La función invoca la API, registra el resultado y programa la próxima medición.

async function performMeasurement ( ) {
 let result ;
 try {
 result = await performance . measureMemory ( ) ;
 } catch ( error ) {
 if ( error instanceof DOMException &&
 mistake . name === "SecurityError" ) {
 console . log ( "The context is not secure." ) ;
 return ;
 }
 throw error ;
 }
 console . log ( "Memory usage:" , result ) ;
 scheduleMeasurement ( ) ;
 }

The result can be seen as follows:

{
 bytes : 60_000_000 ,
 breakdown : [
 {
 bytes : 40_000_000 ,
 attribution : [ "https://foo.com" ] ,
 userAgentSpecificTypes : [ "Window" , "JS" ]
 } ,
 {
 bytes : 20_000_000 ,
 attribution : [ "https://foo.com/iframe" ] ,
 userAgentSpecificTypes : [ "Window" , "JS" ]
 }
 ]
 }

The estimate of total memory usage is returned in the bytes campo. El valor de bytes está utilizando number separator syntax. Este valor depende en gran medida de la implementación y no se puede comparar entre navegadores. Inclusive puede cambiar entre diferentes versiones del mismo navegador. Durante la prueba de origen, el valor incluye el uso de memoria JavaScript de la ventana principal y todos
same place iframes y ventanas asociadas. Cuando se envía la API, el valor tendrá en cuenta JavaScript y la memoria DOM de todos los iframes, ventanas asociadas y empleados web.

the breakdown El listado proporciona más información sobre la memoria utilizada. Cada entrada describe una parte de la memoria y la atribuye a un recopilatorio de ventanas, iframes y empleados identificados por URL. los userAgentSpecificTypes
The field lists the implementation-specific memory types associated with the memory.

Es esencial tratar todas las listas de forma genérica y no codificar suposiciones sustentadas en un navegador en particular. A modo de ejemplo, algunos navegadores pueden devolver un breakdown or a void attribution. Other browsers may return multiple URLs in attribution indicating that they couldn't tell which of these URLs owns the memory.

Feedback

the Community Web Performance Group and the Chrome team would love to hear your thoughts and experiences with
performance.measureMemory ().

Tell us about the API design

¿Puede haber algo en la API que no funcione como se esperaba? ¿O faltan propiedades que necesitas para poner en práctica tu idea? Presentar un obstáculo de especificaciones en el performance.measureMemory GitHub repository or add your thoughts to an existing obstacle.

Report an obstacle with the implementation

¿Encontraste un error con la implementación de Chrome? ¿O la implementación es distinto de la especificación? Presentar un error en new.crbug.com. Be sure to include as much detail as you can, provide simple instructions for reproducing the bug, and Components adjusted to Blink> PerformanceAPIs.
Failure works great for quick and easy sharing of reps.

Show support

¿Está planeando utilizar performance.measureMemory ()? Your public support helps the Chrome team prioritize features and shows other browser vendors how important it is to support them. Send a tweet to @Cromodev and let us know where and how you are using it.

Useful Links

Thanks

Muchas gracias a Domenic Denicola, Yoav Weiss, Mathias Bynens por las revisiones de diseño de API y a Dominik Inführ, Hannes Payer, Kentaro Hara, Michael Lippautz por las revisiones de código en Chrome. Además agradezco a Per Parker, Philipp Weis, Olga Belomestnykh, Matthew Bolohan y Neil Mckay por otorgar valiosos comentarios de los usuarios que mejoraron enormemente la API.

Hero image por Harrison Broadbent en Unsplash