Ce tutoriel décrit comment générer un dashboard Greenspector.

...

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.

...

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.

...

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: # optionnel - id de l'audit 4G, utilisé pour comparaison de réseau
    id3g: # optionnel - id de l'audit 3G, utilisé pour comparaison de réseau
    id2g: # optionnel - id de l'audit 2G, utilisé pour comparaison de réseau
    extramestime: # float64 - temps ajouté à la fin des mesures de chargement à déduire des performances 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 - true(default) ou false - 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.
  - [...]

Comparaisons

La partie suivante est optionnelle. Elle sert à définir la comparaison entre les réseaux et les modèles d’appareil.

comparisons: # optionnel - sert à comparer toutes les étapes entre elles 
  metrics: # les métriques à utiliser pour la comparaison
    - Performance
    - Data
    - EnergySpeed
    - EnergyConsumption
  audits:
    - name: # nom de la série à afficher (exemple: "Samsung S7")
      id: # id de l'audit à récupérer (exemple: 94279)
      device: # nom du device (exemple: S7)
      network: # optionnel - "WIFI"(default), "4G", "3G" ou "2G"
      extramestime: # float64 - temps ajouté à la fin des mesures de chargement à déduire des performances en secondes
      datacsvfile: # optionnel (utile pour iOS uniquement) - chemin vers un .csv qui contient les data au format US et trois colonnes "auditId,step,dataUsage (kB)"
    - [...]

Définition des étapes

La dernière partie obligatoire définit quelles étapes sont utilisées dans l’analyse.

...

• PAUSE_<nom_de_l'étape> : assigné en tant que type Pause

• ACTION_<nom_de_l'étape> : assigné en tant que type UserAction

• SCROLL_<nom_de_l'étape> : assigné en tant que type UserAction

• CHRGT_<nom_de_l'étape> : assigné en tant que type Loading

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.

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é.

Générer les fichiers PDF

Si l’outil ghostscript est installé sur le poste et accessible, alors l’exécutable dashboardcampagne génère automatiquement un fichier PDF.

Pour l’installer sur Ubuntu:

sudo apt install ghostscript

Pour aller plus loin

Comparaisons

Il est possible d’ajouter une section de comparaison sur le dashboard. La comparaison peut-être utilisé pour tester un changement de version d’application, un réseau différent ou encore un modèle différent de smartphone.

comparisons: # optionnel - sert à comparer toutes les étapes entre elles 
  metrics: # les métriques à utiliser pour la comparaison
    - Performance
    - Data
    - EnergySpeed
    - EnergyConsumption
  audits:
    - name: # nom de la série à afficher (exemple: "Samsung S7")
      id: # id de l'audit à récupérer (exemple: 94279)
      device: # nom du device (exemple: S7)
      network: # optionnel - "WIFI"(default), "4G", "3G" ou "2G"
      extramestime: # float64 - temps ajouté à la fin des mesures de chargement à déduire des performances en secondes
      datacsvfile: # optionnel (utile pour iOS uniquement) - chemin vers un .csv qui contient les data au format US et trois colonnes "auditId,step,dataUsage (kB)"
    - [...]

Définition du calcul d’impact

...

environmentalinput:
  serverdistribution:
    locations:
      france: 20 # % de serveurs en France
      world: 80 # % de serveurs à l’étranger
    servertypes:
      complexserver: 70 # % de serveurs complexes
      simpleserver: 30 # % de serveurs simples
  userdistribution:
    locations:
      france: 20 # % d’utilisateurs en France
      world: 80 # % d’utilisateurs à l’étranger
    usertypes:
      smartphone: 50 # % d’utilisateurs sur smartphone
      tablet: 30 # % d’utilisateurs sur tablette
      pc: 20 # % d’utilisateurs sur laptop
  displayallmetrics: # optionnel - false(default) ou true - si true, affiche les graphiques d’eau et de surface
  reqnetwork: # optionnel - nombre de requêtes HTTP. (si non spécifié, il est déduit du nombre de data du parcours)
  co2algorithmapi: # optionnel default: https://co2-algorithm-service.greenspector.com/api/v1 - api du service co2
  datacdn: # optionnel - float64 (default:0) - quantité de données qui viennent de CDN

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.

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é.

Générer les fichiers PDF

Si l’outil ghostscript est installé sur le poste et accessible, alors l’exécutable dashboardcampagne génère automatiquement un fichier PDF.

Pour l’installer sur Ubuntu:

...