Profilage

Defold comprend des outils de profilage intégrés au moteur et à la chaîne de build. Ils aident à détecter les problèmes de performances, de mémoire et d’utilisation des ressources. Plusieurs outils peuvent exploiter les données de profilage recueillies à l’exécution :

• Le profileur de base et le profileur visuel intégré au jeu sont disponibles sur toutes les plateformes.
• Le profileur Remotery et le profileur web interactif d’images sont disponibles sur les plateformes de bureau et mobiles.
• Les builds HTML5 peuvent publier les zones de mesure de Defold dans l’API Web Performance du navigateur.

Le paramètre Profiler de l’App Manifest détermine si le code du profileur est lié au build. Debug Only est la valeur par défaut, None l’exclut et Always l’inclut dans les builds de débogage comme dans ceux de publication. Les paramètres profiler de game.project contrôlent le comportement à l’exécution, mais ne réintègrent pas dans un build le code du profileur qui en a été exclu. En particulier, Track CPU contrôle l’échantillonnage de l’utilisation du CPU ; ce paramètre est indépendant du choix effectué dans l’App Manifest.

Le profileur visuel à l’exécution

Les builds qui incluent la prise en charge du profileur disposent d’un profileur visuel qui affiche des informations en temps réel, en surimpression sur l’application en cours d’exécution :

function on_reload(self)
    -- Toggle the visual profiler on hot reload.
    profiler.enable_ui(true)
end

Le profileur visuel fournit plusieurs fonctions permettant de modifier la manière dont il présente ses données :

profiler.set_ui_mode()
profiler.set_ui_view_mode()
profiler.view_recorded_frame()

Consultez la référence de l’API du profileur pour en savoir plus sur les fonctions du profileur.

Le profileur web

Lorsqu’un build de bureau ou mobile incluant la prise en charge du profileur est en cours d’exécution, vous pouvez accéder aux profileurs interactifs d’images et de ressources dans un navigateur.

Profileur d’images Remotery

Le profileur d’images vous permet d’échantillonner votre jeu en cours d’exécution et d’analyser chaque image en détail. Pour accéder au profileur :

1. Démarrez votre jeu sur votre appareil cible.
2. Sélectionnez le menu Debug ▸ Open Web Profiler.

Le profileur d’images est divisé en plusieurs sections qui offrent chacune une vue différente du jeu en cours d’exécution. Appuyez sur le bouton Pause dans le coin supérieur droit pour interrompre temporairement la mise à jour des vues du profileur.

