Surveillez l'utilisation totale de la mémoire de votre page Web avec measureUserAgentSpecificMemory()

Découvrez comment mesurer l'utilisation de la mémoire de votre page Web en production pour détecter les régressions.

Brendan Kenny

Ulan Degenbaev

Les navigateurs gèrent automatiquement la mémoire des pages Web. Chaque fois qu'une page Web crée un objet, le navigateur alloue un fragment de mémoire "en arrière-plan" pour stocker l'objet. La mémoire étant une ressource non renouvelable, le navigateur effectue une récupération de mémoire pour détecter quand un objet n'est plus nécessaire et libérer le fragment de mémoire sous-jacent.

La détection n'est toutefois pas parfaite, et le problème de l'arrêt d'Alan Turing a prouvé qu'une détection parfaite est impossible. Par conséquent, les navigateurs se basent sur la notion d'accessibilité d'un objet pour déterminer s'il est nécessaire ou non. Si la page Web ne peut pas atteindre un objet via ses variables et les champs d'autres objets accessibles, le navigateur peut récupérer l'objet en toute sécurité. La différence entre ces deux notions entraîne des fuites de mémoire, comme l'illustre l'exemple suivant.

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

Ici, le tableau plus grand b n'est plus nécessaire, mais le navigateur ne le récupère pas, car il est toujours accessible via object.b dans le rappel. La mémoire du tableau plus grand est donc perdue.

Les fuites de mémoire sont fréquentes sur le Web, comme le montre cette étude. Il est facile d'en introduire une en oubliant de désenregistrer un écouteur d'événements, en capturant accidentellement des objets d'un iframe, en ne fermant pas un worker, en accumulant des objets dans des tableaux, etc. Si une page Web présente des fuites de mémoire, son utilisation de la mémoire augmente au fil du temps, et la page Web semble lente et surchargée aux utilisateurs.

La première étape pour résoudre ce problème consiste à le mesurer. La nouvelle API performance.measureUserAgentSpecificMemory() permet aux développeurs de mesurer l'utilisation de la mémoire de leurs pages Web en production et de détecter ainsi les fuites de mémoire qui échappent aux tests locaux.

En quoi performance.measureUserAgentSpecificMemory() diffère-t-il de l'ancienne API performance.memory ?

Si vous connaissez l'API performance.memory non standard existante, vous vous demandez peut-être en quoi la nouvelle API en diffère. La principale différence est que l'ancienne API renvoie la taille du tas de mémoire JavaScript, tandis que la nouvelle API estime la mémoire utilisée par la page Web. Cette différence devient importante lorsque Chrome partage le même tas avec plusieurs pages Web (ou plusieurs instances de la même page Web). Dans ce cas, le résultat de l'ancienne API peut être arbitrairement désactivé. Étant donné que l'ancienne API est définie dans des termes spécifiques à l'implémentation, tels que "tas", il est impossible de la standardiser.

Une autre différence est que la nouvelle API effectue une mesure de la mémoire pendant la récupération de mémoire. Cela réduit le bruit dans les résultats, mais la production des résultats peut prendre un certain temps. Notez que d'autres navigateurs peuvent décider d'implémenter la nouvelle API sans s'appuyer sur la récupération de mémoire.

Cas d'utilisation suggérés

L'utilisation de la mémoire d'une page Web dépend du moment où se produisent les événements, des actions de l'utilisateur et des récupérations de mémoire. C'est pourquoi l'API de mesure de la mémoire est destinée à agréger les données d'utilisation de la mémoire en production. Les résultats des appels individuels sont moins utiles. Exemples d'utilisation :

• Détection des régressions lors du déploiement d'une nouvelle version de la page Web pour détecter les nouvelles fuites de mémoire.
• Effectuer un test A/B d'une nouvelle fonctionnalité pour évaluer son impact sur la mémoire et détecter les fuites de mémoire.
• Corréler l'utilisation de la mémoire avec la durée de la session pour vérifier la présence ou l'absence de fuites de mémoire.
• Corréler l'utilisation de la mémoire avec les métriques utilisateur pour comprendre l'impact global de l'utilisation de la mémoire.

Compatibilité du navigateur

