<div dir="ltr" style="text-align: justify;">
<div style="text-align: justify;">
<div style="font-size: 13pt;">
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Hello friends!!! In this article, we’re going to introduce <strong>Spring Boot Actuator</strong> for collecting metrics about your production grade applications and also talk about some simple ways to work with them in production. Spring Boot Actuator is a sub-project of Spring Boot. It adds several production grade services to your application with little effort on your part. Lets discuss here about spring boot actuator and different types of metrics that can be collected using this feature.</div>
</div>
<h2>Spring Boot Actuator</h2>
<div style="font-size: 13pt;">
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>Related Tutorial read before it.</b><a href="https://dineshonjava.com/introduction-to-spring-boot-a-spring-boot-complete-guide/"><b>Introduction to Spring Boot &#8211; A Spring Boot Complete Guide</b></a></div>
<h3 style="font-family: calibri, sans-serif; font-size: 13pt;"><b>Table of Contents</b></h3>
<ol style="font-family: calibri, sans-serif; font-size: 13pt;">
<li><b><a href="http:/#1">What Is An Actuator?</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#2">How to Enable an Actuator?</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#3">Endpoints</a></b>
<ul>
<li style="list-style-type: none;">
<ul>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#31">Customizing Existing Endpoints</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#32">Health information- /health Endpoint</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#33">Security with HealthIndicators</a></b>
<ul>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#331">A Custom HealthIndicator</a></b></li>
</ul>
</li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#34">Application information- /info Endpoint</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#35">Metrics Information-/metrics Endpoint</a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/#36">Endpoint – Logfile</a></b></li>
</ul>
</li>
</ul>
</li>
<li><b><a href="https://dineshonjava.com/2016/08/spring-boot-actuator-complete-guide.html#4">Custom Metric Data</a></b></li>
<li><b><a href="https://dineshonjava.com/2016/08/spring-boot-actuator-complete-guide.html#5">Create A New Endpoint</a></b></li>
<li><b><a href="https://dineshonjava.com/2016/08/spring-boot-actuator-complete-guide.html#6">A New Endpoint To List All Endpoints</a></b></li>
<li><b><a href="https://dineshonjava.com/2016/08/spring-boot-actuator-complete-guide.html#7">Actuator Example application</a></b></li>
<li><b><a href="https://dineshonjava.com/2016/08/spring-boot-actuator-complete-guide.html#8">Summary</a></b></li>
</ol>
<div id="ads-id" align="center"></div>
<h3 id="1" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>1. What Is Spring Boot Actuator?</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Spring Boot Actuator is sub-project of Spring Boot and it is one of the nice feature that adds great value to the Spring Boot applications. It adds several production grade services to your application with little effort on your part. There are also has many features added to your application out-of-the-box for managing the service in a production (or other) environment. They’re mainly used to expose different types of information about the running application – health, metrics, info, dump, env etc.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<h3 id="2" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>2. How To Enable Spring Boot Actuator?</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The spring-boot-actuator module provides all of Spring Boot’s production-ready features. The simplest way to enable the features is to add a dependency to the <b>spring-boot-starter-actuator</b> ‘Starter’.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><br />
</b><b>2.1 In Maven Project</b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;"><;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-actuator<;/artifactId>; 
 <;/dependency>; 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><br />
