com.google.api.control.model.KnownMetrics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of endpoints-management-control Show documentation
Show all versions of endpoints-management-control Show documentation
Provide access control for managed services
/*
* Copyright 2016 Google Inc. 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 com.google.api.control.model;
import com.google.api.MetricDescriptor;
import com.google.api.MetricDescriptor.MetricKind;
import com.google.api.MetricDescriptor.ValueType;
import com.google.api.servicecontrol.v1.Distribution;
import com.google.api.servicecontrol.v1.MetricValue;
import com.google.api.servicecontrol.v1.MetricValueSet;
import com.google.api.servicecontrol.v1.Operation;
import com.google.api.servicecontrol.v1.Operation.Builder;
import com.google.common.base.Strings;
/**
* KnownMetric enumerates the well-known metrics and allows them to be added to the ReportRequest.
*/
public enum KnownMetrics {
CONSUMER_REQUEST_COUNT("serviceruntime.googleapis.com/api/consumer/request_count",
MetricKind.DELTA, ValueType.INT64, add1ToInt64Metric(), Mark.CONSUMER),
PRODUCER_REQUEST_COUNT("serviceruntime.googleapis.com/api/producer/request_count",
MetricKind.DELTA, ValueType.INT64, add1ToInt64Metric()),
PRODUCER_BY_CONSUMER_REQUEST_COUNT(
"serviceruntime.googleapis.com/api/producer/by_consumer/request_count", MetricKind.DELTA,
ValueType.INT64, add1ToInt64Metric(), Mark.PRODUCER_BY_CONSUMER),
CONSUMER_REQUEST_SIZES("serviceruntime.googleapis.com/api/consumer/request_sizes",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForRequestSize(),
Mark.CONSUMER),
PRODUCER_REQUEST_SIZES("serviceruntime.googleapis.com/api/producer/request_sizes",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForRequestSize()),
PRODUCER_BY_CONSUMER_REQUEST_SIZES(
"serviceruntime.googleapis.com/api/producer/by_consumer/request_sizes", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForRequestSize(), Mark.PRODUCER_BY_CONSUMER),
CONSUMER_RESPONSE_SIZES("serviceruntime.googleapis.com/api/consumer/response_sizes",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForResponseSize(),
Mark.CONSUMER),
PRODUCER_RESPONSE_SIZES("serviceruntime.googleapis.com/api/producer/response_sizes",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForResponseSize()),
PRODUCER_BY_CONSUMER_RESPONSE_SIZES(
"serviceruntime.googleapis.com/api/producer/by_consumer/response_sizes", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForResponseSize(), Mark.PRODUCER_BY_CONSUMER),
CONSUMER_REQUEST_ERROR_COUNT("serviceruntime.googleapis.com/api/consumer/error_count",
MetricKind.DELTA, ValueType.INT64, add1ToInt64MetricIfError(), Mark.CONSUMER),
PRODUCER_REQUEST_ERROR_COUNT("serviceruntime.googleapis.com/api/producer/error_count",
MetricKind.DELTA, ValueType.INT64, add1ToInt64MetricIfError()),
PRODUCER_BY_CONSUMER_ERROR_COUNT(
"serviceruntime.googleapis.com/api/producer/by_consumer/error_count", MetricKind.DELTA,
ValueType.INT64, add1ToInt64MetricIfError(), Mark.PRODUCER_BY_CONSUMER),
CONSUMER_TOTAL_LATENCIES("serviceruntime.googleapis.com/api/consumer/total_latencies",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForRequestTimeMillis(),
Mark.CONSUMER),
PRODUCER_TOTAL_LATENCIES("serviceruntime.googleapis.com/api/producer/total_latencies",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForRequestTimeMillis()),
PRODUCER_BY_CONSUMER_TOTAL_LATENCIES(
"serviceruntime.googleapis.com/api/producer/by_consumer/total_latencies", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForRequestTimeMillis(),
Mark.PRODUCER_BY_CONSUMER),
CONSUMER_BACKEND_LATENCIES("serviceruntime.googleapis.com/api/consumer/backend_latencies",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForBackendTimeMillis(),
Mark.CONSUMER),
PRODUCER_BACKEND_LATENCIES("serviceruntime.googleapis.com/api/producer/backend_latencies",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForBackendTimeMillis()),
PRODUCER_BY_CONSUMER_BACKEND_LATENCIES(
"serviceruntime.googleapis.com/api/producer/by_consumer/backend_latencies", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForBackendTimeMillis(),
Mark.PRODUCER_BY_CONSUMER),
CONSUMER_REQUEST_OVERHEAD_LATENCIES(
"serviceruntime.googleapis.com/api/consumer/request_overhead_latencies", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForOverheadTimeMillis(), Mark.CONSUMER),
PRODUCER_REQUEST_OVERHEAD_LATENCIES(
"serviceruntime.googleapis.com/api/producer/request_overhead_latencies", MetricKind.DELTA,
ValueType.DISTRIBUTION, addDistributionMetricForOverheadTimeMillis()),
PRODUCER_BY_CONSUMER_REQUEST_OVERHEAD_LATENCIES(
"serviceruntime.googleapis.com/api/producer/by_consumer/request_overhead_latencies",
MetricKind.DELTA, ValueType.DISTRIBUTION, addDistributionMetricForOverheadTimeMillis(),
Mark.PRODUCER_BY_CONSUMER);
private static final double TIME_SCALE = 1e-6;
private static final double SIZE_SCALE = 1;
private static final double DISTRIBUTION_GROWTH_FACTOR = 10.0;
private static final int DISTRIBUTION_BUCKETS = 8;
private static final double MILLIS_PER_SEC = 1000.0;
private String name;
private MetricKind kind;
private ValueType type;
private Update updater;
private Mark mark;
private KnownMetrics(String name, MetricKind kind, ValueType type, Update updater) {
this(name, kind, type, updater, Mark.PRODUCER);
}
private KnownMetrics(String name, MetricKind kind, ValueType type, Update updater, Mark mark) {
this.name = name;
this.type = type;
this.kind = kind;
if (mark == Mark.CONSUMER) {
this.updater = consumerMetric(updater);
} else if (mark == Mark.PRODUCER_BY_CONSUMER) {
this.updater = producerByConsumerMetric(updater);
} else {
this.updater = updater;
}
this.mark = mark;
}
/**
* @return the name of metrics that match this instance
*/
public String getName() {
return name;
}
/**
* @return the {@code MetricKind} of metrics that match this instance
*/
public MetricKind getKind() {
return kind;
}
/**
* @return the {@code ValueType} of metrics that match this instance
*/
public ValueType getType() {
return type;
}
public Update getUpdater() {
return updater;
}
/**
* Determines if {@code d} matches this {@code KnownMetric} instance.
*
* @param d a {@code LabelDescriptor}
* @return {@code true} if {@code d} matches
*/
public boolean matches(MetricDescriptor d) {
return name.equals(d.getName()) && d.getMetricKind() == kind && d.getValueType() == type;
}
/**
* Determines if the given {@code MetricDescriptor} is supported.
*
* @param d a {@code MetricDescriptor}
* @return {@code true} if the {@code MetricDescriptor} is supported, otherwise {@code false}
*/
public static boolean isSupported(MetricDescriptor d) {
for (KnownMetrics m : values()) {
if (m.matches(d)) {
return true;
}
}
return false;
}
/**
* Adds metrics to an operation from the provided request data
*
* @param info contains request data to be reported
* @param o the {@code Operation.Builder} to which metrics will be added
*/
public void performUpdate(ReportRequestInfo info, Operation.Builder o) {
if (updater != null) {
updater.update(name, info, o);
}
}
/**
* Update defines a function that allows a {@code ReportRequestInfo} to be used to update the the
* metrics of an operation to be added to a {@code ReportRequest}.
*/
private static interface Update {
/**
* Updates the metrics in {@code op} with the given {@code name} from {@code info}.
*
* @param name the name of a label to update
* @param info the {@code ReportRequestInfo} from which to update the labels
* @param op an {@code Operation} in a {@code ReportRequest}.
*/
void update(String name, ReportRequestInfo info, Operation.Builder op);
}
static Distribution newSizeDistribution() {
return Distributions.createExponential(DISTRIBUTION_BUCKETS, DISTRIBUTION_GROWTH_FACTOR,
SIZE_SCALE);
}
static Distribution newTimeDistribution() {
return Distributions.createExponential(DISTRIBUTION_BUCKETS, DISTRIBUTION_GROWTH_FACTOR,
TIME_SCALE);
}
private static Update add1ToInt64Metric() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
add1ToInt64MetricValue(name, op);
}
};
}
private static Update add1ToInt64MetricIfError() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getResponseCode() >= 400) {
add1ToInt64MetricValue(name, op);
}
}
};
}
/**
* This wraps an existing {@link Update} to only write if an API key is valid, indicating a
* registered consumer. This will prevent consumer metrics from appearing in the producer's
* consumer graph when a request is unregistered.
*/
private static Update consumerMetric(final Update delegate) {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.isApiKeyValid()) {
delegate.update(name, info, op);
}
}
};
}
/**
* This wraps an existing {@link Update} to only write if a consumer project number exists.
*/
private static Update producerByConsumerMetric(final Update delegate) {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Builder op) {
if (info.getConsumerProjectNumber() > 0) {
delegate.update(name, info, op);
}
}
};
}
private static void addInt64MetricValue(String name, long value, Operation.Builder op) {
op.addMetricValueSets(MetricValueSet.newBuilder().setMetricName(name).addMetricValues(
MetricValue.newBuilder().setInt64Value(value).build()));
}
private static void add1ToInt64MetricValue(String name, Operation.Builder op) {
addInt64MetricValue(name, 1L, op);
}
private static Update addDistributionMetricForResponseSize() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getResponseSize() > 0) {
addSizeDistributionMetricValue(name, info.getResponseSize(), op);
}
}
};
}
private static Update addDistributionMetricForRequestSize() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getRequestSize() > 0) {
addSizeDistributionMetricValue(name, info.getRequestSize(), op);
}
}
};
}
private static Update addDistributionMetricForRequestTimeMillis() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getRequestTimeMillis() > 0) {
addTimeDistributionMetricValue(name, info.getRequestTimeMillis(), op);
}
}
};
}
private static Update addDistributionMetricForBackendTimeMillis() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getBackendTimeMillis() > 0) {
addTimeDistributionMetricValue(name, info.getBackendTimeMillis(), op);
}
}
};
}
private static Update addDistributionMetricForOverheadTimeMillis() {
return new Update() {
@Override
public void update(String name, ReportRequestInfo info, Operation.Builder op) {
if (info.getOverheadTimeMillis() > 0) {
addTimeDistributionMetricValue(name, info.getOverheadTimeMillis(), op);
}
}
};
}
private static void addTimeDistributionMetricValue(String name, long value,
Operation.Builder op) {
Distribution d = Distributions.addSample(value / MILLIS_PER_SEC, newTimeDistribution());
op.addMetricValueSets(MetricValueSet.newBuilder().setMetricName(name).addMetricValues(
MetricValue.newBuilder().setDistributionValue(d).build()));
}
private static void addSizeDistributionMetricValue(String name, long value,
Operation.Builder op) {
Distribution d = Distributions.addSample(value, newSizeDistribution());
op.addMetricValueSets(MetricValueSet.newBuilder().setMetricName(name).addMetricValues(
MetricValue.newBuilder().setDistributionValue(d).build()));
}
private enum Mark {
PRODUCER, CONSUMER, PRODUCER_BY_CONSUMER;
}
}