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 const char *const kAllowRootSetting
This allows the transmitter to run as the root user on Linux.
- constexpr const char *const kEventProtocolLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const 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 const char *const kIgnoreOldEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kLaunchGuardNameSetting
This allows the name of the transmitter launch guard to be changed from its default.
- constexpr const char *const kLogFileSetting
The log file path that will be used for any transmitter processes launched.
- constexpr const char *const kLogLevelSetting
The log level that will be used for any transmitter process launched.
- constexpr const char *const kMessageMatchingModeLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kOldEventThresholdSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kPollTimeSetting
The time, in seconds, that the transmitter will wait between polling the log files.
- constexpr const char *const kPseudonymizeOldEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kQueueLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const 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 const char *const kResendEventsSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kRestrictedRegionAssumptionSetting
The assumption of success or failure that should be assumed if the country name and code could not be retrieved.
- constexpr const char *const kRestrictedRegionsSetting
The list of restricted regions for the transmitter.
- constexpr const char *const kRetryLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kSeekTagNameLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kStayAliveSetting
Telemetry transmitter app settings.
- constexpr const char *const kTelemetryAuthTokenExpiryNameSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryAuthTokenKeyNameSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryAuthTokenTypeLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryAuthTokenUrlSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryAuthenticateSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryDisableAnonymousDataEnvvar
Environment variable name that allows the kTelemetryEnableAnonymousDataSetting setting to be overridden externally.
- constexpr const char *const kTelemetryEnableAnonymousDataSetting
Setting to enable an anonymous data telemetry mode.
- constexpr const char *const kTelemetryEndpointSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTelemetryModeSetting
The mode to run the transmitter in.
- constexpr const char *const kTelemetryRunEnvironmentSetting
Sets the run environment that determines which flavor of Kit is currently being run.
- constexpr const char *const kTelemetrySchemasUrlSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const 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 const char *const kTransmissionLimitSettingLeaf
This setting is an optional member of the kTransmitterSetting object.
- constexpr const char *const kTransmitterSetting
This settings key holds an object or an array of objects.
- constexpr const 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 const char *const kUseOpenEndpointSetting
This allows the telemetry transmitter to be launched in an 'open endpoint' mode.