omni::telemetry::kTelemetryEnableAnonymousDataSetting

Defined in omni/structuredlog/Telemetry.h

constexpr const char *const omni::telemetry::kTelemetryEnableAnonymousDataSetting = "/telemetry/enableAnonymousData"

Setting to enable an anonymous data telemetry mode.

Setting this to true has a number of side effects that would affect the telemetry behavior for the entire process and potentially even other running Omniverse apps’ processes (since all concurrently running apps share a single telemetry transmitter instance). The side effects include:

  • Clearing out all user and login information that may have been cached from the privacy.toml file. This includes settings like/privacy/userId, /privacy/idpId, /privacy/idpName, /privacy/email, etc.

  • Forcing all consent levels to be enabled.

  • Disabling any dev-only output.

  • Ensuring production mode will be used for all structured log nessage output and for the telemetry transmitter.

  • Setting the user ID to the same random number that selected on app startup.

  • Enabling open-endpoint mode for the telemetry transmitter launch.

All of these settings changes are made both in all internally cached locations for the information, and in non-persistant parts of the settings registry itself. This is done so that any other system that may query those settings would also correctly pick up on the anonymous data mode change. This setting defaults to false.

Note

Since this setting has a potential reach beyond the behavior of just the current process, care should be taken in using it. Using this setting is ideal for container situations where only a single app would be running with a single transmitter working out of a non-shared log directory.

Note

Also note that enabling this setting will result in the setting the user ID with omni::structuredlog::IStructuredLogSettings::setUserId() being prevented. This is to prevent a non-anonymous user ID from being set by another system and incorrectly or inadvertently introducing PII into what should otherwise be anonymous data.