Browser Support

• 89
• 89
• x
• x

Source

Actuellement, l'API n'est compatible qu'avec les navigateurs basés sur Chromium, à partir de Chrome 89. Le résultat de l'API dépend fortement de l'implémentation, car les navigateurs ont différentes manières de représenter les objets en mémoire et d'estimer l'utilisation de la mémoire. Les navigateurs peuvent exclure certaines régions de mémoire de la comptabilisation si celle-ci est trop coûteuse ou impossible. Par conséquent, les résultats ne peuvent pas être comparés entre les navigateurs. Il n'est pertinent de comparer les résultats que pour un même navigateur.

Utiliser performance.measureUserAgentSpecificMemory()

Détection de caractéristiques

La fonction performance.measureUserAgentSpecificMemory ne sera pas disponible ou pourra échouer avec une erreur SecurityError si l'environnement d'exécution ne répond pas aux exigences de sécurité pour empêcher les fuites d'informations interorigines. Elle repose sur l'isolation multi-origine, qu'une page Web peut activer en définissant des en-têtes COOP+COEP.

La compatibilité peut être détectée au moment de l'exécution :

if (!window.crossOriginIsolated) {
  console.log('performance.measureUserAgentSpecificMemory() is only available in cross-origin-isolated pages');
} else if (!performance.measureUserAgentSpecificMemory) {
  console.log('performance.measureUserAgentSpecificMemory() is not available in this browser');
} else {
  let result;
  try {
    result = await performance.measureUserAgentSpecificMemory();
  } catch (error) {
    if (error instanceof DOMException && error.name === 'SecurityError') {
      console.log('The context is not secure.');
    } else {
      throw error;
    }
  }
  console.log(result);
}

Test local

Chrome effectue la mesure de la mémoire pendant la récupération de mémoire. Cela signifie que l'API ne résout pas immédiatement la promesse de résultat, mais attend la prochaine récupération de mémoire.

L'appel de l'API force un nettoyage de la mémoire après un certain délai, actuellement défini sur 20 secondes, mais qui peut se produire plus tôt. Le démarrage de Chrome avec le flag de ligne de commande --enable-blink-features='ForceEagerMeasureMemory' réduit le délai avant expiration à zéro, ce qui est utile pour le débogage et les tests en local.

Exemple

L'utilisation recommandée de l'API consiste à définir un moniteur de mémoire global qui échantillonne l'utilisation de la mémoire de l'ensemble de la page Web et envoie les résultats à un serveur pour agrégation et analyse. Le moyen le plus simple consiste à échantillonner périodiquement, par exemple toutes les M minutes. Cependant, cela introduit un biais dans les données, car des pics de mémoire peuvent se produire entre les échantillons.

L'exemple suivant montre comment effectuer des mesures de mémoire non biaisées à l'aide d'un processus de Poisson, qui garantit que les échantillons sont également susceptibles de se produire à tout moment.

Commencez par définir une fonction qui planifie la prochaine mesure de la mémoire à l'aide de setTimeout() avec un intervalle aléatoire.

function scheduleMeasurement() {
  // Check measurement API is available.
  if (!window.crossOriginIsolated) {
    console.log('performance.measureUserAgentSpecificMemory() is only available in cross-origin-isolated pages');
    console.log('See https://web.dev/coop-coep/ to learn more')
    return;
  }
  if (!performance.measureUserAgentSpecificMemory) {
    console.log('performance.measureUserAgentSpecificMemory() is not available in this browser');
    return;
  }
  const interval = measurementInterval();
  console.log(`Running next memory measurement in ${Math.round(interval / 1000)} seconds`);
  setTimeout(performMeasurement, interval);
}

La fonction measurementInterval() calcule un intervalle aléatoire en millisecondes de sorte qu'en moyenne, une mesure soit effectuée toutes les cinq minutes. Consultez la page Loi exponentielle si vous souhaitez en savoir plus sur les mathématiques derrière la fonction.

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

Enfin, la fonction asynchrone performMeasurement() appelle l'API, enregistre le résultat et planifie la mesure suivante.

