Ce tutoriel décrit comment générer un dashboard Greenspector.
Le dashboard Greenspector permet une analyse plus facile à présenter des résultats de mesure. Il permet notamment de calculer un Ecoscore Greenspector, de définir des domaines fonctionnels, de comparer des versions de mesures, etc.
On ne peut comparer que deux versions ayant les mêmes étapes.
Pré-requis
Il est nécessaire de télécharger l’exécutable TODO.
Il faut ensuite lui changer les droits pour rendre le fichier exécutable.
Créer les fichiers nécessaires
L’exécutable a besoin de deux fichiers pour se lancer. Des fichiers d’exemple avec les explications sont téléchargeables ici TODO.
Config
Ce fichier définit les accès à l’environnement Greenspector. Il est possible d’ajouter plusieurs environnements pour pouvoir changer simplement d’instance Greenspector.
Definition
Ce fichier définit les informations analysées et présentées par le dashboard.
La première partie contient les informations de présentations générales.
name: # Le nom du rapport env: # Le nom de l’environnement à utiliser (défini dans le fichier de config) evolutiontype: # comparaison ou evolution - change le type des graphes de suivi des versions generationtype: # optionnel - "All"(default) "Dashboard" ou "Scenarios". Défini quels fichiers seront générés. usembfordata: # optionnel - false (default) ou true. Si true, utilise des Mo au lieu de ko. shouldgenerateevolutionperdomain: # optionnel - false (default) ou true. Si true, génère l’évolution par domaine fonctionnel. pausedurationtouseforconsumption: # optionnel - float64 (30.0 default). Défini la durée en secondes à utiliser pour calculer l’énergie consommée par les pauses language: # optionnel - "EN"(default) ou "FR". Langue des fichiers. basenetworktype: # optionnel - "WIFI"(default) "4G" "3G" ou "2G". Le réseau principal considéré.
La seconde partie contient les versions de l’application à utiliser pour le dashboard. Elles correspondent aux versions sur l’interface web de Greenspector. Leur id est observable dans l’URL lorsqu’une version est sélectionnée.
auditids:
- version: # Nom de la version à afficher
plateforme: # Nom de la plateforme à aller chercher sur App
os: # "Android" ou "iOS"
idwifi: #id de l'audit WIFI]
id4g: [id de l'audit 4G - optionnel, utilisé pour comparaison de réseau]
id3g: [id de l'audit 3G - optionnel, utilisé pour comparaison de réseau]
id2g: [id de l'audit 2G - optionnel, utilisé pour comparaison de réseau]
extramestime: [Temps ajouté à la fin des mesures de chargement à déduire des perf. - en secondes]
date: [Date de la mesure à afficher]
datacsvfile: [optionnel (utile pour iOS uniquement) - Chemin vers un .csv qui contient les data au format US et trois colonnes "auditId,step,dataUsage (kB)"]
filternetworkonversions: [optionnel - si 'true' filtre le réseau sur chaque version fournie (idwifi, id4g ...). Par exemple, uniquement les mesures WIFI seront récupérées sur la version de idwifi. Si la valeur est 'false', alors tous les réseaux sont récupérés sur la valeur fournie. Valeur par défaut = 'true']
Lancer exécutable
Éxecuter la commande suivante
./dashboardcampagne -config=/path/to/config.yml -definition=/path/to/definition.yml
Le navigateur Internet s’ouvre et affiche la page du dashboard.
Il est judicieux de penser à vérifier les logs, même s’il semble que la génération s’est bien passée. En effet, si certaines étapes ne sont pas trouvées, le dashboard est quand même généré.
Générer un fichier de scenario
Le dashboard est également capable de générer un fichier qui définit le parcours automatisé à partir des captures qui ont été enregistrées pendant celui-ci. Pour cela, il faut définir dans le fichier de définition le paramètre generationtype à All ou Scenarios . En plus de cela il faut passer le dossier contenant les screenshots à l’exécutable avec un -screenshots=/path/to/screenshots .
De même que pour le dashboard, une page html s’ouvre dans le navigateur et un fichier pdf est généré si ghostscript est installé.