RedisMetrics

public struct RedisMetrics

The system funnel for all Metrics interactions from the Redis library.

It is highly recommended to not interact with this directly, and to let the library use it how it sees fit.

There is a nested enum type of RedisMetrics.Label that is available to query, match, etc. the labels used for all of the Metrics types created by the Redis library.

  • An enumeration of all the labels used by the Redis library for various Metrics data points.

    Each is backed by a raw string, and this type is CustomStringConvertible to receive a namespaced description in the form of "RediStack.<rawValue>".

    See more

    Declaration

    Swift

    public enum Label : String, CustomStringConvertible
    Show on GitLab

  • The wrapped Metrics.Gauge maintaining the current number of connections this library has active.

    Declaration

    Swift

    public static var activeConnectionCount: RedisMetrics.IncrementalGauge
    Show on GitLab

  • The wrapped Metrics.Gauge maintaining the current number of subscriptions to channels.

    Declaration

    Swift

    public static var activeChannelSubscriptions: RedisMetrics.IncrementalGauge
    Show on GitLab

  • The wrapped Metrics.Gauge maintaining the current number of subscriptions to channel patterns.

    Declaration

    Swift

    public static var activePatternSubscriptions: RedisMetrics.IncrementalGauge
    Show on GitLab

  • The Metrics.Counter that retains the number of connections made since application startup.

    Declaration

    Swift

    public static let totalConnectionCount: Counter
    Show on GitLab

  • The Metrics.Counter that retains the number of subscription messages that have been received.

    Declaration

    Swift

    public static let subscriptionMessagesReceivedCount: Counter
    Show on GitLab

  • The Metrics.Counter that retains the number of commands that successfully returned from Redis since application startup.

    Declaration

    Swift

    public static let commandSuccessCount: Counter
    Show on GitLab

  • The Metrics.Counter that retains the number of commands that failed from errors returned by Redis since application startup.

    Declaration

    Swift

    public static let commandFailureCount: Counter
    Show on GitLab

  • The Metrics.Timer that receives command response times in nanoseconds from when a command is first sent through the NIO.Channel, to when the response is first resolved.

    Declaration

    Swift

    public static let commandRoundTripTime: Timer
    Show on GitLab

  • A specialized wrapper class for working with Metrics.Gauge objects for the purpose of an incrementing or decrementing count of active objects.

    See more

    Declaration

    Swift

    public class IncrementalGauge
    Show on GitLab