</b><b>2.2 In Gradle Project</b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">dependencies { 
 compile("org.springframework.boot:spring-boot-starter-actuator") 
} 
</pre>
<h3 id="3" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3. Endpoints</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Actuator endpoints allow you to monitor and interact with your application. Spring Boot includes a number of built-in endpoints and you can also add your own. Most endpoints are sensitive – meaning they’re not fully public – while a handful are not: /health and /info.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Here’s some of the most common endpoints Boot provides out of the box:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li><b>/actuator-</b> Provides a hypermedia-based “discovery page” for the other endpoints. Requires Spring HATEOAS to be on the classpath. Sensitive by Default.</li>
<li><b>/autoconfig- </b>Displays an auto-configuration report showing all auto-configuration candidates and the reason why they ‘were’ or ‘were not’ applied. Sensitive by Default.</li>
<li><b>/beans-</b> Displays a complete list of all the Spring beans in your application. Sensitive by Default.</li>
<li><b>/configprops-</b> This endpoint shows configuration properties used by your application. Sensitive by Default.</li>
<li><b>/dump-</b> Performs a thread dump. Sensitive by Default.</li>
<li><b>/env-</b> Exposes spring’s properties from the configurations. Sensitive by Default.</li>
<li><b>/health</b> – Shows application health information (a simple ‘status’ when accessed over an unauthenticated connection or full message details when authenticated). It is sensitive by default.</li>
<li><b>/info</b> – Displays arbitrary application info. Not sensitive by default.</li>
<li><b>/metrics</b> – Shows ‘metrics’ information for the current application. It is also sensitive by default.</li>
<li><b>/mappings-</b> Displays a list of all @RequestMapping paths. Sensitive by Default.</li>
<li><b>/shutdown-</b> This endpoint allows to shutdown the application. This is not enabled by default. Sensitive by Default.</li>
<li><b>/trace </b>– Displays trace information (by default the last few HTTP requests). Sensitive by Default.</li>
<li><b>/logfile</b>&#8211; Provides access to the configured log files (This feature supported since Spring Boot 1.3.0). Sensitive by Default.</li>
<li><b>/flyway-</b> This endpoint provides the details of any flyway database migrations have been applied. Sensitive by Default.</li>
<li><b>/liquibase-</b> This endpoint provides the details of any liquibase database migrations have been applied. Sensitive by Default.</li>
</ul>
<div id="31" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.1 Customizing Existing Endpoints</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Above listed each endpoint can be customized with properties using the following format:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><i>endpoints.[endpoint name].[property to customize]</i></b></div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li>id – by which this endpoint will be accessed over HTTP</li>
<li>enabled – if true then it can be accessed otherwise not</li>
<li>sensitive – if true then need authorization to show crucial information over HTTP</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">You can change how those endpoints are exposed using <b>application.properties</b>, the most common settings:</div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li><b>management.port=8081</b> &#8211; you can expose those endpoints on port other than the one application is using (8081 here).</li>
<li><b>management.address=127.0.0.1</b> &#8211; you can only allow to access by IP address (localhost here).</li>
<li><b>management.context-path=/actuator</b> &#8211; allows you to have those endpoints grouped under specified context path rather than root, i.e. /actuator/health.</li>
<li><b>endpoints.health.enabled=false</b> &#8211; allows to enable/disable specified endpoint by name, here /health is disabled.</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>Securing endpoints</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">For security purposes, you might choose to expose the actuator endpoints over a non-standard port – the <b>management.port</b> property can easily be used to configure that. The information exposed by endpoints is most of the time sensitive. While /health is usually harmless to be exposed, /metrics would be too much. Fortunately, you can use Spring Security for that purpose.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Adding starter to class path by adding following dependency to <b>pom.xml</b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;"><;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-security<;/artifactId>; 
<;/dependency>; 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">You can disable basic security it in<b> application.properties</b>, so that it leaves only the sensitive Actuator endpoints secured and leaves the rest open for access:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">security.basic.enabled=false 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">You can secure these endpoints by defining the default security properties – user name, password and role – in <b>application.properties</b> file:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">security.user.name=admin 
security.user.password=secret 
management.security.role=SUPERUSER 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">In case you&#8217;re using the security features across the application and decided to secure those endpoints yourself, you can disable default security for Actuator:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">management.security.enabled=false 
</pre>
<div id="32" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.2 Health information- /health Endpoint</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Health information can be used to check the status of your running application. It is often used by monitoring software to alert someone if a production system goes down. The default information exposed by the health endpoint depends on how it is accessed.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><u>http://localhost:8080/health</u></b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
"status" : "UP" 
} 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">This health information is collected from all the beans implementing <b>HealthIndicator </b>interface configured in your application context.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div id="33" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.3 Security with HealthIndicators</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Some information returned by HealthIndicator is sensitive in nature – but you can configure <b>endpoints.health.sensitive=false</b> to expose the other information like diskspace, datasource etc.</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">endpoints.health.sensitive=false 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">You can write your custom health indicator to provide additional details to the user. The following are the list of health indication implementation classes available for customization:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li>DiskSpaceHealthIndicator</li>
<li>DataSourceHealthIndicator</li>
<li>MongoHealthIndicator</li>
<li>RabbitHealthIndicator</li>
<li>SolrHealthIndicator</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The basic configurations for health endpoint is:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">endpoints.health.id=health 
endpoints.health.sensitive=true 
endpoints.health.enabled=true 
</pre>
<div id="331" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>Customized Health checkup:</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The basic idea for health checks is that they can provide more insightful information to you on the application&#8217;s health. Besides checking if the application is UP or DOWN, which is done by default, you can add checks for things like database connectivity or whatever suits you. This is in fact what is being done when you add other Spring Boot starters, as they often provide additional health checks.</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">/** 
 * 
 */ 
