org.apache.zookeeper.metrics.SummarySet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zookeeper Show documentation

ZooKeeper server

The newest version!

/*
 * 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.zookeeper.metrics;

/**
 * Summaries track the size and number of events.
 * They are able to publish minumum, maximum, average values, depending on the capabilities of the MetricsProvider.
 * A SummarySet is a set of {@link Summary}.
 */
public interface SummarySet {

    /**
     * Register a value.
     * This method is thread safe, The MetricsProvider will take care of synchronization.
     *
     * @param key the key to access the Summary for the given key
     * @param value current value
     */
    void add(String key, long value);

}