MetricAnalytics.java

/*
 * Copyright (c) 2015 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.heroic.analytics;

import com.spotify.heroic.async.AsyncObservable;
import com.spotify.heroic.common.Series;
import com.spotify.heroic.metric.MetricBackend;
import eu.toolchain.async.AsyncFuture;

import java.time.LocalDate;

public interface MetricAnalytics {
    /**
     * Wrap and instrument the given metric backend.
     *
     * @param backend Backend to wrap.
     * @return A wrapped metric backend that is being instrumented.
     */
    MetricBackend wrap(MetricBackend backend);

    /**
     * Stream all series hits that have been recorded.
     *
     * @return An observable of series hits.
     */
    default AsyncObservable<SeriesHit> seriesHits(LocalDate date) {
        return AsyncObservable.empty();
    }

    AsyncFuture<Void> configure();

    /**
     * Report that the given series has been fetched.
     *
     * @param series The series that has been fetched.
     * @return A future that will be resolved when the fetch has been persisted.
     */
    AsyncFuture<Void> reportFetchSeries(LocalDate date, Series series);
}