package com.dineshonjava.sba; 
 
import org.springframework.boot.actuate.health.Health; 
import org.springframework.boot.actuate.health.HealthIndicator; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
public class MyAppHealth implements HealthIndicator{ 
 
 @Override 
 public Health health() { 
 int errorCode = check(); // perform some specific health check 
 if (errorCode != 0) { 
 return Health.down().withDetail("Error Code", errorCode).build(); 
 } 
 return Health.up().build(); 
 } 
 
 private int check() { 
 // Your logic to check health 
 return 0; 
 } 
 
} 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">As you can see all it takes is to create a bean implementing HealthIndicator with a method health() returning appropriate Health object. The checks you create will appear on the /health endpoint, so the application can be monitored for them. The output will be:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><u>http://localhost:8080/health</u></b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
status: "UP", 
diskSpace: { 
status: "UP", 
total: 240721588224, 
free: 42078715904, 
threshold: 10485760 
} 
} 
</pre>
<div id="34" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.4 Application information- /info Endpoint</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Application information exposes various information collected from all InfoContributor beans defined in your ApplicationContext. Spring Boot includes a number of auto-configured InfoContributors and you can also write your own. The default value for sensitive is false. There is no harm in exposing this details as that is common details that has to be exposed to others.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">You can also customize the data shown by /info endpoint – for example: Configuration in <b>application.properties</b> file:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
endpoints.info.id=info 
endpoints.info.sensitive=false 
endpoints.info.enabled=true 
 
