Usage
Depuis le dossier DashboardCampagne, executer la commande suivante :
./dashboardCampagne -definition=[fichier-definition] -config=[fichier-config] -screenshots=[dossier-screenshots]
Pour générer le dashboard [dossier-screenshots] doit être précisé mais pas obligatoirement avec des images (le scénario sera généré vide). Il existe des fichiers d'exemple pour le fichier de def dans le dossier example De plus, il faut remplir config.yml avec son token.
La console sort en fin de traitement le détail par étape en fonction des versions. Cela peut être utilisé dans excel pour afficher la comparaison par étape.
Export PDF
Si wkhtmltopdf est installé alors un export PDF se fera automatiquement à partir du fichier HTML.
Si de plus ghostscript est installé alors le pdf sera automatiquement compressé.
Définition
name: # the app name used in the report
env: # the environment name to use (env. needs to be defined in the config file)
evolutiontype: # comparaison ou evolution - Change le type des graphes de suivi des versions
generationtype: # optional - define which generation type is expected by the DashboardCampagne. Possible values are "Scenarios" for scenario generation only, "Dashboard" for dashboard generation only and "All" (default) for both
usembfordata: true # optional - replace kB unit to MB one.
shouldgenerateevolutionperdomain: true # optional - show evolution per domain (default false)
pausedurationtouseforconsumption: 30.0 # optional float64 - set the duration in seconds used to compute energy consumption and impact of pauses (default is 30.0 seconds)
language: # optional - define the language to use for exported files (among "FR" and "EN", default is "EN").
basenetworktype: # optional - the network to use for the whole document as a base. Default: WIFI
version: 2.0 # optional - can be 1.0 or 2.0. Default: 2.0
web: true # optional - if measurements are web change thresholds for data consumptions - useful only version: 2.0. Default: false
# Ajouter `comparisons` pour des comparaisons des métriques entre plusieurs plateformes sur le réseau WIFI
comparisons:
metrics:
- Performance
- Data
- EnergySpeed
- EnergyConsumption
- Carbon
audits:
- name: [Nom de la série à afficher (exemple : "Samsung S7")]
id: [ID de l'audit à récupérer (exemple : 78914)]
device: [Nom du device à récupérer sur APP]
network: [Réseau à utiliser ; optionnel ; valeur par défaut : WIFI]
extramestime: [Temps ajouté à la fin des mesures de chargement à déduire des perf. - 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)"]
- [...]
auditids:
- version: [Nom de la version à afficher]
plateforme: [Nom de la plateforme à aller chercher sur App]
os: [Nom de l'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']
Cela permet d'afficher l'évolution des métriques entre version. Si cela n'est pas rempli, ou que uniquement l'idWifi est rempli, il n'y a pas de courbe d'évolution.
Dans les étapes :
- name: [Nom du step dans GSPT]
type : [Type d'étape]
energy: [A monitorer pour l’énergie - optionnel, dépend du type d'étape si pas de valeur saisie]
data: [A monitorer pour la data - optionnel, dépend du type d'étape si pas de valeur saisie]
performance: [A monitorer pour la perf - optionnel, dépend du type d'étape si pas de valeur saisie]
domain: [Domaine à associer]
order: [Ordre pour la génération du scénario]
displayname: [Nom du step à afficher dans le rapport] (optionnel, si ajouté alors ce nom remplace le champs name qui correspond à la mesure)
critical: [Est une étape critique du parcours fonctionnel] (optionnel, Par défaut false)
Les types d'étape
Les différents types d'étapes sont les suivants :
UserAction (action ou scroll sur l'écran)
Loading (chargement d'un écran)
Pause (pause sur un écran)
En fonction du type d'étape, la sévérité sur les notations peut différer. Le type d'étape est utile également pour calculer différentes moyennes.
Par exemple :
les étapes UserAction sont moins sévèrement notées sur la performance
les étapes Pause ne sont pas prises en compte de le calcul de la performance par défaut
Si le nom de l'étape respecte le nommage suivant alors son type sera affecté automatiquement. Il peut toujours être surchargé en définissant l'option type :
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
Évaluation environnementale
Il est possible de réaliser une évaluation environnementale avec les données du dashboard et le service co2-algorithm-service en ajoutant un paramètre environmentalinput:
environmentalinput:
useroptions:
userlocations:
france: 97 # % users in france
world: 3 # % users in another part of the world (not in France)
usertypes:
smartphone: 55 # % users on smartphone
tablet: 1 # % users on tablet
pc: 44 # % users on PC
networkoptions:
networklocations:
france: 97 # % users in france
world: 3 # % users in another part of the world (not in France)
networktypes:
gsm2g3g: 25 # % users in 2G/3G
gsm4g5g: 25 # % users in 4G/5G
wiredfibre: 25 # % users in fiber
wiredxdsl: 25 # % users in adsl/xdsl
serveroptions:
serverlocations:
france: 100 # % server in France
world: 0 # % server in another part of the world (not in France)
servertypes:
complexserver: 100 # % complex server
simpleserver: 0 # % simple server
# parameters: # optional
# pue: 1.5 # [optional - data center PUE, minimum 1.0]
# datainput: # optional
# reqnetwork: 200 # [optional - number of http requests. (if non specified, it is deducted from the number of data exchanged on network during the scenario]
Configuration du Proxy
Il est possible d'utiliser un proxy pour effectuer les différentes requêtes. Par défault, l'outil va chercher à récupérer des informations sur le proxy dans les variables d'environnement. Sur Windows et Mac il existe d'autres manières pour configurer le proxy qui sont elles aussi récupérées (ex: Fichier d'autoconfiguration PAC, ...). Pour savoir quels méthodes sont supportés ça se passe ici : Méthodes d'auto-configuration du proxy.
Il existe cependant une méthode de configuration manuelle du proxy. Il suffit d'ajouter au fichier config.yml :
proxy: http: http://monproxy.local:8080 # Proxy pour les URL en http https: http://monproxy.local:8080 # Proxy pour les URL en https