root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Add support for configuring the path of disk space metrics 

See gh-27660
This commit is contained in:
bono007 2021-08-24 21:53:57 -05:00 committed by Stephane Nicoll
parent d4374f49bc
commit 08251b26d0
6 changed files with 231 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java
View File

@ -16,8 +16,11 @@
package org.springframework.boot.actuate.autoconfigure.metrics;
import java.io.File;
import java.time.Duration;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ -30,6 +33,7 @@ import org.springframework.boot.context.properties.NestedConfigurationProperty;
* @author Jon Schneider
* @author Alexander Abramov
* @author Tadaya Tsuyukubo
* @author Chris Bono
* @since 2.0.0
*/
@ConfigurationProperties("management.metrics")
@ -57,6 +61,8 @@ public class MetricsProperties {
private final Data data = new Data();
private final System system = new System();
private final Distribution distribution = new Distribution();
public boolean isUseGlobalRegistry() {
@ -87,6 +93,10 @@ public class MetricsProperties {
return this.distribution;
}
public System getSystem() {
return this.system;
}
public static class Web {
private final Client client = new Client();
@ -342,4 +352,31 @@ public class MetricsProperties {
}
public static class System {
private final Diskspace diskspace = new Diskspace();
public Diskspace getDiskspace() {
return this.diskspace;
}
public static class Diskspace {
/**
* Comma-separated list of paths to report disk metrics for.
*/
private List<File> paths = Arrays.asList(new File("."));
public List<File> getPaths() {
return this.paths;
}
public void setPaths(List<File> paths) {
this.paths = paths;
}
}
}
}

18
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/SystemMetricsAutoConfiguration.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
@ -16,14 +16,13 @@
package org.springframework.boot.actuate.autoconfigure.metrics;
import java.io.File;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.binder.system.DiskSpaceMetrics;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.system.FileDescriptorMetrics;
import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
import io.micrometer.core.instrument.binder.system.UptimeMetrics;
import org.springframework.boot.actuate.metrics.system.DiskSpaceMetricsBinder;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@ -36,6 +35,7 @@ import org.springframework.context.annotation.Configuration;
* {@link EnableAutoConfiguration Auto-configuration} for system metrics.
*
* @author Stephane Nicoll
* @author Chris Bono
* @since 2.1.0
*/
@Configuration(proxyBeanMethods = false)
@ -44,6 +44,12 @@ import org.springframework.context.annotation.Configuration;
@ConditionalOnBean(MeterRegistry.class)
public class SystemMetricsAutoConfiguration {
private final MetricsProperties properties;
public SystemMetricsAutoConfiguration(MetricsProperties properties) {
this.properties = properties;
}
@Bean
@ConditionalOnMissingBean
public UptimeMetrics uptimeMetrics() {
@ -64,8 +70,8 @@ public class SystemMetricsAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public DiskSpaceMetrics diskSpaceMetrics() {
return new DiskSpaceMetrics(new File("."));
public DiskSpaceMetricsBinder diskSpaceMetrics() {
return new DiskSpaceMetricsBinder(this.properties.getSystem().getDiskspace().getPaths(), Tags.empty());
}
}

37
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/SystemMetricsAutoConfigurationTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 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.
@ -17,14 +17,17 @@
package org.springframework.boot.actuate.autoconfigure.metrics;
import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import io.micrometer.core.instrument.binder.system.DiskSpaceMetrics;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.system.FileDescriptorMetrics;
import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
import io.micrometer.core.instrument.binder.system.UptimeMetrics;
import org.junit.jupiter.api.Test;
import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
import org.springframework.boot.actuate.metrics.system.DiskSpaceMetricsBinder;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
@ -81,16 +84,37 @@ class SystemMetricsAutoConfigurationTests {
@Test
void autoConfiguresDiskSpaceMetrics() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(DiskSpaceMetrics.class));
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(DiskSpaceMetricsBinder.class));
}
@Test
void allowsCustomDiskSpaceMetricsToBeUsed() {
this.contextRunner.withUserConfiguration(CustomDiskSpaceMetricsConfiguration.class)
.run((context) -> assertThat(context).hasSingleBean(DiskSpaceMetrics.class)
.run((context) -> assertThat(context).hasSingleBean(DiskSpaceMetricsBinder.class)
.hasBean("customDiskSpaceMetrics"));
}
@Test
void diskSpaceMetricsUsesDefaultPath() {
this.contextRunner
.run((context) -> assertThat(context).hasBean("diskSpaceMetrics").getBean(DiskSpaceMetricsBinder.class)
.hasFieldOrPropertyWithValue("paths", Collections.singletonList(new File("."))));
}
@Test
void allowsDiskSpaceMetricsPathToBeConfiguredWithSinglePath() {
this.contextRunner.withPropertyValues("management.metrics.system.diskspace.paths:..")
.run((context) -> assertThat(context).hasBean("diskSpaceMetrics").getBean(DiskSpaceMetricsBinder.class)
.hasFieldOrPropertyWithValue("paths", Collections.singletonList(new File(".."))));
}
@Test
void allowsDiskSpaceMetricsPathToBeConfiguredWithMultiplePaths() {
this.contextRunner.withPropertyValues("management.metrics.system.diskspace.paths:.,..")
.run((context) -> assertThat(context).hasBean("diskSpaceMetrics").getBean(DiskSpaceMetricsBinder.class)
.hasFieldOrPropertyWithValue("paths", Arrays.asList(new File("."), new File(".."))));
}
@Configuration(proxyBeanMethods = false)
static class CustomUptimeMetricsConfiguration {
@ -125,8 +149,9 @@ class SystemMetricsAutoConfigurationTests {
static class CustomDiskSpaceMetricsConfiguration {
@Bean
DiskSpaceMetrics customDiskSpaceMetrics() {
return new DiskSpaceMetrics(new File(System.getProperty("user.dir")));
DiskSpaceMetricsBinder customDiskSpaceMetrics() {
return new DiskSpaceMetricsBinder(Collections.singletonList(new File(System.getProperty("user.dir"))),
Tags.empty());
}
}

52
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/system/DiskSpaceMetricsBinder.java Normal file
View File

@ -0,0 +1,52 @@
/*
* Copyright 2012-2021 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.metrics.system;
import java.io.File;
import java.util.List;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.binder.jvm.DiskSpaceMetrics;
import org.springframework.util.Assert;
/**
* A {@link MeterBinder} that binds one or more {@link DiskSpaceMetrics}.
*
* @author Chris Bono
* @since 2.6.0
*/
public class DiskSpaceMetricsBinder implements MeterBinder {
private final List<File> paths;
private final Iterable<Tag> tags;
public DiskSpaceMetricsBinder(List<File> paths, Iterable<Tag> tags) {
Assert.notEmpty(paths, "Paths must not be empty");
this.paths = paths;
this.tags = tags;
}
@Override
public void bindTo(MeterRegistry registry) {
this.paths.forEach((path) -> new DiskSpaceMetrics(path, this.tags).bindTo(registry));
}
}

20
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/system/package-info.java Normal file
View File

@ -0,0 +1,20 @@
/*
* Copyright 2012-2021 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.
*/
/**
* Actuator support for system metrics.
*/
package org.springframework.boot.actuate.metrics.system;

79
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/system/DiskSpaceMetricsBinderTests.java Normal file
View File

@ -0,0 +1,79 @@
/*
* Copyright 2012-2021 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.metrics.system;
import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link DiskSpaceMetricsBinder}.
*
* @author Chris Bono
*/
class DiskSpaceMetricsBinderTests {
@Test
void diskSpaceMetricsWithSinglePath() {
MeterRegistry meterRegistry = new SimpleMeterRegistry();
File path = new File(".");
DiskSpaceMetricsBinder metricsBinder = new DiskSpaceMetricsBinder(Collections.singletonList(path),
Tags.empty());
metricsBinder.bindTo(meterRegistry);
Tags tags = Tags.of("path", path.getAbsolutePath());
assertThat(meterRegistry.get("disk.free").tags(tags).gauge()).isNotNull();
assertThat(meterRegistry.get("disk.total").tags(tags).gauge()).isNotNull();
}
@Test
void diskSpaceMetricsWithMultiplePaths() {
MeterRegistry meterRegistry = new SimpleMeterRegistry();
File path1 = new File(".");
File path2 = new File("..");
DiskSpaceMetricsBinder metricsBinder = new DiskSpaceMetricsBinder(Arrays.asList(path1, path2), Tags.empty());
metricsBinder.bindTo(meterRegistry);
Tags tags = Tags.of("path", path1.getAbsolutePath());
assertThat(meterRegistry.get("disk.free").tags(tags).gauge()).isNotNull();
assertThat(meterRegistry.get("disk.total").tags(tags).gauge()).isNotNull();
tags = Tags.of("path", path2.getAbsolutePath());
assertThat(meterRegistry.get("disk.free").tags(tags).gauge()).isNotNull();
assertThat(meterRegistry.get("disk.total").tags(tags).gauge()).isNotNull();
}
@Test
void diskSpaceMetricsWithCustomTags() {
MeterRegistry meterRegistry = new SimpleMeterRegistry();
File path = new File(".");
Tags customTags = Tags.of("foo", "bar");
DiskSpaceMetricsBinder metricsBinder = new DiskSpaceMetricsBinder(Collections.singletonList(path), customTags);
metricsBinder.bindTo(meterRegistry);
Tags tags = Tags.of("path", path.getAbsolutePath(), "foo", "bar");
assertThat(meterRegistry.get("disk.free").tags(tags).gauge()).isNotNull();
assertThat(meterRegistry.get("disk.total").tags(tags).gauge()).isNotNull();
}
}