info.app.name=Spring Boot Actuator Application 
info.app.description=This is my first Working Spring Actuator Examples 
info.app.version=0.0.1-SNAPSHOT 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">And the sample output:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b><u>http://localhost:8080/info</u></b></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
{ 
app: { 
version: "0.0.1-SNAPSHOT", 
description: "This is my first Working Spring Actuator Examples", 
name: "Spring Boot Actuator Application" 
} 
} 
</pre>
<div id="35" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.5 Metrics Information-/metrics Endpoint</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The metrics endpoint is one of the more important endpoints as it gathers and publishes information about OS, JVM and Application level metrics; out of the box, we get things like memory, heap, processors, threads, classes loaded, classes unloaded, thread pools along with some HTTP metrics as well. By default this endpoint is enabled under the HTTP URL /metrics.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">he example configuration for this endpoint is:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
endpoints.metrics.id=metrics 
endpoints.metrics.sensitive=true 
endpoints.metrics.enabled=true 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Here’s what the output of this endpoint looks like out of the box:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">http://localhost:8080/metrics</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">{ 
{ 
mem: 55470, 
mem.free: 5398, 
processors: 4, 
instance.uptime: 9452, 
uptime: 14466, 
systemload.average: -1, 
heap.committed: 35020, 
heap.init: 16384, 
heap.used: 29621, 
heap: 253440, 
nonheap.committed: 20800, 
nonheap.init: 160, 
nonheap.used: 20451, 
nonheap: 0, 
threads.peak: 17, 
threads.daemon: 14, 
threads.totalStarted: 20, 
threads: 16, 
classes: 6542, 
classes.loaded: 6542, 
classes.unloaded: 0, 
gc.copy.count: 60, 
gc.copy.time: 232, 
gc.marksweepcompact.count: 2, 
gc.marksweepcompact.time: 61, 
httpsessions.max: -1, 
httpsessions.active: 0 
} 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">There are following multiple resources matrics exposed by spring boot actualtor</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.5.1. System Metrics</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The following system metrics are exposed by Spring Boot:</div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li>The total system memory in KB (mem)</li>
<li>The amount of free memory in KB (mem.free)</li>
<li>The number of processors (processors)</li>
<li>The system uptime in milliseconds (uptime)</li>
<li>The application context uptime in milliseconds (instance.uptime)</li>
<li>The average system load (systemload.average)</li>
<li>Heap information in KB (heap, heap.committed, heap.init, heap.used)</li>
<li>Thread information (threads, thread.peak, thread.daemon)</li>
<li>Class load information (classes, classes.loaded, classes.unloaded)</li>
<li>Garbage collection information (gc.xxx.count, gc.xxx.time)</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.5.2. DataSource metrics</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The following metrics are exposed for each supported DataSource defined in your application:</div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li>The number of active connections (datasource.xxx.active)</li>
<li>The current usage of the connection pool (datasource.xxx.usage).</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.5.3 Cache metrics</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The following metrics are exposed for each supported cache defined in your application:</div>
<ul style="font-family: calibri, sans-serif; font-size: 13pt;">
<li>The current size of the cache (cache.xxx.size)</li>
<li>Hit ratio (cache.xxx.hit.ratio)</li>
<li>Miss ratio (cache.xxx.miss.ratio)</li>
</ul>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">By default, Spring Boot provides cache statistics for EhCache, Hazelcast, Infinispan, JCache and Guava.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.5.4 Tomcat session metrics</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">If you are using Tomcat as your embedded servlet container, session metrics will automatically be exposed. The httpsessions.active and httpsessions.max keys provide the number of active and maximum sessions.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">there are many more matrics you can following spring boot docs for more info http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>3.6 Endpoint – Logfile</b></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">This endpoint will be automatically enabled if <b>logging.path</b> or <b>logging.file</b> properties are configured in the <b>application.properties</b> file. When you access the logile endpoint, this will return the complete log of the application.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<h3 id="4" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>4. Custom Metric Data</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">To record your own metrics inject a CounterService and/or GaugeService into your bean. The CounterService exposes increment, decrement and reset methods; the GaugeService provides a submit method.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><b>For example</b> – we’ll customize the login flow to record a successful and failed login attempt:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">/** 
 * 
 */ 
package com.dineshonjava.sba; 
 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.boot.actuate.metrics.CounterService; 
import org.springframework.stereotype.Service; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
@Service 
public class LoginService { 
 
 
 CounterService counterService; 
 
 @Autowired 
 public LoginService(CounterService counterService) { 
 this.counterService = counterService; 
 doLogin(); 
 } 
 
 public boolean login(String userName, String password) { 
 boolean success; 
 if (userName.equals("admin") &;&; "secret".equals(password)) { 
 counterService.increment("counter.login.success"); 
 success = true; 
 } 
 else { 
 counterService.increment("counter.login.failure"); 
 success = false; 
 } 
 return success; 
 } 
 
 private void doLogin() { 
 for(int i=0; i<;10; i++){ 
 login("admin", "secret"); 
 } 
 login("admin", "scret"); 
 login("admin", "scret"); 
 } 
} 
 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Here’s what the output might look like:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">...... 
counter.login.failure: 2, 
counter.login.success: 10 
.... 
} 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Besides <b>CounterService </b>the other one provided by default is <b>GaugeService </b>that is used to collect a single double value, i.e. a measured execution time. You can also create and use your own implementations of these two.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<h3 id="5" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>5. Create A New Endpoint</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Besides using the existing endpoints provided by Spring Boot – you can also create an entirely new endpoint. This is useful when you want to expose application details which are an added feature to your application.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">/** 
 * 
 */ 
package com.dineshonjava.sba; 
 
import java.util.ArrayList; 
import java.util.List; 
 
