element-android-Github/docs/analytics.md

# Analytics in Element

<!--- TOC -->

* [Solution](#solution)
* [How to add a new Event](#how-to-add-a-new-event)
* [Forks of Element](#forks-of-element)

<!--- END -->

## 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.
Analytics: Add a very short doc. 2021-12-07 20:19:59 +08:00			`# Analytics in Element`

Setup knit TOC. Only ## and more heading will be listed, so add a "h" level. 2022-05-30 20:34:32 +08:00			`<!--- TOC -->`
Call `./gradlew knit` to generate the TOC 2022-05-30 20:35:11 +08:00
			`* [Solution](#solution)`
			`* [How to add a new Event](#how-to-add-a-new-event)`
			`* [Forks of Element](#forks-of-element)`

Setup knit TOC. Only ## and more heading will be listed, so add a "h" level. 2022-05-30 20:34:32 +08:00			`<!--- END -->`

Analytics: Add a very short doc. 2021-12-07 20:19:59 +08:00			`## 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.`