omni::structuredlog::kNeedLogHeadersSetting

Defined in omni/structuredlog/StructuredLogSettingsUtils.h

constexpr const char *omni::structuredlog::kNeedLogHeadersSetting = "/structuredLog/needLogHeaders"

The setting path that will indicate whether headers will be added to each log file that is written to disk.

Each log file will have one header on the first line that is a JSON object that indicates the origin of the log and the version of the omni.structuredlog.plugin plugin that created it. This header object is followed by whitespace to allow it to be modified later as needed without having to rewrite the entire file. The telemetry transmitter consumes this header object and modifies it to indicate its processing progress. Without this header, the telemetry transmitter will ignore the log file. This setting defaults to true.