Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit a23bb12

Browse files
authored
Update README.md
Updated the writeup
1 parent 5ef9b1d commit a23bb12

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -472,36 +472,29 @@ If you pass `--stats` you'll see e.g. what % of rows were different.
472472
gaps), and improvements to bypass Python/driver performance limitations when
473473
comparing huge amounts of rows locally (i.e. for very high `bisection_threshold` values).
474474

475-
# Anonymous Tracking
475+
# Usage Analytics
476476

477-
data-diff collects anonymous usage data, in order to improve the tool, and our understanding of our user base.
477+
data-diff collects anonymous usage data to help our team improve the tool and to apply development efforts to where our users need them most.
478478

479-
The data is sent home once when the tool starts, and once when it ends its run.
480-
We do not collect any sensitive information.
481-
482-
The collected data is limited to:
479+
We capture two events, one when the data-diff run starts and one when it finished. No user data or potentially sensitive information is or ever will be collected. The captured data is limited to:
483480

484481
- Operating System and Python version
485482

486-
- Names of databases used (postgresql, mysql, etc.)
483+
- Types of databases used (postgresql, mysql, etc.)
487484

488-
- Sizes of tables used, elapsed run time, and diff count. (numbers only)
485+
- Sizes of tables diffed, run time, and diff row count (numbers only)
489486

490487
- Error message, if any, truncated to the first 20 characters.
491488

492489
- A persistent UUID to indentify the session, stored in `~/.datadiff.toml`
493490

494-
If you do not wish to participate, it can be easily disabled.
495-
496-
## Disable
497-
498-
There are several ways to disable the tracking.
491+
If you do not wish to participate, the tracking can be easily disabled with one of the following methods:
499492

500-
In the CLI, use the `--no-tracking` flag.
493+
* In the CLI, use the `--no-tracking` flag.
501494

502-
In the config file, set `no_tracking = true` (for example, under `[run.default]`)
495+
* In the config file, set `no_tracking = true` (for example, under `[run.default]`)
503496

504-
If you're using the Python API, do the following:
497+
* If you're using the Python API:
505498

506499
```python
507500
import data_diff

0 commit comments

Comments
 (0)