From 715b09db85fbb858d16a638ebeb5125ed7ee4cd5 Mon Sep 17 00:00:00 2001 From: Marcos Oliveira Date: Thu, 10 Oct 2024 12:50:23 -0300 Subject: [PATCH] chore: update analytics --- general/analytics.mdx | 54 +++++++++++++++---------------------------- 1 file changed, 18 insertions(+), 36 deletions(-) diff --git a/general/analytics.mdx b/general/analytics.mdx index 03c575f..8af30f1 100644 --- a/general/analytics.mdx +++ b/general/analytics.mdx @@ -2,46 +2,28 @@ title: Analytics - How we collect data --- -## Overview +### Overview -BetterVim provides an opt-in feature for collecting anonymous analytics data, which helps us improve the quality of our plugins and your overall experience. We use [PostHog](https://posthog.com) as our analytics platform to gather insights into how BetterVim is used, which enables us to make data-driven decisions. +We are sending analytics events from BetterVim to help improve the product by making data-driven decisions. The data we collect is fully anonymous, and we’ve taken care to ensure privacy is respected. -## Why We Collect Data +#### What We Collect: +- **Leader Key**: The key you set as your leader in BetterVim. +- **Plugins**: The list of installed plugins. +- **LSPs**: The language servers you're using. +- **Treesitter**: Information about Treesitter parsers in use. +- **Flags Enabled**: Configuration flags that are active in your setup. -The purpose of collecting analytics data is to better understand how our users interact with BetterVim. This information allows us to: +#### How We Ensure Anonymity: +The data is truly anonymous because we do **not** rely on any identifier that could link back to you personally. Instead, we generate a unique ID per installation purely to count unique events by user. This ID is in no way tied to personal information, including your details on Gumroad or any other service. -- Identify which features are most popular. -- Ensure new updates improve usability and performance. -- Make informed decisions when prioritizing enhancements and new features. +#### Analytics Tool: +We use **[PostHog](https://posthog.com/)** as our analytics tool, but we’ve disabled geo-IP collection to avoid gathering any geolocation data, such as country or city. This ensures we don’t track or store your location information. -By opting in, you help us improve the product effectively based on actual usage patterns. +#### When We Send Data: +We send analytics data every two hours, but only when the editor is opened. Upon opening the editor, we check if two hours have passed since the last event. If so, the data is sent; if not, the event is bypassed. -## What We Collect - -We take privacy seriously. All data collected is anonymized and only relates to your usage of BetterVim. Here’s what we collect: - -- **Plugin Events**: Information about how and when you use BetterVim plugins. -- **Configuration Details**: General details of your Neovim configuration that are relevant to understanding compatibility and usage. For example: - - Which features are enabled or disabled. - - Information related to BetterVim themes (e.g., if `yugen.nvim` is in use). - -### What We Don't Collect - -- **Personal Information**: We do not collect your name, email, or any personally identifiable information. -- **Sensitive Data**: We only collect information related to your Neovim configuration, and nothing more. - -The data we collect is tied to a unique license identifier, which does not reveal any personal information. - -## How to Review the Implementation - -We believe in transparency, and we encourage users to verify what’s being collected. You can check the analytics implementation directly in your local Neovim configuration. - -To do so, navigate to the following file in your Neovim config: -```sh -nvim ~/.config/nvim/lua/better-vim-core/tasks/analytics.lua -``` - -This file contains the code responsible for sending analytics events to our API. You can inspect the exact data being sent, how it is anonymized, and how it is processed. - -Feel free to reach out with any questions or concerns—your trust is important to us, and we are committed to maintaining it. +#### Purpose of Data Collection: +The collected data is used exclusively to help us make decisions based on product usage trends. It allows us to prioritize features and improvements that matter most to our users. +#### What We Don’t Collect: +We are **not** collecting any other details about your environment beyond the listed information. You can access the implementation of our analytics at `~/.config/nvim/lua/better-vim-core/tasks/analytics.lua`, and the exact data being sent can be viewed at `~/.config/better-vim/.bettervim-analytics-data.json`.