Skip to content

Commit e7acdaf

Browse files
authored
Add Telemetry page (#1020)
* Add new Telemetry page in feature references * Incorporate feedback Add section 'Why collect telemetry data', change amplitude metrics to bulleted list, add instructions for disabling telemetry on a cloud service * Add telemetry FAQ answer Also incorporate feedback on telemetry page, and move it to /learn/what_is_meilisearch Co-authored-by: Tommy <[email protected]>
1 parent d0db786 commit e7acdaf

File tree

3 files changed

+92
-1
lines changed

3 files changed

+92
-1
lines changed

.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ module.exports = {
4949
'/learn/what_is_meilisearch/philosophy',
5050
'/learn/what_is_meilisearch/sdks',
5151
'/learn/what_is_meilisearch/comparison_to_alternatives',
52+
'/learn/what_is_meilisearch/telemetry',
5253
'/learn/what_is_meilisearch/contact',
5354
],
5455
},
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
sidebarDepth: 2
3+
---
4+
5+
# Telemetry
6+
7+
MeiliSearch collects anonymized data from users in order to improve our product. This can be [deactivated at any time](#how-to-disable-data-collection).
8+
9+
Note that while MeiliSearch is running in [`development` mode](/reference/features/configuration.md#environment), no data is collected.
10+
11+
## What kind of data do we collect?
12+
13+
We use two data-collection tools: [Amplitude](https://amplitude.com/amplitude-analytics) and [Sentry](https://sentry.io/welcome/). Both can be disabled by [following the below procedure](#how-to-disable-data-collection).
14+
15+
**Amplitude** collects the following datapoints:
16+
17+
- Amount of time the MeiliSearch instance has been running
18+
- MeiliSearch version
19+
- Technical specs of the device running MeiliSearch
20+
- Number of documents per index
21+
22+
**Sentry** collects information about errors that occur while using MeiliSearch—in other words, bug reports and diagnostics.
23+
24+
**We will absolutely never identify users, track users, or collect private information**, including IP address, email, or website URLs. All of our data collection is **GDPR-compliant** and **secure**.
25+
26+
::: tip
27+
28+
In the future, we may collect additional metrics relating to new features. This page will be kept up-to-date, but for the most precise information be sure to check the release notes after each new version. <Badge text="soon" type="warn"/>
29+
30+
:::
31+
32+
## Why collect telemetry data?
33+
34+
We collect anonymized data for only two reasons: so that we can improve our product, and so that we can continue working on this project full-time.
35+
36+
In order to better address our users' needs and chart a clear path forward for MeiliSearch, we need reliable quantitative information. The information we collect helps us fix bugs, evaluate the success of certain features, and identify our strengths and weaknesses as a product.
37+
38+
We also need to prove that people are actually using MeiliSearch! Usage metrics help us justify our existence to investors so that we can keep this project alive.
39+
40+
## How to disable data collection
41+
42+
Data collection can be disabled at any time by setting a command-line option or environment variable, then restarting the MeiliSearch instance.
43+
44+
:::: tabs
45+
46+
::: tab Command-line option
47+
48+
```bash
49+
meilisearch --no-analytics=true
50+
```
51+
52+
:::
53+
54+
::: tab Environment variable
55+
56+
```bash
57+
export MEILI_NO_ANALYTICS=true
58+
meilisearch
59+
```
60+
61+
:::
62+
63+
::: tab Cloud service
64+
65+
```bash
66+
# The following procedure should work for all cloud providers,
67+
# including DigitalOcean, Google Cloud Platform, and Amazon Web Services.
68+
# First, open /etc/systemd/system/meilisearch.service with a text editor:
69+
70+
nano /etc/systemd/system/meilisearch.service
71+
72+
# Then add --no-analytics=true at the end of the command in ExecStart
73+
# Don't forget to save and quit!
74+
# Finally, run the following two commands:
75+
76+
systemctl daemon-reload
77+
systemctl restart meilisearch
78+
```
79+
80+
:::
81+
82+
::::
83+
84+
For more information about configuring MeiliSearch, read our [configuration reference](/reference/features/configuration.md).

resources/faq.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,13 @@ In general, we recommend the former. However, if you need to reduce the size of
235235

236236
- **More relevancy rules => a larger database**
237237
- The proximity [ranking rule](/learn/core_concepts/relevancy.md#ranking-rules) alone can be responsible for almost 80% of database size
238-
- [Faceting](/reference/features/faceted_search.md) also consumes a large amount of disk space
238+
- Adding many attributes to [filterableAttributes](/reference/features/settings.md#attributes-for-faceting) also consumes a large amount of disk space
239239
- Multi-lingual datasets are costly, so split your dataset—one language per index
240240
- [Stop words](/reference/features/stop_words.md) are essential to reducing database size
241241
- Not all attributes need to be [searchable](/reference/features/field_properties.md#searchable-fields). Avoid indexing unique IDs.
242+
243+
## Why does MeiliSearch send data to Amplitude? Does MeiliSearch track its users?
244+
245+
**MeiliSearch will never track or identify individual users**. That being said, we do use Amplitude and Sentry to collect anonymous data about user trends and bug reports.
246+
247+
You can read more about what metrics we collect, why we collect them, and how to disable it on our [telemetry page](/learn/what_is_meilisearch/telemetry.md). Transparency is very important to us, so if you feel we are lacking in this area please [open an issue](https://github.com/meilisearch/documentation/issues/new/choose) and let us know! ❤️

0 commit comments

Comments
 (0)