import org.springframework.boot.actuate.endpoint.Endpoint; 
import org.springframework.stereotype.Component; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
@Component 
public class MyCustomEndpoint implements Endpoint<;List<;String>;>;{ 
 
 @Override 
 public String getId() { 
 return "myCustomEndpoint"; 
 } 
 
 @Override 
 public List<;String>; invoke() { 
 // Custom logic to build the output 
 List<;String>; list = new ArrayList<;String>;(); 
 list.add("App message 1"); 
 list.add("App message 2"); 
 list.add("App message 3"); 
 list.add("App message 4"); 
 return list; 
 } 
 
 @Override 
 public boolean isEnabled() { 
 return true; 
 } 
 
 @Override 
 public boolean isSensitive() { 
 return true; 
 } 
 
} 
 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">The way to access this new endpoint is by its id, at <b>/myCustomEndpoint</b>.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"><u><b>http://localhost:8080/myCustomEndpoint</b></u></div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Output:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">[ 
"App message 1", 
"App message 2", 
"App message 3", 
"App message 4" 
] 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">MyCustomEndpoint class implements Endpoint. Any class of type Endpoint will be exposed as an endpoint in the server If you look at the methods, getId(), isEnabled() and isSensitive(), which are the properties that are overridden by the <b>application.properties</b> file. invoke() is the important method responsible for writing the message.</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<h3 id="6" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>6. A New Endpoint To List All Endpoints</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">It is quite useful if you have an endpoint to display all the endpoints in a single web page. There is a built-in endpoint /actuator for this purpose, but you have to add HateOAS in the classpath to enable that feature. To implement this one, you’ll need to extend the AbstractEndpoint class:</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">/** 
 * 
 */ 
package com.dineshonjava.sba; 
 
import java.util.List; 
 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.boot.actuate.endpoint.AbstractEndpoint; 
import org.springframework.boot.actuate.endpoint.Endpoint; 
import org.springframework.stereotype.Component; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
@Component 
@SuppressWarnings("rawtypes") 
public class MyListEndpoints extends AbstractEndpoint<;List<;Endpoint>;>;{ 
 
 List<;Endpoint>; endpoints; 
 
 @Autowired 
 public MyListEndpoints(List<;Endpoint>; endpoints) { 
 super("myListEndpoints"); 
 this.endpoints = endpoints; 
 } 
 
 @Override 
 public List<;Endpoint>; invoke() { 
 return this.endpoints; 
 } 
 
} 
 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">Here’s how the output will look like:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">When you implement the above class, there will be a new endpoint “myListEndpoints” will be registered and exposed to the users. The output will be:</div>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">http://localhost:8080/myListEndpoints</div>
