Skip to content

Commit 5832190

Browse files
authored
SNOW-1432591: update readme on disabling telemetry (#2028)
1 parent 416ff57 commit 5832190

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,32 @@ These tools are integrated into `tox` to allow us to easily set them up universa
5252
* **coverage**: Runs `coverage.py` to combine generated coverage data files. Useful when multiple categories were run
5353
and we would like to have an overall coverage data file created for them.
5454
* **flake8**: (Deprecated) Similar to `fix_lint`, but only runs `flake8` checks.
55+
56+
## Disable telemetry
57+
58+
By default, the Snowflake Connector for Python collects telemetry data to improve the product.
59+
You can disable the telemetry data collection by setting the session parameter `CLIENT_TELEMETRY_ENABLED` to `False`
60+
when connecting to Snowflake:
61+
```python
62+
import snowflake.connector
63+
conn = snowflake.connector.connect(
64+
user='XXXX',
65+
password='XXXX',
66+
account='XXXX',
67+
session_parameters={
68+
"CLIENT_TELEMETRY_ENABLED": False,
69+
}
70+
)
71+
```
72+
73+
Alternatively, you can disable the telemetry data collection
74+
by setting the `telemetry_enabled` property to `False` on the `SnowflakeConnection` object:
75+
```python
76+
import snowflake.connector
77+
conn = snowflake.connector.connect(
78+
user='XXXX',
79+
password='XXXX',
80+
account='XXXX',
81+
)
82+
conn.telemetry_enabled = False
83+
```

0 commit comments

Comments
 (0)