omni::structuredlog::kHeartbeatPeriodSetting

Defined in omni/structuredlog/StructuredLogSettingsUtils.h

constexpr const char *omni::structuredlog::kHeartbeatPeriodSetting = "/structuredLog/heartbeatPeriod"

The setting path that will contain the minimum number of seconds between heartbeat events A heartbeat event is one that is sent periodically to help calculate session lengths even if the expected ‘exit’ or ‘crash’ process lifetime events are missing.

These events can be missing in such unavoidable cases as a power loss, the user killing the process, a blue screen of death or kernel panic, etc. These situations cannot be assumed as either crashes or normal exits, but at least these events can help indicate how long the actual session was. This can be set to 0 to disable the heartbeat messages. By default the heartbeat events are disabled (ie: set to kHeartbeatDisabled).