MemoryDistributionMetricType

public class MemoryDistributionMetricType

This implements the developer facing API for recording memory distribution 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 memory distribution API only exposes the MemoryDistributionMetricType.accumulate() method.

  • The public constructor used by automatically generated metrics.

    Declaration

    Swift

    public init(category: String,
                name: String,
                sendInPings: [String],
                lifetime: Lifetime,
                disabled: Bool,
                memoryUnit: MemoryUnit)
  • Record a single value, in the unit specified by memoryUnit, to the distribution.

    Declaration

    Swift

    public func accumulate(_ sample: UInt64)

    Parameters

    sample

    the 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

    -parameters:

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

    Declaration

    Swift

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

    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.