Skip to content

Commit 3766605

Browse files
authored
Make usage tracking documentation easier to see
In response to [this issue](#217) make the usage tracking information clearer by 1. Removing the disclaimer header 2. Removing collapsed sections 3. Use keywords that are easier to ctrl+f (sentry, telemetry as well as usage tracking)
1 parent c32ece3 commit 3766605

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -648,19 +648,17 @@ See [LICENSE](./LICENSE).
648648

649649
For any queries, reach us at [email protected]
650650

651-
## Disclaimer
652-
<details>
653-
<summary><b>Usage Tracking</b></summary>
651+
## Telemetry Usage Tracking and Sentry
654652

655653
We have added an experimental crash report collection, using [sentry.io](https://github.com/getsentry/). It does not collect user data other than anonymized IP address data, and it only logs fastdup library's own actions. We do NOT collect folder names, user names, image names, image content only aggregate performance statistics like total number of images, average runtime per image, total free memory, total free disk space, number of cores, etc. Collecting fastdup crashes will help us improve stability.
656654

657-
The code for the data collection is found [here](./src/sentry.hpp). On MAC we use [Google crashpad](https://chromium.googlesource.com/crashpad/crashpad).
655+
The code for the data collection is found [here](./src/sentry.hpp) (cpp) and [here](./fastdup/sentry.py) (python) . On MAC we use [Google crashpad](https://chromium.googlesource.com/crashpad/crashpad).
658656

659657
It is always possible to opt out of the experimental crash report collection via either of the following two options:
660658
- Define an environment variable called `SENTRY_OPT_OUT`
661659
- or run() with `turi_param='run_sentry=0'`
662660

663-
</details>
661+
664662

665663
## About Visual-Layer
666664

0 commit comments

Comments
 (0)