org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus.PrometheusProperties Maven / Gradle / Ivy
/*
* Copyright 2012-2024 the original author or authors.
*
* 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 org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus;
import java.time.Duration;
import java.util.HashMap;
import java.util.Map;
import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
/**
* {@link ConfigurationProperties @ConfigurationProperties} for configuring metrics export
* to Prometheus.
*
* @author Jon Schneider
* @author Stephane Nicoll
* @since 2.0.0
*/
@ConfigurationProperties(prefix = "management.prometheus.metrics.export")
public class PrometheusProperties {
/**
* Whether exporting of metrics to this backend is enabled.
*/
private boolean enabled = true;
/**
* Whether to enable publishing descriptions as part of the scrape payload to
* Prometheus. Turn this off to minimize the amount of data sent on each scrape.
*/
private boolean descriptions = true;
/**
* Configuration options for using Prometheus Pushgateway, allowing metrics to be
* pushed when they cannot be scraped.
*/
private final Pushgateway pushgateway = new Pushgateway();
/**
* Histogram type for backing DistributionSummary and Timer.
* @deprecated since 3.3.0 for removal in 3.5.0
*/
@Deprecated(since = "3.3.0", forRemoval = true)
private HistogramFlavor histogramFlavor = HistogramFlavor.Prometheus;
/**
* Additional properties to pass to the Prometheus client.
*/
private final Map properties = new HashMap<>();
/**
* Step size (i.e. reporting frequency) to use.
*/
private Duration step = Duration.ofMinutes(1);
public boolean isDescriptions() {
return this.descriptions;
}
public void setDescriptions(boolean descriptions) {
this.descriptions = descriptions;
}
@Deprecated(since = "3.3.0", forRemoval = true)
@DeprecatedConfigurationProperty(since = "3.3.0",
reason = "No longer supported. Works only when using the Prometheus simpleclient.")
public HistogramFlavor getHistogramFlavor() {
return this.histogramFlavor;
}
public void setHistogramFlavor(HistogramFlavor histogramFlavor) {
this.histogramFlavor = histogramFlavor;
}
public Duration getStep() {
return this.step;
}
public void setStep(Duration step) {
this.step = step;
}
public boolean isEnabled() {
return this.enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public Pushgateway getPushgateway() {
return this.pushgateway;
}
public Map getProperties() {
return this.properties;
}
/**
* Configuration options for push-based interaction with Prometheus.
*/
public static class Pushgateway {
/**
* Enable publishing over a Prometheus Pushgateway.
*/
private Boolean enabled = false;
/**
* Base URL for the Pushgateway.
*/
private String baseUrl = "http://localhost:9091";
/**
* Login user of the Prometheus Pushgateway.
*/
private String username;
/**
* Login password of the Prometheus Pushgateway.
*/
private String password;
/**
* Frequency with which to push metrics.
*/
private Duration pushRate = Duration.ofMinutes(1);
/**
* Job identifier for this application instance.
*/
private String job;
/**
* Grouping key for the pushed metrics.
*/
private Map groupingKey = new HashMap<>();
/**
* Operation that should be performed on shutdown.
*/
private ShutdownOperation shutdownOperation = ShutdownOperation.NONE;
public Boolean getEnabled() {
return this.enabled;
}
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public String getBaseUrl() {
return this.baseUrl;
}
public void setBaseUrl(String baseUrl) {
this.baseUrl = baseUrl;
}
public String getUsername() {
return this.username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return this.password;
}
public void setPassword(String password) {
this.password = password;
}
public Duration getPushRate() {
return this.pushRate;
}
public void setPushRate(Duration pushRate) {
this.pushRate = pushRate;
}
public String getJob() {
return this.job;
}
public void setJob(String job) {
this.job = job;
}
public Map getGroupingKey() {
return this.groupingKey;
}
public void setGroupingKey(Map groupingKey) {
this.groupingKey = groupingKey;
}
public ShutdownOperation getShutdownOperation() {
return this.shutdownOperation;
}
public void setShutdownOperation(ShutdownOperation shutdownOperation) {
this.shutdownOperation = shutdownOperation;
}
}
/**
* Prometheus Histogram flavor.
*
* @deprecated since 3.3.0 for removal in 3.5.0
*/
@Deprecated(since = "3.3.0", forRemoval = true)
public enum HistogramFlavor {
Prometheus, VictoriaMetrics
}
}