<pre class="highlight" style="font-family: calibri, sans-serif; font-size: 13pt;">[ 
{ 
id: "myCustomEndpoint", 
enabled: true, 
sensitive: true 
}, 
{ 
id: "mappings", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "env", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "health", 
sensitive: false, 
enabled: true, 
timeToLive: 1000 
}, 
{ 
id: "beans", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "info", 
sensitive: false, 
enabled: true 
}, 
{ 
id: "metrics", 
sensitive: false, 
enabled: true 
}, 
{ 
id: "trace", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "dump", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "autoconfig", 
sensitive: true, 
enabled: true 
}, 
{ 
id: "shutdown", 
sensitive: true, 
enabled: false 
}, 
{ 
id: "configprops", 
sensitive: true, 
enabled: true 
} 
] 
</pre>
<div style="font-family: calibri, sans-serif; font-size: 13pt;"></div>
<h3 id="7" style="font-family: calibri, sans-serif; font-size: 13pt;"><b>7. Actuator Example application</b></h3>
<div style="font-family: calibri, sans-serif; font-size: 13pt;">In this section we will make the application which have all required configuration. For creating the application we have used here Spring Boot Web Initializr with Maven Build and following dependencies in pom.xml.</div>
<pre class="highlight" style="font-size: 13pt;"><;?xml version="1.0" encoding="UTF-8"?>; 
<;project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">; 
 <;modelVersion>;4.0.0<;/modelVersion>; 
 
 <;groupId>;com.dineshonjava.sba<;/groupId>; 
 <;artifactId>;SpringBootActuator<;/artifactId>; 
 <;version>;0.0.1-SNAPSHOT<;/version>; 
 <;packaging>;jar<;/packaging>; 
 
 <;name>;SpringBootActuator<;/name>; 
 <;description>;SpringBootActuator project for Spring Boot Actuator<;/description>; 
 
 <;parent>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-parent<;/artifactId>; 
 <;version>;1.4.0.RELEASE<;/version>; 
 <;relativePath/>; <;!-- lookup parent from repository -->; 
 <;/parent>; 
 
 <;properties>; 
 <;project.build.sourceEncoding>;UTF-8<;/project.build.sourceEncoding>; 
 <;project.reporting.outputEncoding>;UTF-8<;/project.reporting.outputEncoding>; 
 <;java.version>;1.8<;/java.version>; 
 <;/properties>; 
 
 <;dependencies>; 
 <;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-actuator<;/artifactId>; 
 <;/dependency>; 
 <;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-security<;/artifactId>; 
 <;/dependency>; 
 <;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-web<;/artifactId>; 
 <;/dependency>; 
 
 <;dependency>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-starter-test<;/artifactId>; 
 <;scope>;test<;/scope>; 
 <;/dependency>; 
 <;/dependencies>; 
 
 <;build>; 
 <;plugins>; 
 <;plugin>; 
 <;groupId>;org.springframework.boot<;/groupId>; 
 <;artifactId>;spring-boot-maven-plugin<;/artifactId>; 
 <;/plugin>; 
 <;/plugins>; 
 <;/build>; 
 
 
<;/project>; 
</pre>
<div style="font-size: 13pt;"></div>
<div style="font-size: 13pt;">And below is project struct as we have finally.</div>
<div style="font-size: 13pt;"></div>
<div class="separator" style="clear: both; font-size: 13pt; text-align: center;"><img src="https://dineshonjava.com/wp-content/uploads/2016/08/Spring-Boot-Actuator.jpg" border="0" /></div>
<div style="font-size: 13pt;"></div>
<div style="font-size: 13pt;"><b>application.properties</b> file for configuration for actuator</div>
<pre class="highlight" style="font-size: 13pt;">#/info endpoint configuration 
endpoints.info.id=info 
endpoints.info.sensitive=false 
endpoints.info.enabled=true 
info.app.name=Spring Boot Actuator Application 
info.app.description=This is my first Working Spring Actuator Examples 
info.app.version=0.0.1-SNAPSHOT 
 
#/metrics endpoint configuration 
endpoints.metrics.id=metrics 
endpoints.metrics.sensitive=false 
endpoints.metrics.enabled=true 
 
#securing endpoints by spring security 
security.basic.enabled=true 
security.user.name=admin 
security.user.password=secret 
 
#/health endpoint configuration (Comment when you are using customized health check) 
endpoints.health.id=health 
endpoints.health.sensitive=false 
endpoints.health.enabled=true 
 
