kTelemetryDisableAnonymousDataEnvvar

Fully qualified name: omni::telemetry::kTelemetryDisableAnonymousDataEnvvar

Defined in omni/structuredlog/Telemetry.h

constexpr char omni::telemetry::kTelemetryDisableAnonymousDataEnvvar[] = "OMNI_TELEMETRY_DISABLE_ANONYMOUS_DATA"

Environment variable name that allows the kTelemetryEnableAnonymousDataSetting setting to be overridden externally.

This is intended to provide way to opt-out of anonymous telemetry for containerized apps if they are configured to opt-in by default. This environment variable is intended to be set inside the container at container launch time. Setting this to a boolean convertable value such as ‘1’, ‘t’, ‘T’, ‘y’, or ‘Y’ will override the behavior of the kTelemetryEnableAnonymousDataSetting setting. Setting it to any other value will allow any configured value of the setting to take effect. Effectively, with the anonymous data feature overridden with this variable, the telemetry system will fall back to its default behavior of expecting the privacy consent and user ID settings in the privacy.toml file. If that file or the consent settings in it are missing (as should be in the containerized case), that will effectively disable transmission of any locally generated telemetry events.

Note

This is not an overall disable for the telemetry system - it only overrides the effects of the kTelemetryEnableAnonymousDataSetting setting and disables that one setting. If telemetry as a whole should be disabled, the /structuredLog/enable boolean setting should be disabled so that nothing is emitted from the app to local log files and so that the telemetry transmitter helper process is not launched by the omni.kit.telemetry extension.