Use
From the CampaignDashboard folder, run the following command:
./dashboardCampagne -definition=[definition-file] -config=[congif-file] -screenshots=[screenshots-folder]
To generate the dashboard [screenshots-folder] must be set but not necessarily with images (the scenario will be generated empty) There are example files for the definition file in example. config.yml must be filled with the token.
At the end of processing, the console outputs the details by step according to the versions. This can be used in Excel to display the comparison by step.
PDF export
If wkhtmltopdf is installed, then a PDF export will be automatically generated from HTML file.
If ghostscript is installed, then the PDF will be automatically compressed.
Definition
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']
This displays changes in metrics between versions. If this is not filled in, or only the idwifi is filled in, there is no evolution curve.
In steps:
- 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
The different types of steps are as follows:
UserAction (action or scrolling on the screen)
Loading (loading a screen)
Pause (pause on a screen)
Depending on the type of step, the severity of the ratings may differ. The type of stage is also useful for calculating different averages.
For example
UserAction steps are rated less severely on performance
Pause steps are not taken into account when calculating performance by default.
If the name of the step respects the following naming, then its type will be assigned automatically. It can always be overridden by defining the type option:
PAUSE_<step_name>: assigned as type Pause
ACTION_<step_name>: assigned as a UserAction type
SCROLL_<step_name> : assigned as type UserAction
CHRGT_<step_name>: assigned as a Loading type
Environmental assessment
An environmental assessment can be carried out using dashboard data and the co2-algorithm-service by adding a parameter 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]
Proxy configuration
It is possible to use a proxy to realize the various requests. By default, the tool will try to retrieve information about the proxy from the environment variables. On Windows and Mac there are other ways of configuring the proxy which are also retrieved (e.g. PAC autoconfiguration file, etc.). To find out which methods are supported, go here : Proxy auto-configuration methods.
However, there is a manual method of configuring the proxy. Simply add to the 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