com.arpnetworking.metrics.Event Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2015 Groupon.com
 *
 * 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.arpnetworking.metrics;

import java.util.List;
import java.util.Map;

/**
 * Interface representing one unit of work's metrics data.
 *
 * @author Ville Koskela (vkoskela at groupon dot com)
 */
public interface Event {

    /**
     * Accessor for UOW annotations.
     *
     * @return Annotations for UOW.
     */
    Map getAnnotations();

    /**
     * Accessor for UOW timer samples.
     *
     * @return Timer samples by timer name for UOW.
     */
    Map> getTimerSamples();

    /**
     * Accessor for UOW counter samples.
     *
     * @return Counter samples by counter name for UOW.
     */
    Map> getCounterSamples();

    /**
     * Accessor for UOW gauge samples.
     *
     * @return Gauge samples by gauge name for UOW.
     */
    Map> getGaugeSamples();
}