Skip to content

Commit 92441f4

Browse files
authored
Merge pull request #218 from talolard/patch-1
Make usage tracking documentation easier to see
2 parents 0278634 + 3766605 commit 92441f4

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
@@ -695,19 +695,17 @@ See [LICENSE](./LICENSE).
695695

696696
For any queries, reach us at [email protected]
697697

698-
## Disclaimer
699-
<details>
700-
<summary><b>Usage Tracking</b></summary>
698+
## Telemetry Usage Tracking and Sentry
701699

702700
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.
703701

704-
The code for the data collection is found [here](./src/sentry.hpp). On MAC we use [Google crashpad](https://chromium.googlesource.com/crashpad/crashpad).
702+
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).
705703

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

710-
</details>
708+
711709

712710
## About Visual-Layer
713711

0 commit comments

Comments
 (0)