INFO:ENGINE: Defold Engine 1.3.4 (80b1b73)
INFO:DLIB: Initialized Remotery (ws://127.0.0.1:17815/rmt)
INFO:ENGINE: Loading data from: build/default

Sample Timeline

La vue Sample Timeline affiche les données capturées pour chaque image dans le moteur, avec une chronologie horizontale par thread. Main est le thread principal, où s’exécutent toute la logique du jeu et la majeure partie du code du moteur. Remotery correspond au profileur lui-même et Sound au thread de mixage et de lecture audio. Vous pouvez zoomer et dézoomer (avec la molette de la souris) et sélectionner chaque image pour en afficher les détails dans la vue Frame Data.

Frame Data

La vue Frame Data est un tableau qui détaille toutes les données de l’image actuellement sélectionnée. Vous pouvez y voir combien de millisecondes sont consacrées à chaque zone de mesure du moteur.

Global Properties

La vue Global Properties affiche un tableau de compteurs. Ils permettent par exemple de suivre facilement le nombre d’appels de dessin ou le nombre de composants (components) d’un certain type.

Profileur de ressources

Le profileur de ressources vous permet d’inspecter votre jeu en cours d’exécution et d’analyser en détail l’utilisation des ressources. Pour accéder au profileur :

1. Démarrez votre jeu sur votre appareil cible.
2. Ouvrez un navigateur et accédez à http://localhost:8002

Le profileur de ressources est divisé en deux sections : l’une affiche une vue hiérarchique des collections, des objets de jeu (game objects) et des composants actuellement instanciés dans votre jeu, et l’autre affiche toutes les ressources actuellement chargées.

Vue des collections

La vue des collections affiche une liste hiérarchique de tous les objets de jeu et composants actuellement instanciés dans le jeu, ainsi que les collections dont ils proviennent. C’est un outil très utile pour examiner et comprendre ce qui est instancié dans votre jeu à un instant donné et d’où proviennent les objets.

Vue des ressources

La vue des ressources affiche toutes les ressources actuellement chargées en mémoire, leur taille et le nombre de références à chacune d’elles. Elle est utile pour optimiser l’utilisation de la mémoire de votre application lorsque vous devez comprendre ce qui est chargé en mémoire à un instant donné.

Chronologie des performances dans le navigateur en HTML5

HTML5 utilise l’API Web Performance à la place de Remotery pour sa chronologie dans le navigateur. Pour enregistrer les zones de mesure de Defold :

1. Assurez-vous que le mode de profilage sélectionné dans l’App Manifest inclut la prise en charge du profileur dans la variante de build que vous exécutez.
2. Activez Performance Timeline Enabled (profiler.performance_timeline_enabled) dans game.project.
3. Lancez le build HTML5 et ouvrez les outils de développement du navigateur.
4. Enregistrez une session dans le panneau Performance du navigateur et inspectez les zones de mesure de Defold dans la chronologie obtenue.

Cette chronologie du navigateur est distincte à la fois du profileur visuel intégré au jeu et du profileur web interactif Remotery.

Rapports de build

Lors de la création du bundle de votre jeu, une option vous permet de créer un rapport de build. Ce rapport est très utile pour connaître la taille de toutes les ressources qui font partie du bundle de votre jeu. Il suffit de cocher la case Generate build report lors de la création du bundle du jeu.

L’outil de build produit un fichier nommé report.html à côté du bundle du jeu. Ouvrez ce fichier dans un navigateur web pour examiner le rapport :

La section Overview fournit une vue d’ensemble de la répartition de la taille du projet par type de ressource.

Resources affiche une liste détaillée de ressources que vous pouvez trier par taille, taux de compression, chiffrement, type et nom de répertoire. Utilisez le champ « search » pour filtrer les entrées de ressources affichées.

La section Structure affiche les tailles en fonction de l’organisation des ressources dans l’arborescence des fichiers du projet. Les entrées sont colorées du vert (léger) au bleu (lourd) selon la taille relative du fichier et du contenu du répertoire.

Outils externes

En plus des outils intégrés, il existe un large choix d’outils de traçage et de profilage gratuits et de qualité. En voici une sélection :

ProFi (Lua)

Nous ne fournissons pas de profileur Lua intégré, mais il existe des bibliothèques externes assez faciles à utiliser. Pour trouver où vos scripts passent du temps, insérez vous-même des mesures de temps dans votre code ou utilisez une bibliothèque de profilage Lua comme ProFi.

Notez que les profileurs écrits uniquement en Lua ajoutent un surcoût assez important à chaque hook qu’ils installent. Pour cette raison, il convient d’interpréter avec prudence les mesures de temps obtenues avec un tel outil. Les mesures fondées sur le comptage sont toutefois suffisamment précises.

Instruments (macOS et iOS)

Cet outil d’analyse et de visualisation des performances fait partie de Xcode. Il vous permet de tracer et d’inspecter le comportement d’une ou plusieurs applications ou processus, d’examiner des fonctionnalités propres à l’appareil (comme le Wi-Fi et le Bluetooth) et bien plus encore.

OpenGL profiler (macOS)

Fait partie du paquet « Additional Tools for Xcode » que vous pouvez télécharger auprès d’Apple (sélectionnez Xcode ▸ Open Developer Tool ▸ More Developer Tools... dans le menu de Xcode).

Cet outil vous permet d’inspecter une application Defold en cours d’exécution et de voir comment elle utilise OpenGL. Vous pouvez tracer les appels de fonctions OpenGL, définir des points d’arrêt sur les fonctions OpenGL, examiner les ressources de l’application (textures, programmes, shaders, etc.), consulter le contenu des tampons et vérifier d’autres aspects de l’état d’OpenGL.

Android Profiler (Android)

https://developer.android.com/studio/profile/android-profiler.html

Cet ensemble d’outils de profilage capture en temps réel les données d’utilisation du CPU, de la mémoire et du réseau de votre jeu. Vous pouvez tracer les méthodes par échantillonnage pendant l’exécution du code, capturer des vidages du tas, afficher les allocations de mémoire et inspecter les détails des fichiers transmis sur le réseau. Pour utiliser cet outil, vous devez définir android:debuggable="true" dans AndroidManifest.xml.

Remarque : depuis Android Studio 4.1, il est également possible d’exécuter les outils de profilage sans démarrer Android Studio.

Graphics API Debugger (Android)

https://github.com/google/gapid

Cet ensemble d’outils vous permet d’inspecter, de modifier et de rejouer les appels d’une application à un pilote graphique. Pour l’utiliser, vous devez définir android:debuggable="true" dans AndroidManifest.xml.