Packages

abstract class Gauge[A] extends ZIOMetric[A]

A Gauge is a metric representing a single numerical value that may be set or adjusted. A typical use of this metric would be to track the current memory usage. With a guage the quantity of interest is the current value, as opposed to a counter where the quantity of interest is the cumulative values over time.

Self Type
Gauge[A]
Linear Supertypes
ZIOMetric[A], ZIOAspect[Nothing, Any, Nothing, Any, Nothing, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Gauge
  2. ZIOMetric
  3. ZIOAspect
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Gauge(name: String, tags: Chunk[MetricLabel])

Abstract Value Members

  1. abstract def apply[R, E, A1 <: A](zio: ZIO[R, E, A1])(implicit trace: ZTraceElement): ZIO[R, E, A1]
    Definition Classes
    Gauge → ZIOAspect

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def >>>[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]
    Definition Classes
    ZIOAspect
  5. def @@[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]

    Returns a new aspect that represents the sequential composition of this aspect with the specified one.

    Returns a new aspect that represents the sequential composition of this aspect with the specified one.

    Definition Classes
    ZIOAspect
  6. def adjust(value: Double)(implicit trace: ZTraceElement): UIO[Any]

    Adjusts this gauge by the specified amount.

  7. def andThen[LowerR1 >: Nothing, UpperR1 <: Any, LowerE1 >: Nothing, UpperE1 <: Any, LowerA1 >: Nothing, UpperA1 <: A](that: ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]): ZIOAspect[LowerR1, UpperR1, LowerE1, UpperE1, LowerA1, UpperA1]
    Definition Classes
    ZIOAspect
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. final def copy(name: String = name, tags: Chunk[MetricLabel] = tags): Gauge[A]

    Returns a copy of this gauge with the specified name and tags.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def equals(that: Any): Boolean

    Returns whether this gauge is equal to the specified gauge.

    Returns whether this gauge is equal to the specified gauge.

    Definition Classes
    Gauge → AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def hashCode(): Int

    Returns the hash code of this gauge.

    Returns the hash code of this gauge.

    Definition Classes
    Gauge → AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. lazy val metricType: Class[_ <: Gauge[A]]

    The type of this gauge.

    The type of this gauge.

    Attributes
    protected
  18. final val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def set(value: Double)(implicit trace: ZTraceElement): UIO[Any]

    Sets this gauge to the specified value.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. final val tags: Chunk[MetricLabel]
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def value(implicit trace: ZTraceElement): UIO[Double]

    Returns the current value of this gauge.

  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ZIOMetric[A]

Inherited from ZIOAspect[Nothing, Any, Nothing, Any, Nothing, A]

Inherited from AnyRef

Inherited from Any

Ungrouped