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]
- Alphabetic
- By Inheritance
- Gauge
- ZIOMetric
- ZIOAspect
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Gauge(name: String, tags: Chunk[MetricLabel], aspect: (Gauge[A]) => MetricAspect[A])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- 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
- def adjust(value: Double)(implicit trace: ZTraceElement): UIO[Any]
Adjusts this gauge by the specified amount.
- 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
- def apply[R, E, A1 <: A](zio: ZIO[R, E, A1])(implicit trace: ZTraceElement): ZIO[R, E, A1]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def copy(name: String = name, tags: Chunk[MetricLabel] = tags): Gauge[A]
Returns a copy of this gauge with the specified name and tags.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
Returns the hash code of this gauge.
Returns the hash code of this gauge.
- Definition Classes
- Gauge → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val metricType: Class[_ <: (Gauge[A]) => MetricAspect[A]]
The type of this gauge.
The type of this gauge.
- Attributes
- protected
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def set(value: Double)(implicit trace: ZTraceElement): UIO[Any]
Sets this gauge to the specified value.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def taggedWith(f: (A) => Chunk[MetricLabel]): ZIOMetric[A]
Converts this gauge metric to one where the tags depend on the measured effect's result value
- val tags: Chunk[MetricLabel]
- def toString(): String
- Definition Classes
- AnyRef → Any
- def value(implicit trace: ZTraceElement): UIO[Double]
Returns the current value of this gauge.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()