Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document the process info contribution

Browse Source 
Closes gh-45567
This commit is contained in:
Phillip Webb
2025-05-20 13:40:07 -07:00
parent c99521ff0f
commit 752135d068
2 changed files with 26 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/info.adoc
View File

@@ -56,3 +56,13 @@ The following table describes the structure of the `os` section of the response:
[cols="2,1,3"]
include::partial$rest/actuator/info/response-fields-beneath-os.adoc[]
[[info.retrieving.response-structure.process]]
==== Process Response Structure
The following table describes the structure of the `process` section of the response:
[cols="2,1,3"]
include::partial$rest/actuator/info/response-fields-beneath-process.adoc[]

17
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/info/InfoEndpointDocumentationTests.java
View File

@@ -28,6 +28,7 @@ import org.springframework.boot.actuate.info.GitInfoContributor;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.boot.actuate.info.InfoEndpoint;
import org.springframework.boot.actuate.info.OsInfoContributor;
import org.springframework.boot.actuate.info.ProcessInfoContributor;
import org.springframework.boot.info.BuildProperties;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
@@ -54,7 +55,7 @@ class InfoEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
void info() throws Exception {
this.mockMvc.perform(get("/actuator/info"))
.andExpect(status().isOk())
.andDo(MockMvcRestDocumentation.document("info", gitInfo(), buildInfo(), osInfo()));
.andDo(MockMvcRestDocumentation.document("info", gitInfo(), buildInfo(), osInfo(), processInfo()));
}
private ResponseFieldsSnippet gitInfo() {
@@ -90,6 +91,15 @@ class InfoEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
.optional();
}
private ResponseFieldsSnippet processInfo() {
return responseFields(beneathPath("process"),
fieldWithPath("pid").description("Process ID.").type(JsonFieldType.NUMBER),
fieldWithPath("parentPid").description("Parent Process ID (or -1).").type(JsonFieldType.NUMBER),
fieldWithPath("owner").description("Process owner.").type(JsonFieldType.STRING),
fieldWithPath("cpus").description("Number of CPUs available to the process.")
.type(JsonFieldType.NUMBER));
}
@Configuration(proxyBeanMethods = false)
static class TestConfiguration {
@@ -124,6 +134,11 @@ class InfoEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
return new OsInfoContributor();
}
@Bean
ProcessInfoContributor processInfoContributor() {
return new ProcessInfoContributor();
}
}
}