001/*
002 * (C) Copyright 2020 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bdelbosc
018 */
019package org.nuxeo.runtime.metrics;
020
021import java.util.Map;
022import java.util.Set;
023
024import io.dropwizard.metrics5.MetricAttribute;
025import io.dropwizard.metrics5.MetricFilter;
026import io.dropwizard.metrics5.MetricRegistry;
027
028/**
029 * @since 11.1
030 */
031public interface MetricsReporter {
032
033    /**
034     * Called on new instance.
035     */
036    void init(long pollInterval, Map<String, String> options);
037
038    /**
039     * Starts metrics reporter.
040     */
041    void start(MetricRegistry registry, MetricFilter filter, Set<MetricAttribute> deniedExpansions);
042
043    /**
044     * Stops metrics reporter.
045     */
046    void stop();
047
048}