Exposing a Helpful Info Endpoint with Spring Boot Actuator

2 Comments / Spring Boot / By
Table Of Content 
<span class="line"><span style="color: #D8DEE9">management</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">info</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">java</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">enabled</span><span style="color: #81A1C1">=true</span></span>

Let’s rerun the application. If we open the actuator endpoint again in a browser, we get an output like this:

<span class="line"><span style="color: #ECEFF4">{</span></span>
<span class="line"><span style="color: #D8DEE9FF">  </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">java</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">{</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">vendor</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">Eclipse Adoptium</span><span style="color: #ECEFF4">"</span><span style="color: #ECEFF4">,</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">version</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">11.0.14</span><span style="color: #ECEFF4">"</span><span style="color: #ECEFF4">,</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">runtime</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">{</span></span>
<span class="line"><span style="color: #D8DEE9FF">      </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">name</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">OpenJDK Runtime Environment</span><span style="color: #ECEFF4">"</span><span style="color: #ECEFF4">,</span></span>
<span class="line"><span style="color: #D8DEE9FF">      </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">version</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">11.0.14+9</span><span style="color: #ECEFF4">"</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">},</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">jvm</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">{</span></span>
<span class="line"><span style="color: #D8DEE9FF">      </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">name</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">OpenJDK 64-Bit Server VM</span><span style="color: #ECEFF4">"</span><span style="color: #ECEFF4">,</span></span>
<span class="line"><span style="color: #D8DEE9FF">      </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">vendor</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">Eclipse Adoptium</span><span style="color: #ECEFF4">"</span><span style="color: #ECEFF4">,</span></span>
<span class="line"><span style="color: #D8DEE9FF">      </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">version</span><span style="color: #ECEFF4">"</span><span style="color: #81A1C1">:</span><span style="color: #D8DEE9FF"> </span><span style="color: #ECEFF4">"</span><span style="color: #A3BE8C">11.0.14+9</span><span style="color: #ECEFF4">"</span></span>
<span class="line"><span style="color: #D8DEE9FF">    </span><span style="color: #ECEFF4">}</span></span>
<span class="line"><span style="color: #D8DEE9FF">  </span><span style="color: #ECEFF4">}</span></span>
<span class="line"><span style="color: #ECEFF4">}</span></span>

You are likely to see different values based on the installed Java version.

Now, it’s time to display environment variables. Spring picks up any environment variable with a property name starting with info. To see this in action, let’s add the following properties in the application.properties file:

<span class="line"><span style="color: #D8DEE9">management</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">info</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">env</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">enabled</span><span style="color: #81A1C1">=true</span></span>
<span class="line"><span style="color: #D8DEE9">info</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">app</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">website</span><span style="color: #81A1C1">=</span><span style="color: #D8DEE9">reflectoring</span><span style="color: #ECEFF4">.</span><span style="color: #D8DEE9">io</span></span>
The file content will be similar to this:

build.artifact=spring-boot-build-info
build.group=io.reflectoring
build.name=spring-boot-build-info
build.time=2022-03-06T05\:53\:45.236Z
build.version=0.0.1-SNAPSHOT

Using the Gradle Plugin

  • By default, the following information will be exposed:
  • git.branch
  • git.commit.id
  • git.commit.time

Related Posts

2 thoughts on “Exposing a Helpful Info Endpoint with Spring Boot Actuator”

Leave a Comment

Your email address will not be published. Required fields are marked *

Scroll to Top
×