telemetry#
Fully qualified name: omni::telemetry
-
namespace telemetry#
Functions#
- extras::UniqueApp createGuard()
Create a guard with the standard name and path for the transmitter.
- std::string getTransmitterLogPath()
Determine the directory where the logs of a launched transmitter process should go.
- bool launchTransmitter(const char *transmitterPath, const std::vector< std::string > extraArgs={})
Launch the telemetry transmitter process.
Variables#
- constexpr char kAllowRootSetting
This allows the transmitter to run as the root user on Linux.
- constexpr char kEventProtocolLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kExtraFieldsToAddSetting
This allows only a subset of the extra fields specified under
/structuredLog/extraFields/to be passed on to the transmitter when it is launched.- constexpr char kIgnoreOldEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kLaunchGuardNameSetting
This allows the name of the transmitter launch guard to be changed from its default.
- constexpr char kLogFileSetting
The log file path that will be used for any transmitter processes launched.
- constexpr char kLogLevelSetting
The log level that will be used for any transmitter process launched.
- constexpr char kMessageMatchingModeLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kOldEventThresholdSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kPollTimeSetting
The time, in seconds, that the transmitter will wait between polling the log files.
- constexpr char kPseudonymizeOldEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kQueueLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kReplaceExtraFieldsSetting
This controls whether the extra fields specified in kExtraFieldsToAddSetting will be replaced in each message if one or more of them already exists or if any fields that already exist in the event will just be ignored.
- constexpr char kResendEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kRestrictedRegionAssumptionSetting
The assumption of success or failure that should be assumed if the country name and code could not be retrieved.
- constexpr char kRestrictedRegionsSetting
The list of restricted regions for the transmitter.
- constexpr char kRetryLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kSeekTagNameLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kStayAliveSetting
Telemetry transmitter app settings.
- constexpr char kTelemetryAuthTokenExpiryNameSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryAuthTokenKeyNameSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryAuthTokenTypeLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryAuthTokenUrlSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryAuthenticateSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryDisableAnonymousDataEnvvar
Environment variable name that allows the kTelemetryEnableAnonymousDataSetting setting to be overridden externally.
- constexpr char kTelemetryEnableAnonymousDataSetting
Setting to enable an anonymous data telemetry mode.
- constexpr char kTelemetryEndpointSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryModeSetting
The mode to run the transmitter in.
- constexpr char kTelemetryRunEnvironmentSetting
Sets the run environment that determines which flavor of Kit is currently being run.
- constexpr char kTelemetrySchemasUrlSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTelemetryTagSetting
This can be used to apply the "(dev)" and "(test)" source tags onto structured log messages without applying the other behavior of kTelemetryModeSetting .
- constexpr char kTransmissionLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr char kTransmitterSetting
This settings key holds an object or an array of objects.
- constexpr char kUploadAllAndExitSetting
When this setting is set to true, it will cause the transmitter to try to upload all the events that are currently stored and exit once there are no remaining events.
- constexpr char kUseOpenEndpointSetting
This allows the telemetry transmitter to be launched in an 'open endpoint' mode.