google-nomulus/java/google/registry/monitoring/metrics/Metric.java
shikhman 91f8b6da38 Change to metrics to keep track of when the metric value was first set
This CL also adds IncrementableMetric#reset() methods to allow resetting the
value and start timestamp of IncrementableMetrics.

This is necessary because some backends, like Stackdriver, use non-monotonic
changes in cumulative metric values to detect timeseries restarts. Tracking and
re-setting the start timestamp allows users to track mostly monotonic metrics
which may have non-monotonic discontinuities.

See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/TimeSeries#Point for
more details.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=130795229
2016-08-22 14:44:28 -04:00

43 lines
1.4 KiB
Java

// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
//
// 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 google.registry.monitoring.metrics;
import com.google.common.collect.ImmutableList;
/**
* A Metric which stores timestamped values.
*
* <p>This is a read-only view.
*/
public interface Metric<V> {
/**
* Returns the latest {@link MetricPoint} instances for every label-value combination tracked for
* this metric.
*/
ImmutableList<MetricPoint<V>> getTimestampedValues();
/** Returns the count of values being stored with this metric. */
int getCardinality();
/** Returns the schema of this metric. */
MetricSchema getMetricSchema();
/**
* Returns the type for the value of this metric, which would otherwise be erased at compile-time.
* This is useful for implementors of {@link MetricWriter}.
*/
Class<V> getValueClass();
}