async function performMeasurement() {
  // 1. Invoke performance.measureUserAgentSpecificMemory().
  let result;
  try {
    result = await performance.measureUserAgentSpecificMemory();
  } catch (error) {
    if (error instanceof DOMException && error.name === 'SecurityError') {
      console.log('The context is not secure.');
      return;
    }
    // Rethrow other errors.
    throw error;
  }
  // 2. Record the result.
  console.log('Memory usage:', result);
  // 3. Schedule the next measurement.
  scheduleMeasurement();
}

Enfin, commencez à mesurer.

// Start measurements.
scheduleMeasurement();

Le résultat peut ressembler à ceci :

// Console output:
{
  bytes: 60_100_000,
  breakdown: [
    {
      bytes: 40_000_000,
      attribution: [{
        url: 'https://example.com/',
        scope: 'Window',
      }],
      types: ['JavaScript']
    },

    {
      bytes: 20_000_000,
      attribution: [{
          url: 'https://example.com/iframe',
          container: {
            id: 'iframe-id-attribute',
            src: '/iframe',
          },
          scope: 'Window',
      }],
      types: ['JavaScript']
    },

    {
      bytes: 100_000,
      attribution: [],
      types: ['DOM']
    },
  ],
}

L'estimation de l'utilisation totale de la mémoire est renvoyée dans le champ bytes. Cette valeur dépend fortement de l'implémentation et ne peut pas être comparée entre les navigateurs. Il peut même changer entre différentes versions d'un même navigateur. Cette valeur inclut la mémoire JavaScript et DOM de tous les iFrames, fenêtres associées et Web Workers du processus actuel.

La liste breakdown fournit des informations supplémentaires sur la mémoire utilisée. Chaque entrée décrit une partie de la mémoire et l'attribue à un ensemble de fenêtres, d'iframes et de workers identifiés par une URL. Le champ types liste les types de mémoire spécifiques à l'implémentation associés à la mémoire.

Il est important de traiter toutes les listes de manière générique et de ne pas coder en dur des hypothèses basées sur un navigateur particulier. Par exemple, certains navigateurs peuvent renvoyer un breakdown vide ou un attribution vide. D'autres navigateurs peuvent renvoyer plusieurs entrées dans attribution, indiquant qu'ils n'ont pas pu distinguer laquelle de ces entrées possède la mémoire.

Commentaires

Le groupe de la communauté Web Performance et l'équipe Chrome aimeraient connaître votre avis et votre expérience concernant performance.measureUserAgentSpecificMemory().

Parlez-nous de la conception de l'API

L'API ne fonctionne pas comme prévu ? Ou manque-t-il des propriétés dont vous avez besoin pour mettre en œuvre votre idée ? Signalez un problème de spécification dans le dépôt GitHub performance.measureUserAgentSpecificMemory() ou ajoutez vos commentaires à un problème existant.

Signaler un problème d'implémentation

Avez-vous trouvé un bug dans l'implémentation de Chrome ? Ou l'implémentation est-elle différente de la spécification ? Signalez un bug sur new.crbug.com. Veillez à inclure autant de détails que possible, à fournir des instructions simples pour reproduire le bug et à définir Composants sur Blink>PerformanceAPIs.

Montrer votre soutien

Prévoyez-vous d'utiliser performance.measureUserAgentSpecificMemory() ? Votre soutien public aide l'équipe Chrome à prioriser les fonctionnalités et montre aux autres fournisseurs de navigateurs l'importance de les prendre en charge. Envoyez un tweet à @ChromiumDev pour nous dire où et comment vous l'utilisez.

Liens utiles

• Présentateur
• Bug de suivi
• Entrée ChromeStatus.com
• Modifications depuis l'API Origin Trial
• Essai Origin Trial terminé

Remerciements

Un grand merci à Domenic Denicola, Yoav Weiss et Mathias Bynens pour les examens de conception d'API, ainsi qu'à Dominik Inführ, Hannes Payer, Kentaro Hara et Michael Lippautz pour les examens de code dans Chrome. Je remercie également Per Parker, Philipp Weis, Olga Belomestnykh, Matthew Bolohan et Neil Mckay pour leurs précieux commentaires, qui ont permis d'améliorer considérablement l'API.