StringListMetricType

public class StringListMetricType

This implements the developer facing API for recording string list 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 string list API only exposes the StringListMetricType.add(_:) and StringListMetricType.set(_:) methods, 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)
  • Appends a string value to one or more string list metric stores. If the string exceeds the maximum string length or if the list exceeds the maximum length it will be truncated.

    Declaration

    Swift

    public func add(_ value: String)

    Parameters

    value

    This is a user defined string value. The maximum length of this string is MAX_STRING_LENGTH.

  • Sets a string list to one or more metric stores. If any string exceeds the maximum string length or if the list exceeds the maximum length it will be truncated.

    Declaration

    Swift

    public func set(_ value: [String])

    Parameters

    value

    This is a user defined string list.

  • 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 -> [String]

    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

  • Returns the number of errors recorded for the given metric.

    Declaration

    Swift

    public func testGetNumRecordedErrors(_ errorType: ErrorType, pingName: String? = nil) -> Int32

    Parameters

    errorType

    The type of error recorded.

    pingName

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

    Return Value

    The number of errors recorded for the metric for the given error type.