#Management for endpoints 
management.port=8080 
management.context-path=/ 
management.security.enabled=true 
</pre>
<div style="font-size: 13pt;"></div>
<div style="font-size: 13pt;"><b>Whole Code:</b> Here I am not going put all required files for this application you can find whole application from following <strong><a href="https://github.com/DOJ-SoftwareConsultant/SpringBootActuator">git</a> </strong>repository.</div>
<div style="font-size: 13pt;"><b><a href="https://www.blogger.com/goog_967565840"> </a></b></div>
<p><b><a href="https://github.com/DOJ-SoftwareConsultant/SpringBootActuator" target="_blank" rel="noopener">https://github.com/DOJ-SoftwareConsultant/SpringBootActuator</a></b></p>
<h3><b>8. Summary:</b></h3>
<p>In this tutorial we had a first look at the interesting Actuator functionality provided by Spring Boot. I have explained about the basic concepts on actuators, endpoints, list of endpoints, creating custom endpoints, health check,metrics and provided a complete working example application for spring boot actuator.</p>
<p><b>Spring Boot Actuator Video: by Baeldung</b></p>
<p>Happy Spring Boot Learning!!!</p>
<div style="background-color: #f2f9fc; border-radius: 3px; border: 1px solid #c9e6f2; line-height: 1.45; padding: 16px;">
<p><b>Spring Boot Related Topics</b></p>
<ol style="text-align: left;">
<li><b><a href="https://dineshonjava.com/introduction-to-spring-boot-a-spring-boot-complete-guide/">Introduction to Spring Boo</a>t</b></li>
<li><a href="https://dineshonjava.com/essentials-key-components-and-internals-of-spring-boot-framework/"><b>Essentials and Key Components of Spring Boot</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-cli-installation-and-hello-world-example/"><b>Spring Boot CLI Installation and Hello World Example</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-initilizr-web-interface-and-examples/"><b>Spring Boot Initializr Web Interface</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-initilizr-with-ides-via-spring-tool-suite/"><b>Spring Boot Initializr With IDEs</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-initializr-with-spring-boot-cli/"><b>Spring Boot Initializr With Spring Boot CLI</b></a></li>
<li><a href="https://dineshonjava.com/installing-spring-boot/"><b>Installing Spring Boot</b></a></li>
<li><a href="https://dineshonjava.com/developing-your-first-spring-boot-application-hello-world/"><b>Developing your first Spring Boot application</b></a></li>
<li><a href="https://dineshonjava.com/customizing-spring-boot-auto-configuration/"><b>External Configurations for Spring Boot Applications</b></a></li>
<li><a href="https://dineshonjava.com/logging-configuration-in-spring-boot/"><b>Logging Configuration in Spring Boot</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-with-spring-mvc-application/"><b>Spring Boot and Spring MVC</b></a></li>
<li><a href="https://dineshonjava.com/working-with-sql-databases-in-spring-boot-application/"><b>Working with SQL Databases and Spring Boot</b></a></li>
<li><a href="https://dineshonjava.com/mysql-configuration-with-spring-boot/"><b>MySQL Configurations</b></a></li>
<li><a href="https://dineshonjava.com/spring-data-jpa-using-in-spring-boot-application/"><b>Spring Data JPA using Spring Boot Application</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-with-nosql-technologies/"><b>Spring Boot with NoSQL technologies</b></a></li>
<li><a href="https://dineshonjava.com/spring-cache-tutorial/"><b>Spring Cache Tutorial</b></a></li>
<li><a href="https://dineshonjava.com/spring-security-tutorial-using-spring-boot/"><b>Spring Security Tutorial with Spring Boot</b></a></li>
<li><a href="https://dineshonjava.com/spring-boot-and-mongodb-in-rest-application/"><b>Spring Boot and MongoDB in REST Application</b></a></li>
<li><b><a href="https://dineshonjava.com/spring-boot-actuator-complete-guide/">Complete Guide for Spring Boot Actuator</a></b></li>
<li><b><a href="https://dineshonjava.com/microservices-with-spring-boot/">Microservices with Spring Boot</a></b></li>
</ol>
</div>
<p> ;</p>
</div>
</div>
</div>
<div class="wp-post-navigation"> 
									 <div class="wp-post-navigation-pre"> 
									 <a href="https://dineshonjava.com/spring-security-tutorial-using-spring-boot/">Previous</a> 
									 </div> 
									 <div class="wp-post-navigation-next"> 
									 <a href="https://dineshonjava.com/maven-pom-xml-file/">Next</a> 
									 </div> 
									</div>
<script type="text/javascript">
jQuery(document).ready(function($) {
 $.post('https://dineshonjava.com/wp-admin/admin-ajax.php', {action: 'mts_view_count', id: '125'});
});
</script>
Strategy Design Patterns We can easily create a strategy design pattern using lambda. To implement…
Decorator Pattern A decorator pattern allows a user to add new functionality to an existing…
Delegating pattern In software engineering, the delegation pattern is an object-oriented design pattern that allows…
Technology has emerged a lot in the last decade, and now we have artificial intelligence;…
Managing a database is becoming increasingly complex now due to the vast amount of data…
Overview In this article, we will explore Spring Scheduler how we could use it by…