/*
 * Copyright 2020 NAVER Corp.
 *
 * 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 com.navercorp.pinpoint.bootstrap.plugin.monitor.metric;

/**
 * This class is used when adding CustomMetric in plugin.
 * You can select and use the type of metric that suits you.
 * Currently, it is collected in every 5 seconds.
 *
 * <pre>
 * public StandardHostValveInvokeInterceptor(...., CustomMetricRegistry customMetricMonitorRegistry) {
 *         ...
 *         this.requestCount = new AtomicInteger();
 *         intCountMetric = new IntCounter() {
 *
 *             public String getName() {
 *                 return "tomcat/request/count";
 *             }
 *
 *             public int getValue() {
 *                 return requestCount.get();
 *             }
 *         };
 *         customMetricMonitorRegistry.register(intCountMetric);
 * }
 *
 * public void before(Object target, Object[] args) {
 * 		requestCount.incrementAndGet();
 *
 * }
 *
 * </pre>
 *
 * @author Taejin Koo
 */
public interface CustomMetric {

    String getName();

}
