BooleanMetricType

public class BooleanMetricType

This implements the developer facing API for recording boolean 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 boolean API only exposes the BooleanMetricType.set(_:) method, which takes care of validating the input data and making sure that limits are enforced.

  • The public constructor used by automatically generated metrics.

    Declaration

    Swift

    public init(category: String, name: String, sendInPings: [String], lifetime: Lifetime, disabled: Bool)
  • Set a boolean value.

    Declaration

    Swift

    public func set(_ value: Bool)

    Parameters

    value

    This is a user defined boolean value.

  • Tests whether a value is stored for the metric for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric’s storage engine before returning a value.

    Declaration

    Swift

    public func testHasValue(_ pingName: String? = nil) -> Bool

    Parameters

    pingName

    represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.

    Return Value

    true if metric value exists, otherwise false

  • Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric’s storage engine before returning a value.

    Throws a Missing value exception if no value is stored

    Declaration

    Swift

    public func testGetValue(_ pingName: String? = nil) throws -> Bool

    Parameters

    pingName

    represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.

    Return Value

    value of the stored metric