共享哪些信息？

Haystack 中的遥测包含基础组件的匿名使用统计信息，例如：DocumentStore (文档存储), Retriever (检索器), Reader，或其他管道组件。每次初始化这些组件时，我们都会收到一个事件。这样，我们就能知道哪些组件对我们的社区最重要。出于同样的原因，在执行教程之一时也会发送一个事件。

每个事件都包含一个匿名的、随机生成的用户 ID（uuid）以及关于您的执行环境的属性集合。它们 **绝不** 包含可用于识别您的属性，例如：

• IP 地址
• 主机名
• 文件路径
• 查询
• 文档内容

通过采取上述步骤，我们确保只有匿名数据被传输到我们的遥测服务器。

以下是一个示例事件，当通过运行执行教程 1 时发送：Tutorial1_Basic_QA_Pipeline.py:

{
    "event": "tutorial 1 executed",
    "distinct_id": "9baab867-3bc8-438c-9974-a192c9d53cd1",
    "properties": {
        "os_family": "Darwin",
        "os_machine": "arm64",
        "os_version": "21.3.0",
        "haystack_version": "1.0.0",
        "python_version": "3.9.6",
        "torch_version": "1.9.0",
        "transformers_version": "4.13.0",
        "execution_env": "script",
        "n_gpu": 0,
    },
}

我们的遥测代码可以在 GitHub 上直接查看。

遥测有什么帮助？

多亏了遥测，我们可以了解社区的需求：“哪些管道节点最受欢迎？”、“我们是否应该专注于支持特定的文档存储？”、“有多少人在 Windows 上使用 Haystack？”——这些都是遥测帮助我们回答的问题。有关操作系统和已安装依赖项的元数据使我们能够快速识别和解决由特定设置引起的问题。

总之，通过共享这些信息，您使我们能够为所有人持续改进 Haystack。

如何选择退出？

您可以通过以下方法之一禁用遥测：

通过环境变量

您可以设置环境变量HAYSTACK_TELEMETRY_ENABLED 为"False" .

使用 Bash Shell

如果您正在使用 bash shell，请将以下行添加到文件~/.bashrc 中以禁用遥测export HAYSTACK_TELEMETRY_ENABLED=False.

使用 zsh

如果您正在使用 zsh 作为 shell，例如在 macOS 上，请将以下行添加到文件~/.zshrc: export HAYSTACK_TELEMETRY_ENABLED=False.

在 Windows 上

要在 Windows 上禁用遥测，请通过在标准命令提示符中运行此命令来设置用户级别的环境变量：setx HAYSTACK_TELEMETRY_ENABLED "False".

或者，在 Windows PowerShell 中运行以下命令：[Environment]::SetEnvironmentVariable("HAYSTACK_TELEMETRY_ENABLED","False","User").

您可能需要重新启动操作系统才能使命令生效。