add usage events functionnality

652fb5df · Yoan VALLET · 73f9a4c7 · 652fb5df · 652fb5df · 652fb5df
Commit 652fb5df authored 4 years ago by Yoan VALLET
--- a/docs/ecolyo/functionalities/usage_events_tracking.md
+++ b/docs/ecolyo/functionalities/usage_events_tracking.md
+# Usage events tracking
+
+This section explains how the application is tracking usage events. Here are the main step:
+- All events are stored in the instance db
+- A service is responsible of the calculation of ANONYMIZED indicators. These indicators are then sent to a remote docType.
+
+## Usage events collection
+
+Here are the list of collected usage event:
+| Category       | Type                           | Target         | Result     | Context               | Description                              |
+| -------------- | ------------------------------ | -------------- | ---------- | --------------------- | ---------------------------------------- |
+| Connection     | ConnectionEvent                |                |            | "desktop" or "mobile" | User connects to the application.        |
+| Navigation     | NavigationEvent                | Page           |            |                       | User navigates to a targeted page.       |
+| Konnector      | KonnectorConnectEvent          | Konnector      |            | "success" or "error"  | User connects a konnector.               |
+| Konnector      | KonnectorRefreshEvent          | Konnector      |            | "success" or "error"  | User refreshes a konnector.              |
+| Challenge      | ChallengeLaunchEvent           | Challenge id   |            |                       | User launches a challenge.               |
+| Challenge      | ChallengeEndEvent              | Challenge id   |            |                       | User ends a challenge.                   |
+| Duel           | DuelLaunchEvent                | Duel id        |            | Challenge id          | User launches a duel.                    |
+| Duel           | DuelEndEvent                   | Duel id        |            | Challenge id          | User ends a duel.                        |
+| Quiz           | QuizLaunchEvent                | Quiz id        |            | Challenge id          | User launches a quiz.                    |
+| Quiz           | QuizEndEvent                   | Quiz id        |            | Challenge id          | User ends a quiz.                        |
+| Exploration    | ExplorationLaunchEvent         | Exploration id |            | Challenge id          | User launches an exploration.            |
+| Exploration    | ExplorationEndEvent            | Exploration id |            | Challenge id          | User ends an exploration.                |
+| Action         | ActionChangeEvent              | Action id      |            | Challenge id          | User change action's ecogesture.         |
+| Action         | ActionLaunchEvent              | Action id      |            | Challenge id          | User launches a action.                  |
+| Action         | ActionEndEvent                 | Action id      |            | Challenge id          | User ends a action.                      |
+| Profile        | ProfileSetEvent                |                |            |                       | User fills in its profile.               |
+| Consumption    | ConsumptionCompareEvent        |                |            | Fluid / TimeStep      | User compares its consumption.           |
+| Consumption    | ConsumptionChangeTimeStepEvent | TimeStep       |            | Fluid                 | User changes timeStep of its consumption.|
+| Consumption    | ConsumptionInteracteEvent      |                |            | Fluid / TimeStep      | User selects a consumption on the chart. |
+
+## Usage events aggregator service
+
+
+
--- a/docs/ecolyo/project_architecture/doctypes.md
+++ b/docs/ecolyo/project_architecture/doctypes.md
--- a/mkdocs.yml
+++ b/mkdocs.yml
-site_name: Self Data Grand Lyon - Technical Docs
-site_description: Self Data Grand Lyon Project Documentation with Markdown.
-site_author: Métropole de Lyon
-repo_name: "Clone the Project"
-repo_url: "https://forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc"
-
-theme:
-  name: "material"
-  # logo: 'img/self_data_grdlyon.png'
-  favicon: "img/self_data_grdlyon.png"
-  palette:
-    primary: "white"
-    accent: "red"
-
-markdown_extensions:
-  - admonition
-  - plantuml_markdown:
-      server: http://www.plantuml.com/plantuml
-  - attr_list
-  - pymdownx.emoji
-
-extra_css:
-  - "stylesheets/extra.css"
-
-nav:
-  - Home: index.md
-  - Easy Cozy:
-      - Scripts: easycozy/scripts.md
-      - Commands: easycozy/commands.md
-      - Tips: easycozy/tips.md
-  - Ecolyo:
-      - Introduction: ecolyo/index.md
-      - Getting started:
-          - Setup your environment: ecolyo/getting_started/setup_your_environment.md
-          - Launch the application on local: ecolyo/getting_started/launch_local_application.md
-          - Launch a konnector on local: ecolyo/getting_started/launch_local_konnector.md
-      - Project Architecture:
-          - Architecture: ecolyo/project_architecture/architecture.md
-          - Libraries: ecolyo/project_architecture/libraries.md
-          - Environments: ecolyo/project_architecture/environments.md
-          - DocTypes: ecolyo/project_architecture/doctypes.md
-      - Application:
-          - Description: ecolyo/application/description.md
-          - Redux: ecolyo/application/redux.md
-          - Scaffolding: ecolyo/application/scaffolding.md
-          - Services: ecolyo/application/services.md
-          - Gitflow: ecolyo/application/gitflow.md
-          - Deploy: ecolyo/application/deploy.md
-      - Functionalities:
-          - Initialization: ecolyo/functionalities/initialization.md
-          - Consumption: ecolyo/functionalities/consumption.md
-          - Ecogesture: ecolyo/functionalities/ecogesture.md
-          - Challenge: ecolyo/functionalities/challenge.md
-          - Profile Type: ecolyo/functionalities/profile_type.md
-  - Pilote:
-      - Pilote - TS - Back:
-          - Index: pilote/Pilote - TS - Back/index.md
-          - Application:
-              - Deploy: pilote/Pilote - TS - Back/application/deploy.md
-          - Functionalities:
-              - Routes: pilote/Pilote - TS - Back/functionalities/routes.md
-          - Getting Started:
-              - Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md
-              - Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md
-          - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md
-      - Pilote - TS - Front:
-          - Index: pilote/Pilote - TS - Front/index.md
-          - Application:
-              - Deploy: pilote/Pilote - TS - Front/application/deploy.md
-          - Functionalities:
-              - Routes: pilote/Pilote - TS - Front/functionalities/functions.md
-          - Getting Started:
-              - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md
-      - Pilote - Usager:
-          - Application:
-              - Deploy: pilote/Pilote - Usager/application/deploy.md
-              - Doctypes: pilote/Pilote - Usager/application/doctypes.md
-              - Gitflow: pilote/Pilote - Usager/application/gitflow.md
-              - Scaffolding: pilote/Pilote - Usager/application/scaffolding.md
-              - Services: pilote/Pilote - Usager/application/services.md
-              - Store: pilote/Pilote - Usager/application/store.md
-          - Functionalities:
-              - Appointments: pilote/Pilote - Usager/functionalities/appointments.md
-              - Contact: pilote/Pilote - Usager/functionalities/contact.md
-              - Document: pilote/Pilote - Usager/functionalities/document.md
-              - Settings: pilote/Pilote - Usager/functionalities/setting.md
-          - Getting Started:
-              - Launch local doctypes: pilote/Pilote - Usager/getting_started/launch_local_doctypes.md
-              - Launch local services: pilote/Pilote - Usager/getting_started/launch_local_services.md
-  - Konnectors:
-      - Enedis: konnectors/enedis.md
-      - GRDF: konnectors/grdf.md
-      - Eau du Grand Lyon: konnectors/egl.md
-  - Proxy:
-      - Description: proxy/description.md
-      - Monitoring: proxy/monitoring.md
-      - Use cases:
-          - Enedis: proxy/use_cases/enedis.md
-          - Grdf Adict: proxy/use_cases/grdfadict.md
+site_name: Self Data Grand Lyon - Technical Docs
+site_description: Self Data Grand Lyon Project Documentation with Markdown.
+site_author: Métropole de Lyon
+repo_name: "Clone the Project"
+repo_url: "https://forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc"
+
+theme:
+  name: "material"
+  # logo: 'img/self_data_grdlyon.png'
+  favicon: "img/self_data_grdlyon.png"
+  palette:
+    primary: "white"
+    accent: "red"
+
+markdown_extensions:
+  - admonition
+  - plantuml_markdown:
+      server: http://www.plantuml.com/plantuml
+  - attr_list
+  - pymdownx.emoji
+
+extra_css:
+  - "stylesheets/extra.css"
+
+nav:
+  - Home: index.md
+  - Easy Cozy:
+      - Scripts: easycozy/scripts.md
+      - Commands: easycozy/commands.md
+      - Tips: easycozy/tips.md
+  - Ecolyo:
+      - Introduction: ecolyo/index.md
+      - Getting started:
+          - Setup your environment: ecolyo/getting_started/setup_your_environment.md
+          - Launch the application on local: ecolyo/getting_started/launch_local_application.md
+          - Launch a konnector on local: ecolyo/getting_started/launch_local_konnector.md
+      - Project Architecture:
+          - Architecture: ecolyo/project_architecture/architecture.md
+          - Libraries: ecolyo/project_architecture/libraries.md
+          - Environments: ecolyo/project_architecture/environments.md
+          - DocTypes: ecolyo/project_architecture/doctypes.md
+      - Application:
+          - Description: ecolyo/application/description.md
+          - Redux: ecolyo/application/redux.md
+          - Scaffolding: ecolyo/application/scaffolding.md
+          - Services: ecolyo/application/services.md
+          - Gitflow: ecolyo/application/gitflow.md
+          - Deploy: ecolyo/application/deploy.md
+      - Functionalities:
+          - Initialization: ecolyo/functionalities/initialization.md
+          - Consumption: ecolyo/functionalities/consumption.md
+          - Ecogesture: ecolyo/functionalities/ecogesture.md
+          - Challenge: ecolyo/functionalities/challenge.md
+          - Profile Type: ecolyo/functionalities/profile_type.md
+          - Usage events tracking: ecolyo/functionalities/usage_events_tracking.md
+  - Pilote:
+      - Pilote - TS - Back:
+          - Index: pilote/Pilote - TS - Back/index.md
+          - Application:
+              - Deploy: pilote/Pilote - TS - Back/application/deploy.md
+          - Functionalities:
+              - Routes: pilote/Pilote - TS - Back/functionalities/routes.md
+          - Getting Started:
+              - Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md
+              - Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md
+          - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md
+      - Pilote - TS - Front:
+          - Index: pilote/Pilote - TS - Front/index.md
+          - Application:
+              - Deploy: pilote/Pilote - TS - Front/application/deploy.md
+          - Functionalities:
+              - Routes: pilote/Pilote - TS - Front/functionalities/functions.md
+          - Getting Started:
+              - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md
+      - Pilote - Usager:
+          - Application:
+              - Deploy: pilote/Pilote - Usager/application/deploy.md
+              - Doctypes: pilote/Pilote - Usager/application/doctypes.md
+              - Gitflow: pilote/Pilote - Usager/application/gitflow.md
+              - Scaffolding: pilote/Pilote - Usager/application/scaffolding.md
+              - Services: pilote/Pilote - Usager/application/services.md
+              - Store: pilote/Pilote - Usager/application/store.md
+          - Functionalities:
+              - Appointments: pilote/Pilote - Usager/functionalities/appointments.md
+              - Contact: pilote/Pilote - Usager/functionalities/contact.md
+              - Document: pilote/Pilote - Usager/functionalities/document.md
+              - Settings: pilote/Pilote - Usager/functionalities/setting.md
+          - Getting Started:
+              - Launch local doctypes: pilote/Pilote - Usager/getting_started/launch_local_doctypes.md
+              - Launch local services: pilote/Pilote - Usager/getting_started/launch_local_services.md
+  - Konnectors:
+      - Enedis: konnectors/enedis.md
+      - GRDF: konnectors/grdf.md
+      - Eau du Grand Lyon: konnectors/egl.md
+  - Proxy:
+      - Description: proxy/description.md
+      - Monitoring: proxy/monitoring.md
+      - Use cases:
+          - Enedis: proxy/use_cases/enedis.md
+          - Grdf Adict: proxy/use_cases/grdfadict.md