org.jitsi.metrics.Metric.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jicoco-metrics Show documentation

Jitsi Common Components (Metrics)

There is a newer version: 1.1-146-g96ed31f

/*
 * Copyright @ 2022 - present 8x8, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jitsi.metrics

import io.prometheus.client.CollectorRegistry

/**
 * `Metric` provides methods common to all Prometheus metric type wrappers.
 *
 * A wrapper that extends `Metric` produces and consumes values of type `T`.
 * Metrics are held in a [MetricsContainer].
 */
sealed class Metric {

    /**
     * The name of this metric.
     */
    abstract val name: String

    /**
     * Supplies the current value of this metric.
     */
    abstract fun get(): T

    /**
     * Resets the value of this metric to its initial value.
     */
    internal abstract fun reset()

    /**
     * Registers this metric with the given [CollectorRegistry] and returns it.
     */
    internal abstract fun register(registry: CollectorRegistry): Metric
}