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

Commit 3d19330

Browse files
committed
Create usage_analytics.md
1 parent fef3939 commit 3d19330

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/usage_analytics.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Usage Analytics & Data Privacy
2+
3+
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.
4+
5+
We capture two events: one when the data-diff run starts, and one when it is finished. No user data or potentially sensitive information is or ever will be collected. The captured data is limited to:
6+
7+
- Operating System and Python version
8+
- Types of databases used (postgresql, mysql, etc.)
9+
- Sizes of tables diffed, run time, and diff row count (numbers only)
10+
- Error message, if any, truncated to the first 20 characters.
11+
- A persistent UUID to indentify the session, stored in `~/.datadiff.toml`
12+
13+
To disable, use one of the following methods:
14+
15+
* **CLI**: use the `--no-tracking` flag.
16+
* **Config file**: set `no_tracking = true` (for example, under `[run.default]`)
17+
* **Python API**:
18+
```python
19+
import data_diff
20+
# Invoke the following before making any API calls
21+
data_diff.disable_tracking()
22+
```

0 commit comments

Comments
 (0)