From fa0e2cd4516091b5ca6389ed4b7fbb1507d9b200 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Tue, 7 Dec 2021 13:19:59 +0100 Subject: [PATCH] Analytics: Add a very short doc. --- docs/analytics.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/analytics.md diff --git a/docs/analytics.md b/docs/analytics.md new file mode 100644 index 0000000000..135ace81b0 --- /dev/null +++ b/docs/analytics.md @@ -0,0 +1,16 @@ +# Analytics in Element + +## Solution + +Element is using PostHog to send analytics event. +We ask for the user to give consent before sending any analytics data. + +## How to add a new Event + +The analytics plan is shared between all Element clients. To add an Event, please open a PR to this project: https://github.com/matrix-org/matrix-analytics-events + +Then, once the PR has been merged, you can run the tool `import_analytic_plan.sh` to import the plan to Element, and then you can use the new Event. Note that this tool is run by Github action once a week. + +## Forks of Element + +Analytics on forks are disabled by default. Please refer to AnalyticsConfig and there implementation to setup analytics on your project.