Class

zio.ZIOMetric

Gauge

Related Doc: package ZIOMetric

Permalink

final 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
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], aspect: (Gauge[A]) ⇒ MetricAspect[A])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    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]

    Permalink
    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]

    Permalink

    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]

    Permalink

    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]

    Permalink
    Definition Classes
    ZIOAspect
  8. def apply[R, E, A1 <: A](zio: ZIO[R, E, A1])(implicit trace: ZTraceElement): ZIO[R, E, A1]

    Permalink
    Definition Classes
    GaugeZIOAspect
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(name: String = name, tags: Chunk[MetricLabel] = tags): Gauge[A]

    Permalink

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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(that: Any): Boolean

    Permalink

    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
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink

    Returns the hash code of this gauge.

    Returns the hash code of this gauge.

    Definition Classes
    Gauge → AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. lazy val metricType: Class[_ <: (Gauge[A]) ⇒ MetricAspect[A]]

    Permalink

    The type of this gauge.

    The type of this gauge.

    Attributes
    protected
  19. val name: String

    Permalink
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def set(value: Double)(implicit trace: ZTraceElement): UIO[Any]

    Permalink

    Sets this gauge to the specified value.

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def taggedWith(f: (A) ⇒ Chunk[MetricLabel]): ZIOMetric[A]

    Permalink

    Converts this gauge metric to one where the tags depend on the measured effect's result value

  26. val tags: Chunk[MetricLabel]

    Permalink
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. def value(implicit trace: ZTraceElement): UIO[Double]

    Permalink

    Returns the current value of this gauge.

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ZIOMetric[A]

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

Inherited from AnyRef

Inherited from Any

Ungrouped