Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

Code Block
languageyaml
refname: # nom de l’étape de référence (exemple: "PAUSE_reference")
steps:
  - name: # nom de l’étape
    type: # optionnel - "UserAction", "Loading", "Pause" - sert à surcharger le type d’étape défini dans le nom
    energy: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape
dans la catégorie "Non monitoré"
    performance: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape dans la catégorie "Non monitoré"
    data: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape dans la catégorie "Non monitoré"
    domain: # domaine fonctionnel (exemple: "Accueil")
  
 order: # optionnel - ordre pour la génération du scénario
    displayname: # optionnel - nom de l’étape à afficher dans le rapport. Si défini alors ce nom remplace le champs name qui correspond à la mesure
  - [...]

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

Selon le nom de l’étape, un type lui est assigné automatiquement. Voir la page sur la rédaction d’un parcours fonctionnel pour plus de détails.

Pour surcharger le type de l’étape, voir la section « Pour aller plus loin ».

Lancer exécutable

Éxecuter la commande suivante

...

Code Block
languageyaml
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

Addendum sur la définition des étapes

Un certain nombre de paramètres optionnels sont disponibles pour définir plus précisément les étapes. Il est notamment possible de modifier le type d’étape si celui-ci n’a pas été correctement défini.

Code Block
languageyaml
  - name: # nom de l’étape
    type: # optionnel - "UserAction", "Loading", "Pause" - sert à surcharger le type d’étape défini dans le nom
    energy: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape dans la catégorie "Non monitoré"
    performance: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape dans la catégorie "Non monitoré"
    data: # optionnel - true(default) ou false - dépend du type d'étape si pas de valeur saisie. false classe l’étape dans la catégorie "Non monitoré"
    domain: # domaine fonctionnel (exemple: "Accueil")
    order: # optionnel - ordre pour la génération du scénario
    displayname: # optionnel - nom de l’étape à afficher dans le rapport. Si défini alors ce nom remplace le champs name qui correspond à la mesure