com.spotify.metrics.core.RemoteSemanticMetricRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of semantic-metrics-api Show documentation
Semantic Metrics: API Package
There is a newer version: 1.2.0
/*
 * Copyright (c) 2016 Spotify AB.
 *
 * 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 com.spotify.metrics.core;

import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * Interface for arbitrary implementation of a MetricRegistry that
 * does not need to be running locally in the current process. This
 * API leaks less implementation details about how the metrics are
 * implemented under the hood.
 * 
 * Currently, the SemanticAggregatorMetricRegistry is the only implementation.
 */
public interface RemoteSemanticMetricRegistry {
    /**
     * Creates a new {@link RemoteCounter} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @return a new {@link RemoteCounter}
     */
    RemoteCounter counter(final MetricId name);

    /**
     * Creates a new {@link RemoteCounter} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @param shardKey the list of tags to be used for sharding
     * @return a new {@link RemoteCounter}
     */
    RemoteCounter counter(final MetricId name, final List shardKey);

    /**
     * Creates a new {@link RemoteTimer} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @return a new {@link RemoteTimer}
     */
    RemoteTimer timer(final MetricId name);

    /**
     * Creates a new {@link RemoteTimer} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @param shardKey the list of tags to be used for sharding
     * @return a new {@link RemoteTimer}
     */
    RemoteTimer timer(final MetricId name, final List shardKey);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     *
     * @param name the name of the metric
     * @param shardKey the list of tags to be used for sharding
     * @return a new {@link RemoteMeter}
     */
    RemoteDerivingMeter derivingMeter(final MetricId name, final List shardKey);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @return a new {@link RemoteMeter}
     */
    RemoteDerivingMeter derivingMeter(final MetricId name);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     *
     * @param name the name of the metric
     * @param shardKey the list of tags to be used for sharding
     * @return a new {@link RemoteMeter}
     */
    RemoteHistogram histogram(final MetricId name, final List shardKey);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @return a new {@link RemoteMeter}
     */
    RemoteHistogram histogram(final MetricId name);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     *
     * @param name the name of the metric
     * @param shardKey the list of tags to be used for sharding
     * @return a new {@link RemoteMeter}
     */
    RemoteMeter meter(final MetricId name, final List shardKey);

    /**
     * Creates a new {@link RemoteMeter} and registers it under the given name.
     * Sharding uses the "what"-tag of the metric Id.
     *
     * @param name the name of the metric
     * @return a new {@link RemoteMeter}
     */
    RemoteMeter meter(final MetricId name);

    /**
     * Stop accepting new metrics to be sent and wait for all asynchronous calls
     * to be done or the timeout to occur.
     *
     * @param timeout For how long to wait for asynchronous requests
     * @param timeUnit The unit of the timeout
     * @return False if the timeout occurred before all requests were completed
     * @throws InterruptedException if the wait was interrupted
     */
    boolean shutdown(long timeout, TimeUnit timeUnit) throws InterruptedException;
}