io.micrometer.spring.autoconfigure.MetricsProperties Maven / Gradle / Ivy
/**
* Copyright 2017 VMware, Inc.
*
* 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
*
* https://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 io.micrometer.spring.autoconfigure;
import org.springframework.boot.context.properties.ConfigurationProperties;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* {@link ConfigurationProperties} for configuring Micrometer-based metrics.
*
* @author Jon Schneider
* @author Alexander Abramov
*/
@ConfigurationProperties("management.metrics")
public class MetricsProperties {
private final Web web = new Web();
private final Distribution distribution = new Distribution();
/**
* If {@code false}, the matching meter(s) are no-op.
*/
private final Map enable = new HashMap<>();
/**
* Common tags that are applied to every meter.
*/
private final Map tags = new LinkedHashMap<>();
/**
* Whether or not auto-configured MeterRegistry implementations should be bound to the
* global static registry on Metrics. For testing, set this to 'false' to maximize
* test independence.
*/
private boolean useGlobalRegistry = true;
public boolean isUseGlobalRegistry() {
return this.useGlobalRegistry;
}
public void setUseGlobalRegistry(boolean useGlobalRegistry) {
this.useGlobalRegistry = useGlobalRegistry;
}
public Web getWeb() {
return this.web;
}
public Map getEnable() {
return enable;
}
public Map getTags() {
return this.tags;
}
public Distribution getDistribution() {
return distribution;
}
public static class Web {
private final Client client = new Client();
private final Server server = new Server();
public Client getClient() {
return this.client;
}
public Server getServer() {
return this.server;
}
public static class Client {
/**
* Name of the metric for sent requests.
*/
private String requestsMetricName = "http.client.requests";
/**
* Maximum number of unique URI tag values allowed. After the max number of tag values is reached,
* metrics with additional tag values are denied by filter.
*/
private int maxUriTags = 100;
public String getRequestsMetricName() {
return this.requestsMetricName;
}
public void setRequestsMetricName(String requestsMetricName) {
this.requestsMetricName = requestsMetricName;
}
public int getMaxUriTags() {
return maxUriTags;
}
public void setMaxUriTags(int maxUriTags) {
this.maxUriTags = maxUriTags;
}
}
public static class Server {
/**
* Whether or not requests handled by Spring MVC or WebFlux should be
* automatically timed. If the number of time series emitted grows too large
* on account of request mapping timings, disable this and use 'Timed' on a
* per request mapping basis as needed.
*/
private boolean autoTimeRequests = true;
/**
* Name of the metric for received requests.
*/
private String requestsMetricName = "http.server.requests";
/**
* Maximum number of unique URI tag values allowed. After the max number of
* tag values is reached, metrics with additional tag values are denied by
* filter.
*/
private int maxUriTags = 100;
public boolean isAutoTimeRequests() {
return this.autoTimeRequests;
}
public void setAutoTimeRequests(boolean autoTimeRequests) {
this.autoTimeRequests = autoTimeRequests;
}
public String getRequestsMetricName() {
return this.requestsMetricName;
}
public void setRequestsMetricName(String requestsMetricName) {
this.requestsMetricName = requestsMetricName;
}
public int getMaxUriTags() {
return this.maxUriTags;
}
public void setMaxUriTags(int maxUriTags) {
this.maxUriTags = maxUriTags;
}
}
}
public static class Distribution {
/**
* Whether meter IDs starting with the specified name should publish percentile
* histograms. For monitoring systems that support aggregable percentile
* calculation based on a histogram, this can be set to true. For other systems,
* this has no effect. The longest match wins, the key `all` can also be used to
* configure all meters.
*/
private final Map percentilesHistogram = new LinkedHashMap<>();
/**
* Specific computed non-aggregable percentiles to ship to the backend for meter
* IDs starting-with the specified name. The longest match wins, the key `all` can
* also be used to configure all meters.
*/
private final Map percentiles = new LinkedHashMap<>();
/**
* Specific SLA boundaries for meter IDs starting-with the specified name. The
* longest match wins. Counters will be published for each specified boundary.
* Values can be specified as a long or as a Duration value (for timer meters,
* defaulting to ms if no unit specified).
*/
private final Map sla = new LinkedHashMap<>();
/**
* Minimum value that meter IDs starting-with the specified name are expected to
* observe. The longest match wins. Values can be specified as a long or as a
* Duration value (for timer meters, defaulting to ms if no unit specified).
*/
private final Map minimumExpectedValue = new LinkedHashMap<>();
/**
* Maximum value that meter IDs starting-with the specified name are expected to
* observe. The longest match wins. Values can be specified as a long or as a
* Duration value (for timer meters, defaulting to ms if no unit specified).
*/
private final Map maximumExpectedValue = new LinkedHashMap<>();
public Map getPercentilesHistogram() {
return this.percentilesHistogram;
}
public Map getPercentiles() {
return this.percentiles;
}
public Map getSla() {
return this.sla;
}
public Map getMinimumExpectedValue() {
return this.minimumExpectedValue;
}
public Map getMaximumExpectedValue() {
return this.maximumExpectedValue;
}
}
}