Skip to main content

Using actuator in Spring boot to analyze and monitor your application

Intro

Spring boot offers a wonderful module called the actuator. It is somewhat similar to the tools offered by Rails or other frameworks to get a better view of your application.

Basically when you enable it, you can browse to a url which by default is at /actuator (but can be configured), where you will find very interesting pieces of information about your Spring boot application.

For example, if you built a MVC webapp where you wrote a number of @Controller or @RestController classes, then going to /actuator/mappings will list your endpoints along with which controller method serve which endpoint etc.

But there is a whole lot more in actuator you will find useful.

In this article, I will show you how to use it in your application, and also how to only enable it in your development profile. I would assume that you don't want soething like this enabled in your production deployment. We will use Spring profiles for this.

Setup

I am assuming you have a working Spring boot application containing a structure somewhat like this:

src/main/resources/application.properties
src/main/java/...yourCode
build.gradle (if using gradle, otherwise Maven pom)

Adding Actuator to your application


Now all you have to do is add a dependency to spring-boot-starter kit for actuator. My gradle file had this in dependencies section:
runtime("org.springframework.boot:spring-boot-starter-actuator")
Runtime is usually appropriate for a tool like this, in terms of dependency scope. You don't want this to become part of your transitive dependency graph.

Now that's it, if you start your application, and browse to http://localhost:port/actuator you will see a number of available links.

If you don't see much, don't worry, it's because actuator does not by default enable many modules as of Spring 5.x (forget which version).

To make more module available here, jsut add something like this (or a variatoin of this) to your application.properties file

# We will use this only in dev mode, not a wise idea to do this in prod!# exposes spring-boot-actuator endpoints like /mappings 
management.endpoints.web.exposure.include=*
This is fully documented in spring actuator documentation, so I won't describe it, but briefly, tihs enables all available endpoints in actuator. I just do this in my development lifecycle.


Only enabling Actuator in development profile


This is optional and upto you of course, but I always do this to avoid exposing this in production. Spring has support for profiles. The steps below will make 'dev' the default profile, enable actuator in that profile, and not enable it in 'prod' profile.

Create two properties file in src/main/resources, so now it looks like this:

src/main/resources/
        application.properties
        application-dev.properties
        application-prod.properties

The contents can be like this, only showing actuator pieces:

application.properties:
spring.profiles.active=dev
# just whatever else you want by default in all profiles
application-dev.properties: 

     management.endpoints.web.exposure.include=*

application-prod.properties:
management.endpoints.web.exposure.exclude=*
       
That's it, now when you start without any switches you get 'dev' profile and actuator is fully enabled. When you start with -Dspring.profile.active=prod, you get no actuator endpoints.

Conclusion

Grab your favorite beverage at this point, and don't forget to - Enjoy!

Ref:

    1. https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-enabling.html




Labels:

Comments

Post a Comment

Popular posts from this blog

Authenticating Spring Boot based application against secure LDAP/AD server

Authenticating against an Active Directory setup is quite common in organizations using Spring Boot / Spring Security can be a pain if you don't know exactly the requirements. I needed to add auth in my web app and secure some but not all endpoints of the application. My story was, I needed Spring security to authenticate against my company LDAP server which uses Active Directory I started by using the standard LDAP guide such as this which are all over the Internet, https://spring.io/guides/gs/authenticating-ldap/ and was able to setup the basic framework However, only test level LDAP auth was working for me, when I tried to auth against the company LDAP secure server, I had to resolve a few issues After 1 week and working with several devs at the company, I finally found why it was not working and the fix was easy Since I spent a week or so resolving this, I wanted to write this up in case someone finds this useful. Here is what I did (it was easy until the fourth ...
Post a Comment
Read more

Unit testing code that uses environment variables and system properties with fakes

I did not exactly learn this today, but I am sharing it as I have found it extremely useful when unit testing code that depends on environment or system property settings. While I am using Java as an example, the general concepts apply any where. Problem : You have a piece of code you are unit testing that uses settings from env variables or system properties passed to the VM (System.getProperty), but you don't want the tests to be affected by the 'real' environment or system properties in the VM. So, your unit tests should not get different results or fail when the real environment changes. Solution : There are several. But the most straightforward is to use a mocking library to mock out the environment or fake it out, whatever your prefer. You can create a fake using a library like EasyMock, PowerMock etc. This I won't discuss in this post, since there are numerous articles for that. Or you can write a simple class that acts as a proxy, using the proxy pattern...
Post a Comment
Read more

Using custom conditional logic to enable/disable Spring components

If you have a Spring component and you don't want it to load, you can use Spring's predefined conditionals as much as possible. For example, @Component   @ConditionalOnNotWebApplication   public class SchedulerEntryPoint implements ApplicationRunner { ...  } This will not load your component when running in non web application mode. Such as you may want to start the application but without any of the web framework using SpringApplicationBuilder. But sometimes you want to use custom conditions. It's pretty easy to do so, just use something like this @Component @Conditional (SchedulerCheck. class ) public class SchedulerEntryPoint implements ApplicationRunner { public static class SchedulerCheck implements Condition { @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { return System. getProperty ( "scheduler" ) != ...
Post a Comment
Read more