android-components / mozilla.components.service.glean.config / Configuration

Configuration

data class Configuration (source)

The Configuration class describes how to configure the Glean.

Constructors

Name Summary
<init> Configuration(serverEndpoint: String = DEFAULT_TELEMETRY_ENDPOINT, channel: String? = null, maxEvents: Int = DEFAULT_MAX_EVENTS, httpClient: PingUploader = ConceptFetchHttpUploader(lazy { HttpURLConnectionClient() }))

Properties

Name Summary
channel val channel: String?
the release channel the application is on, if known. This will be sent along with all the pings, in the client_info section.
httpClient val httpClient: PingUploader
The HTTP client implementation to use for uploading pings.
logPings val logPings: Boolean
whether to log ping contents to the console. This is only meant to be used internally by the GleanDebugActivity.
maxEvents val maxEvents: Int
the number of events to store before the events ping is sent
pingTag val pingTag: String?
String tag to be applied to headers when uploading pings for debug view. This is only meant to be used internally by the GleanDebugActivity.
serverEndpoint val serverEndpoint: String
the server pings are sent to. Please note that this is is only meant to be changed for tests.
userAgent val userAgent: String
the user agent used when sending pings, only to be used internally.

Companion Object Properties

Name Summary
DEFAULT_LOG_PINGS const val DEFAULT_LOG_PINGS: Boolean
DEFAULT_MAX_EVENTS const val DEFAULT_MAX_EVENTS: Int
DEFAULT_TELEMETRY_ENDPOINT const val DEFAULT_TELEMETRY_ENDPOINT: String
DEFAULT_USER_AGENT const val DEFAULT_USER_AGENT: String