Allow the configprops endpoint to return properties with a particular prefix #24718

onobc · 2021-01-10T04:53:17Z

Adds ability to filter by prefix for /actuator/configprops

Fixes gh-24714

No filter

Filter by prefix

(ℹ️ this was taken from v1 screenshot and url does not contain prefix param anymore)

...g/springframework/boot/actuate/context/properties/ConfigurationPropertiesReportEndpoint.java

onobc · 2021-01-10T04:57:59Z

...g/springframework/boot/actuate/context/properties/ConfigurationPropertiesReportEndpoint.java

-		beans.forEach((beanName, bean) -> descriptors.put(beanName, describeBean(mapper, bean)));
+
+		Map<String, ConfigurationPropertiesBeanDescriptor> descriptors = beans.values().stream()
+				.filter(beanFilterPredicate::test)


I took the approach of simply filtering out at the config props level and not returning a different payload for the individual api case. This differs form the /env endpoint as it returns an XYZEntry object instead of an XYZ. This provided the filtering and introduced less ripple.

onobc · 2021-01-10T04:59:22Z

...oot/actuate/context/properties/ConfigurationPropertiesReportEndpointWebIntegrationTests.java

+import static org.hamcrest.Matchers.hasSize;
+
+/**
+ * Integration tests for {@link ConfigurationPropertiesReportEndpoint} exposed by Jersey,


I noticed that we did not have @WebEndpointTest coverage for /actuator/configprops - this adds it.

...oot/actuate/context/properties/ConfigurationPropertiesReportEndpointWebIntegrationTests.java

...g/springframework/boot/actuate/context/properties/ConfigurationPropertiesReportEndpoint.java

onobc · 2021-01-13T15:14:11Z

...boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/configprops.adoc

@@ -26,3 +26,26 @@ The following table describes the structure of the response:

 [cols="2,1,3"]
 include::{snippets}/configprops/response-fields.adoc[]
+
+
+[[configprops-retrieving-by-prefix]]


@wilkinsona I absolutely ❤️ what you did here w/ the endpoint doc generation - clever. It provides a consistent and accurate set of docs as well as provides some test coverage. It took a second for me to put the pieces together - but once I did, its a breeze. Thank you.

That's lovely to hear. Thank you!

...oot/actuate/context/properties/ConfigurationPropertiesReportEndpointWebIntegrationTests.java

Fixes gh-24714

onobc · 2021-01-13T15:33:56Z

...oot/actuate/context/properties/ConfigurationPropertiesReportEndpointWebIntegrationTests.java

+	}
+
+    @WebEndpointTest
+    void filterByNonExistentPrefix() {


Should we return 404 in case of no prefix match? If so I need to create a web endpoint extension. Just let me know what the preference is here. Because the prefix can match multiple entries it feels more of a "List findByPrefix" than a "Object findByPrimaryKey" (if you will).

A 404 feels right to me. That's what we do in the env endpoint for a property that doesn't exist. It too can match multiple entries as the same property may be defined in multiple property sources.

…o serve 404 when no match found

This commit improves the configprops endpoint to allow filtering properties based on a particular prefix See gh-24718

See gh-24718

snicoll · 2021-02-10T16:36:12Z

nicely done Chris. I've polished your contribution in b92bb93. The interesting bits is that we name the method differently when there is a selector so that the JMX operation (that uses the method name) can provide a bit more context as what it does compared to the general operation.

Thanks again!

…ension See spring-projectsgh-24718