org.dinky.shaded.paimon.metrics.MetricGroup Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.dinky.shaded.paimon.metrics;
import org.dinky.shaded.paimon.annotation.Public;
import java.util.Map;
/**
* A MetricGroup is a named container for {@link Metric Metrics} and further metric subgroups.
*
* Instances of this class can be used to register new metrics with Paimon.
*/
@Public
public interface MetricGroup {
/**
* Creates and registers a new {@link org.dinky.shaded.paimon.metrics.Counter} with Paimon.
*
* @param name name of the counter
* @return the created counter
*/
Counter counter(String name);
/**
* Registers a new {@link org.dinky.shaded.paimon.metrics.Gauge} with Paimon.
*
* @param name name of the gauge
* @param gauge gauge to register
* @param return type of the gauge
* @return the given gauge
*/
Gauge gauge(String name, Gauge gauge);
/**
* Registers a new {@link Histogram} with Paimon.
*
* @param name name of the histogram
* @param windowSize number of records this histogram keeps
* @return the registered histogram
*/
Histogram histogram(String name, int windowSize);
/** Returns a map of all variables and their associated value. */
Map getAllVariables();
/**
* Returns the name for this group, meaning what kind of entity it represents, for example
* "commit".
*/
String getGroupName();
/** Returns all the metrics the group carries. */
Map getMetrics();
/** Close the metric group and release related resources. */
void close();
}