No capability to disable telemetry via env var [bug]

[TheDen]

Describe the bug
Not being able to disable telemetry via an env var or a configuration is an issue since for certain protected environments where egress is disabled, causing a deluge of messy err stack traces in the logs.

I'm not sure if there is currently a way to disable telemetry for guardrails, as in I couldn't find an option in the documentation.

To Reproduce
Run guardrails in an environment that doesn't allow egress to domains that aren't on an allowlist

Expected behavior
An env var or programmatic config to disable telemetry

Library version:
Since #559

[CalebCourier]

Hi @TheDen, thanks for raising this issue! There are a couple of ways you can opt-out of telemetry.

The primary method is to run guardrails configure --no-metrics=True. However, if you're running guardrails on a non-user machine you may not be able to do this due to the interactive nature of the configure command.

If that is the case, you can place a .guardrailsrc file in the root directory with the following contents no_metrics=true. The exact location of this file varies based on your operating system, for example on a mac it is located at ~/.guardrailsrc whereas in a Linux based Docker image it would be at /root/.guardrailsrc.

I also agree that there should be an easier way to control this feature like an environment variable. I'll bring this up with the rest of the team and get something out for that. In the meantime, I hope the above information helps.

[TheDen]

Thanks for the info @CalebCourier, we'll use the dotfile config approach for now—also thanks for raising the env var control with the team, we're looking forward to it being rolled out!

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[github-actions]

This issue was closed because it has been stalled for 14 days with no activity.