org.jitsi.metrics.InfoMetric.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)

The newest version!

/*
 * 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
import io.prometheus.client.Info

/**
 * `InfoMetric` wraps around a single key-value information pair.
 * Useful for general information such as build versions, JVB region, etc.
 * In the Prometheus exposition format, these are shown as labels of either a custom metric (OpenMetrics)
 * or a [Gauge][io.prometheus.client.Gauge] (0.0.4 plain text).
 */
class InfoMetric(
    /** the name of this metric */
    override val name: String,
    /** the description of this metric */
    help: String,
    /** the namespace (prefix) of this metric */
    namespace: String,
    /** the value of this info metric */
    internal val value: String
) : Metric() {
    private val info = Info.build(name, help).namespace(namespace).create().apply { info(name, value) }

    override fun get() = value

    override fun reset() = info.info(name, value)

    override fun register(registry: CollectorRegistry) = this.also { registry.register(info) }
}