omni::telemetry

namespace telemetry

Functions

• omni::telemetry::createGuard: Create a guard with the standard name and path for the transmitter.

• omni::telemetry::getTransmitterLogPath: Determine the directory where the logs of a launched transmitter process should go.

• omni::telemetry::launchTransmitter: Launch the telemetry transmitter process.

Variables

• omni::telemetry::kAllowRootSetting: This allows the transmitter to run as the root user on Linux.

• omni::telemetry::kEventProtocolLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::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.

• omni::telemetry::kIgnoreOldEventsSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kLogFileSetting: The log file path that will be used for any transmitter processes launched.

• omni::telemetry::kLogLevelSetting: The log level that will be used for any transmitter process launched.

• omni::telemetry::kMessageMatchingModeLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kOldEventThresholdSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kPollTimeSetting: The time, in seconds, that the transmitter will wait between polling the log files.

• omni::telemetry::kPseudonymizeOldEventsSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kQueueLimitSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::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.

• omni::telemetry::kResendEventsSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kRestrictedRegionAssumptionSetting: The assumption of success or failure that should be assumed if the country name and code could not be retrieved.

• omni::telemetry::kRestrictedRegionsSetting: The list of restricted regions for the transmitter.

• omni::telemetry::kRetryLimitSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kSeekTagNameLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kStayAliveSetting: Telemetry transmitter app settings.

• omni::telemetry::kTelemetryAuthTokenExpiryNameSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryAuthTokenKeyNameSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryAuthTokenTypeLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryAuthTokenUrlSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryAuthenticateSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryDisableAnonymousDataEnvvar: Environment variable name that allows the kTelemetryEnableAnonymousDataSetting setting to be overridden externally.

• omni::telemetry::kTelemetryEnableAnonymousDataSetting: Setting to enable an anonymous data telemetry mode.

• omni::telemetry::kTelemetryEndpointSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTelemetryModeSetting: The mode to run the transmitter in.

• omni::telemetry::kTelemetryRunEnvironmentSetting: Sets the run environment that determines which flavor of Kit is currently being run.

• omni::telemetry::kTelemetrySchemasUrlSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTransmissionLimitSettingLeaf: This setting is an optional member of the kTransmitterSetting object.

• omni::telemetry::kTransmitterSetting: This settings key holds an object or an array of objects.

• omni::telemetry::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.

• omni::telemetry::kUseOpenEndpointSetting: This allows the telemetry transmitter to be launched in an 'open endpoint' mode.