com.adobe.aam.metrics.MetricClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metrics-core Show documentation

An application metrics client for Java integrated with Graphite/OpenTSDB

There is a newer version: 1.0.3

/*
 * Copyright 2018 Adobe Systems Incorporated. All rights reserved.
 * This file is licensed 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 REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 *
 */

package com.adobe.aam.metrics;

import com.adobe.aam.metrics.metric.Metric;
import com.adobe.aam.metrics.metric.Tags;

public interface MetricClient {

    /**
     * @return the tags used for grouping the sent metrics
     */
    Tags getTags();

    /**
     * Send a metric with a specified timestamp and reset its value afterwards.
     *
     * @param metric    Metric to be sent
     * @param timestamp timestamp to be used
     */
    void sendAndReset(Metric metric, long timestamp);


    /**
     * Send a metric with a specified timestamp.
     *
     * @param metric    Type of the metric
     * @param timestamp Timestamp (in seconds) to be used for the metric
     */
    void send(Metric metric, long timestamp);
}