io.tehuti.metrics.CompoundStat Maven / Gradle / Ivy

Go to download

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

Tehuti is a simple metrics library providing statistical measurement, reporting and quota functionalities.

There is a newer version: 0.7.3

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

import java.util.List;

/**
 * A compound stat is a stat where a single measurement and associated data structure feeds many metrics. This is the
 * example for a histogram which has many associated percentiles.
 */
public interface CompoundStat extends Stat {

    public List stats();

    public static class NamedMeasurable {

        private final String name;
        private final String description;
        private final Measurable stat;

        public NamedMeasurable(String name, String description, Measurable stat) {
            super();
            this.name = name;
            this.description = description;
            this.stat = stat;
        }

        public String name() {
            return name;
        }

        public String description() {
            return description;
        }

        public Measurable stat() {
            return stat;
        }

    }

}