From 70bbb649a79f4d6eb3d6d95ac81566814f96e95a Mon Sep 17 00:00:00 2001 From: Julian Risch Date: Fri, 25 Mar 2022 11:59:39 +0100 Subject: [PATCH] change docu text about how to opt-out (#2358) * change docu text about how to opt-out * Update Documentation & Code Style Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- haystack/telemetry.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/haystack/telemetry.py b/haystack/telemetry.py index da257ae50..317a95feb 100644 --- a/haystack/telemetry.py +++ b/haystack/telemetry.py @@ -3,7 +3,7 @@ Telemetry Haystack reports anonymous usage statistics to support continuous software improvements for all its users. An example report can be inspected via calling print_telemetry_report(). Check out the documentation for more details: https://haystack.deepset.ai/guides/telemetry - You can opt-out of sharing usage statistics by setting the environment variable HAYSTACK_TELEMETRY_ENABLED to "False" or calling disable_telemetry(). + You can opt-out of sharing usage statistics by calling disable_telemetry() or by manually setting the environment variable HAYSTACK_TELEMETRY_ENABLED as described for different operating systems on the documentation page. You can log all events to the local file specified in LOG_PATH for inspection by setting the environment variable HAYSTACK_TELEMETRY_LOGGING_TO_FILE_ENABLED to "True". """ import sys @@ -297,7 +297,7 @@ def _write_telemetry_config(): # show a log message if telemetry config is written for the first time if not CONFIG_PATH.is_file(): logger.info( - f'Haystack sends anonymous usage data to understand the actual usage and steer dev efforts towards features that are most meaningful to users. You can opt out at anytime by setting {HAYSTACK_TELEMETRY_ENABLED}="False" as an environment variable or by calling disable_telemetry(). More information at https://haystack.deepset.ai/guides/telemetry' + f"Haystack sends anonymous usage data to understand the actual usage and steer dev efforts towards features that are most meaningful to users. You can opt-out at anytime by calling disable_telemetry() or by manually setting the environment variable HAYSTACK_TELEMETRY_ENABLED as described for different operating systems on the documentation page. More information at https://haystack.deepset.ai/guides/telemetry" ) CONFIG_PATH.parents[0].mkdir(parents=True, exist_ok=True) user_id = _get_or_create_user_id()