Packages

  • package root
    Definition Classes
    root
  • package zio
    Definition Classes
    root
  • package internal
    Definition Classes
    zio
  • package metrics
    Definition Classes
    zio
  • package jvm
  • MetricClient
  • MetricKey
  • MetricListener
  • MetricState
  • MetricType
  • package stm
    Definition Classes
    zio
  • package stream
    Definition Classes
    zio
  • package test

    _ZIO Test_ is a featherweight testing library for effectful programs.

    _ZIO Test_ is a featherweight testing library for effectful programs.

    The library imagines every spec as an ordinary immutable value, providing tremendous potential for composition. Thanks to tight integration with ZIO, specs can use resources (including those requiring disposal), have well- defined linear and parallel semantics, and can benefit from a host of ZIO combinators.

    import zio.test._
    import zio.test.environment.Live
    import zio.Clock.nanoTime
    import Assertion.isGreaterThan
    
    object MyTest extends DefaultRunnableSpec {
      def spec = suite("clock")(
        test("time is non-zero") {
          for {
            time <- Live.live(nanoTime)
          } yield assertTrue(time >= 0)
        }
      )
    }
    Definition Classes
    zio
p

zio

metrics

package metrics

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package jvm

Type Members

  1. sealed trait MetricKey extends AnyRef

    A MetricKey is a unique key associated with each metric.

    A MetricKey is a unique key associated with each metric. The key is based on a combination of the metric type, the name and labels associated with the metric, and any other information to describe a a metric, such as the boundaries of a histogram. In this way, it is impossible to ever create metrics with conflicting keys.

  2. trait MetricListener extends AnyRef

    A MetricListener is capable of taking some action in response to a metric being recorded, such as sending that metric to a third party service.

  3. final case class MetricState(name: String, help: String, labels: Chunk[MetricLabel], details: MetricType) extends Product with Serializable

    MetricState represents a snapshot of the current state of a metric as of a poiint in time.

  4. sealed trait MetricType extends AnyRef

    MetricType represents information about the state of a metric that is particular to a certain type of metric, such as a histogram as opposed to a counter.

Value Members

  1. object MetricClient

    A MetricClient provides the functionality to consume metrics produced by ZIO applications.

    A MetricClient provides the functionality to consume metrics produced by ZIO applications. MetricClient supports two ways of consuming metrics, corresponding to the two ways that third party metrics services use metrics.

    First, metrics services can poll for the current state of all recorded metrics using the unsafeSnapshot method, which provides a snapshot, as of a point in time, of all metrics recorded by the ZIO application.

    Second, metrics services can install a listener that will be notified every time a metric is updated.

    MetricClient is a lower level interface and is intended to be used by implementers of integrations with third party metrics services but not by end users.

  2. object MetricKey
  3. object MetricState extends Serializable
  4. object MetricType

Ungrouped