View on GitHub
Classes Reference
Classes
The following classes are available globally.
-
Undocumented
See moreDeclaration
Swift
open class BooleanMetric: BooleanMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class CounterMetric: CounterMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class CustomDistributionMetric: CustomDistributionMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class DatetimeMetric: DatetimeMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class DenominatorMetric: DenominatorMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class EventMetric: EventMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class LabeledBoolean: LabeledBooleanProtocol -
Undocumented
See moreDeclaration
Swift
open class LabeledCounter: LabeledCounterProtocol -
Undocumented
See moreDeclaration
Swift
open class LabeledString: LabeledStringProtocol -
Undocumented
See moreDeclaration
Swift
open class MemoryDistributionMetric: MemoryDistributionMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class NumeratorMetric: NumeratorMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class ObjectMetric: ObjectMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class PingType: PingTypeProtocol -
Undocumented
See moreDeclaration
Swift
open class QuantityMetric: QuantityMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class RateMetric: RateMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class StringListMetric: StringListMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class StringMetric: StringMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class TextMetric: TextMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class TimespanMetric: TimespanMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class TimingDistributionMetric: TimingDistributionMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class UrlMetric: UrlMetricProtocol -
Undocumented
See moreDeclaration
Swift
open class UuidMetric: UuidMetricProtocol -
Declaration
Swift
public class Glean -
This implements the developer facing API for recording datetime metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The datetime API only exposes the
See moreDatetimeMetricType.set(_:)method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public class DatetimeMetricType -
Default of no extra keys for events (for the new API).
An empty class for convenient use as the default set of extra keys that an
See moreEventMetricTypecan accept.Declaration
Swift
public class NoExtras : EventExtras -
This implements the developer facing API for recording events.
Instances of this class type are automatically generated by the parsers at built time, allowing developers to record events that were previously registered in the metrics.yaml file.
The Events API only exposes the
See moreEventMetricType.record(extra:)method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public class EventMetricType<ExtraObject> where ExtraObject : EventExtras -
This implements the developer facing API for labeled metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
Unlike most metric types, LabeledMetricType does not have its own corresponding storage engine, but records metrics for the underlying metric type
See moreTin the storage engine for that type. The only difference is that labeled metrics are stored with the special key$category.$name/$label.Declaration
Swift
public class LabeledMetricType<T> -
This implements the developer facing API for the object metric type.
Instances of this class type are automatically generated by the parsers at built time, allowing developers to record events that were previously registered in the metrics.yaml file.
The Events API only exposes the
See moreObjectMetricType.set(obj:)method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public class ObjectMetricType<K> where K : ObjectSerialize -
This implements the developer facing API for custom pings.
Instances of this class type are automatically generated by the parsers at build time.
The Ping API only exposes the
See morePing.sumbit()method, which collects and schedules a ping for eventual upload.Declaration
Swift
public class Ping<ReasonCodesEnum> where ReasonCodesEnum : ReasonCodes -
This implements the developer facing API for recording URL metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The URL API only exposes the
See moreUrlMetricType.set(_:)method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public class UrlMetricType -
This implements the developer facing API for recording UUID metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The UUID API only exposes the
See moreUuidMetricType.generateAndSet()andUuidMetricType.set(_:)methods, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public class UuidMetricType -
This class represents a ping uploader via HTTP.
This will typically be invoked by the appropriate scheduling mechanism to upload a ping to the server.
See moreDeclaration
Swift
public class HttpPingUploader