-
Notifications
You must be signed in to change notification settings - Fork 41.2k
Add support for Prometheus Client 1.x and simpleclient #40023
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
448b6ea
Auto-config support for latest Prometheus client and simpleclient
shakuzen dacb98a
Switch to snapshots and support exemplars
shakuzen 48a3482
Add missing new autoconfig import entry
shakuzen eae66a6
Fix checkstyle and remove Pushgateway tests
shakuzen 70089c1
Add test for protobuf scrape
shakuzen 63a3d2a
Upgrade client to 1.2.1, prometheusProperties, merge config props
shakuzen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
163 changes: 163 additions & 0 deletions
163
...igure/metrics/export/prometheus/PrometheusSimpleclientMetricsExportAutoConfiguration.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /* | ||
| * 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.net.MalformedURLException; | ||
| import java.net.URL; | ||
| import java.time.Duration; | ||
| import java.util.Map; | ||
|
|
||
| import io.micrometer.core.instrument.Clock; | ||
| import io.micrometer.prometheus.PrometheusConfig; | ||
| import io.micrometer.prometheus.PrometheusMeterRegistry; | ||
| import io.prometheus.client.CollectorRegistry; | ||
| import io.prometheus.client.exemplars.DefaultExemplarSampler; | ||
| import io.prometheus.client.exemplars.ExemplarSampler; | ||
| import io.prometheus.client.exemplars.tracer.common.SpanContextSupplier; | ||
| import io.prometheus.client.exporter.BasicAuthHttpConnectionFactory; | ||
| import io.prometheus.client.exporter.PushGateway; | ||
|
|
||
| import org.springframework.beans.factory.ObjectProvider; | ||
| import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint; | ||
| import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport; | ||
| import org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration; | ||
| import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager; | ||
| import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation; | ||
| import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusScrapeEndpoint; | ||
| import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusSimpleclientScrapeEndpoint; | ||
| import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.EnableAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; | ||
| import org.springframework.boot.context.properties.EnableConfigurationProperties; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.core.env.Environment; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| /** | ||
| * {@link EnableAutoConfiguration Auto-configuration} for exporting metrics to Prometheus | ||
| * with the Prometheus simpleclient. | ||
| * | ||
| * @author Jon Schneider | ||
| * @author David J. M. Karlsen | ||
| * @author Jonatan Ivanov | ||
| * @since 2.0.0 | ||
| * @deprecated in favor of {@link PrometheusMetricsExportAutoConfiguration} | ||
| */ | ||
| @Deprecated(since = "3.3.0", forRemoval = true) | ||
| @AutoConfiguration( | ||
| before = { CompositeMeterRegistryAutoConfiguration.class, SimpleMetricsExportAutoConfiguration.class }, | ||
| after = { MetricsAutoConfiguration.class, PrometheusMetricsExportAutoConfiguration.class }) | ||
| @ConditionalOnBean(Clock.class) | ||
| @ConditionalOnClass(PrometheusMeterRegistry.class) | ||
| @ConditionalOnEnabledMetricsExport("prometheus") | ||
| @EnableConfigurationProperties(PrometheusProperties.class) | ||
| public class PrometheusSimpleclientMetricsExportAutoConfiguration { | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| public PrometheusConfig simpleclientPrometheusConfig(PrometheusProperties prometheusProperties) { | ||
| return new PrometheusSimpleclientPropertiesConfigAdapter(prometheusProperties); | ||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| public io.micrometer.prometheus.PrometheusMeterRegistry simpleclientPrometheusMeterRegistry( | ||
| io.micrometer.prometheus.PrometheusConfig prometheusConfig, CollectorRegistry collectorRegistry, | ||
| Clock clock, ObjectProvider<ExemplarSampler> exemplarSamplerProvider) { | ||
| return new io.micrometer.prometheus.PrometheusMeterRegistry(prometheusConfig, collectorRegistry, clock, | ||
| exemplarSamplerProvider.getIfAvailable()); | ||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| public CollectorRegistry collectorRegistry() { | ||
| return new CollectorRegistry(true); | ||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean(ExemplarSampler.class) | ||
| @ConditionalOnBean(SpanContextSupplier.class) | ||
| public DefaultExemplarSampler exemplarSampler(SpanContextSupplier spanContextSupplier) { | ||
| return new DefaultExemplarSampler(spanContextSupplier); | ||
| } | ||
|
|
||
| @SuppressWarnings("removal") | ||
| @Configuration(proxyBeanMethods = false) | ||
| @ConditionalOnAvailableEndpoint(endpoint = PrometheusSimpleclientScrapeEndpoint.class) | ||
| public static class PrometheusScrapeEndpointConfiguration { | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean({ PrometheusSimpleclientScrapeEndpoint.class, PrometheusScrapeEndpoint.class }) | ||
| public PrometheusSimpleclientScrapeEndpoint prometheusEndpoint(CollectorRegistry collectorRegistry) { | ||
| return new PrometheusSimpleclientScrapeEndpoint(collectorRegistry); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Configuration for <a href="https://github.com/prometheus/pushgateway">Prometheus | ||
| * Pushgateway</a>. | ||
| */ | ||
| @Configuration(proxyBeanMethods = false) | ||
| @ConditionalOnClass(PushGateway.class) | ||
| @ConditionalOnProperty(prefix = "management.prometheus.metrics.export.pushgateway", name = "enabled") | ||
| public static class PrometheusPushGatewayConfiguration { | ||
|
|
||
| /** | ||
| * The fallback job name. We use 'spring' since there's a history of Prometheus | ||
| * spring integration defaulting to that name from when Prometheus integration | ||
| * didn't exist in Spring itself. | ||
| */ | ||
| private static final String FALLBACK_JOB = "spring"; | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| public PrometheusPushGatewayManager prometheusPushGatewayManager(CollectorRegistry collectorRegistry, | ||
| PrometheusProperties prometheusProperties, Environment environment) throws MalformedURLException { | ||
| PrometheusProperties.Pushgateway properties = prometheusProperties.getPushgateway(); | ||
| Duration pushRate = properties.getPushRate(); | ||
| String job = getJob(properties, environment); | ||
| Map<String, String> groupingKey = properties.getGroupingKey(); | ||
| ShutdownOperation shutdownOperation = properties.getShutdownOperation(); | ||
| PushGateway pushGateway = initializePushGateway(properties.getBaseUrl()); | ||
| if (StringUtils.hasText(properties.getUsername())) { | ||
| pushGateway.setConnectionFactory( | ||
| new BasicAuthHttpConnectionFactory(properties.getUsername(), properties.getPassword())); | ||
| } | ||
| return new PrometheusPushGatewayManager(pushGateway, collectorRegistry, pushRate, job, groupingKey, | ||
| shutdownOperation); | ||
| } | ||
|
|
||
| private PushGateway initializePushGateway(String url) throws MalformedURLException { | ||
| return new PushGateway(new URL(url)); | ||
| } | ||
|
|
||
| private String getJob(PrometheusProperties.Pushgateway properties, Environment environment) { | ||
| String job = properties.getJob(); | ||
| job = (job != null) ? job : environment.getProperty("spring.application.name"); | ||
| return (job != null) ? job : FALLBACK_JOB; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed this from here to avoid the
NoClassDefFoundErrorMoritz found before. I've duplicated the class similar to other classes so there is a simpleclient version now that is used by the corresponding autoconfig. I also removed the Pushgateway related properties until the latest versions of the Prometheus client support it and we can add back auto-configuration support for it here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reverted the change duplicating the ConfigurationProperties class and instead made a
HistogramFlavorenum here to avoid requiring the micrometer-registry-prometheus-simpleclient module. The config adapter handles mapping to the Micrometer enum.