kTelemetryModeSetting#

Fully qualified name: omni::telemetry::kTelemetryModeSetting

Defined in omni/structuredlog/Telemetry.h

constexpr char omni::telemetry::kTelemetryModeSetting[] = "/telemetry/mode"#

The mode to run the transmitter in.

The value of this setting can be “prod”, “dev” or “test”. By default, the transmitter will run in “production” mode. In “dev” mode, the transmitter will use the default development schemas URL. In “test” mode, the default staging endpoint URL will be used. The “test” mode is only supported in debug builds. If “test” is used in a release build, it will be ignored and the production endpoint will be used instead.

Note that if the schemas package for the requested mode is empty, the transmitter will just immediately exit since there is nothing for it to process.

This will also apply a “(dev)” or “(test)” tag onto the source of structured log messages when in “dev” and “test” mode, respectively.

Note

This setting is only applied on startup and changing it later into the process will have no effect. Use structuredlog::IStructuredLogSettings3 to change tagging if needed.