org.apache.inlong.common.metric.MetricItemMBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inlong-common

There is a newer version: 2.1.0

/*
 * 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.apache.inlong.common.metric;

import javax.management.MXBean;

import java.util.Map;

/**
 * MetricItemMBean

 * Provide access interface of a metric item with JMX.

 * Decouple between metric item and monitor system, in particular scene, 

 * inlong can depend on user-defined monitor system.
 */
@MXBean
public interface MetricItemMBean {

    String ATTRIBUTE_KEY = "DimensionsKey";
    String ATTRIBUTE_DIMENSIONS = "Dimensions";
    String METHOD_SNAPSHOT = "snapshot";
    char DOMAIN_SEPARATOR = ':';
    char PROPERTY_SEPARATOR = ',';
    char PROPERTY_EQUAL = '=';

    /**
     * getDimensionsKey
     *
     * @return key string composed of key/value pair of dimensions.
     */
    String getDimensionsKey();

    /**
     * getDimensions
     *
     * @return a key/value pair of all dimensions.
     */
    Map getDimensions();

    /**
     * snapshot
     *
     * @return get snapshot all metric of item, CountMetric will get metric value and set 0 to value, 

     *         GaugeMetric will only get metric value.
     */
    Map snapshot();
}