{"id":12940,"date":"2018-12-22T02:07:30","date_gmt":"2018-12-21T19:07:30","guid":{"rendered":"https:\/\/huongdanjava.com\/?p=12940"},"modified":"2025-10-03T09:32:19","modified_gmt":"2025-10-03T02:32:19","slug":"introduction-to-spring-boot-actuator","status":"publish","type":"post","link":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html","title":{"rendered":"Introduction to Spring Boot Actuator"},"content":{"rendered":"

The Spring Boot Actuator is a Spring tool that allows us to monitor our application on a production environment without any code at all. It will expose the information about the application, its status, how the data relates to the application, etc. How is it in detail? Let’s find out in this tutorial!<\/p>\n

First, I will create a Spring Boot project with the Actuator and Web dependencies as follows:<\/p>\n

\"\"<\/p>\n

Now, I will start the Spring Boot project and go to http:\/\/localhost:8080\/actuator<\/a>, and you will see the following result:<\/p>\n

\"\"<\/p>\n

As you can see, although I didn’t do anything, my application still exposes some APIs starting with “\/actuator”, which will allow us to get information about our application.<\/p>\n

For the old version 1.x, Actuator also exposes many other APIs, but from version 2.x, they have been disabled a lot. You can enable these APIs by declaring a property called management.endpoints.web.exposure.include<\/strong> in the application’s application.properties file with the value of the API name we need to enable. The list of these APIs, you can find here https:\/\/docs.spring.io\/spring-boot\/reference\/actuator\/endpoints.html#actuator.endpoints<\/a><\/p>\n

To enable all of them, you can configure the property management.endpoints.web.exposure.include<\/strong>\u00a0with the value as follows:<\/p>\n

management.endpoints.web.exposure.include=*<\/pre>\n
Run the application again and access http:\/\/localhost:8080\/actuator<\/a>, and you will see all the APIs that Actuator exposes, are displayed as follows:<\/p>\n
\"\"<\/p>\n
Here, I will tell you some more information about the API \u201c\/actuator\/health\u201d, which by default, Actuator enables from version 2.x, and the API \u201c\/actuator\/info\u201d. With other APIs, you can learn more according to your needs!<\/p>\n
The first is the “\/actuator\/health” API.<\/strong><\/p>\n
This API is used to allow other applications to check if the status of our application is running normally or stopped. You can click on the “\/actuator\/health” API to see what information it provides to us.<\/p>\n
\"Introduction<\/p>\n
By default, it only displays status information with the value of UP if our application is still running normally; otherwise, if there is any problem, the status will be DOWN.<\/p>\n
We can implement the HealthIndicator interface to specify when our application is DOWN and when it is UP. For example, I have the AppHealthIndicator class that implements the HealthIndicator interface:<\/p>\n
package com.huongdanjava.springbootactuator;\r\n\r\nimport org.springframework.boot.actuate.health.Health;\r\nimport org.springframework.boot.actuate.health.HealthIndicator;\r\nimport org.springframework.stereotype.Component;\r\n\r\n@Component\r\npublic class AppHealthIndicator implements HealthIndicator {\r\n\r\n  @Override\r\n  public Health health() {\r\n    return Health.down().build();\r\n  }\r\n}\r\n<\/pre>\n
When running again and accessing the “\/actuator\/health” API, my application will always return the status as DOWN.<\/p>\n
\"Introduction<\/p>\n
Next, we’ll talk about the “\/actuator\/info” API.<\/strong><\/p>\n
By default, if you do not enable environment variable information using property management.info.env.enabled<\/strong> and declare information about our application using some property names starting with “info”, then when accessing this API, no information is returned at all.<\/p>\n
\"Introduction<\/p>\n
But if I now enable to display the environment variable information:<\/p>\n
management.info.env.enabled=true<\/pre>\n
and configure some information for our example:<\/p>\n
info.app.name=Spring Boot Actuator\r\ninfo.app.description=An explanation about Spring Boot Actuator\r\ninfo.app.version=1.0.0<\/pre>\n
then when you run the application again and access the API “\/actuator\/info”, you will see the following results:<\/p>\n
\"Introduction<\/p>\n
By default, the base path of Actuator is “\/actuator”, you can change this base path using the property “management.endpoints.web.base-path”<\/strong>, for example, as follows:<\/p>\n
management.endpoints.web.base-path=\/monitor<\/pre>\n
My results are as follows:<\/p>\n
\"\"<\/p>\n\n\n
\n            \n
\n    \n
\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n    <\/div>\n    \n
\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n            
\n            \n\n
<\/div>\n        <\/div>\n    <\/div>\n<\/div>\n                \n\n
\n            <\/span>\n    <\/div>\n    <\/div>\n","protected":false},"excerpt":{"rendered":"
The Spring Boot Actuator is a Spring tool that allows us to monitor our application on a production environment without any code at all. It will expose the information about the application, its status, how the data relates to the application, etc. How is it… Read More<\/a><\/p>\n","protected":false},"author":1,"featured_media":1680,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[582],"tags":[1800],"class_list":["post-12940","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-spring-boot","tag-spring-boot-actuator-en","clearfix"],"yoast_head":"\nIntroduction to Spring Boot Actuator - Huong Dan Java<\/title>\n<meta name=\"description\" content=\"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Introduction to Spring Boot Actuator - Huong Dan Java\" \/>\n<meta property=\"og:description\" content=\"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html\" \/>\n<meta property=\"og:site_name\" content=\"Huong Dan Java\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/nhkhanh2406\" \/>\n<meta property=\"article:author\" content=\"https:\/\/www.facebook.com\/nhkhanh2406\" \/>\n<meta property=\"article:published_time\" content=\"2018-12-21T19:07:30+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-10-03T02:32:19+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png\" \/>\n\t<meta property=\"og:image:width\" content=\"300\" \/>\n\t<meta property=\"og:image:height\" content=\"300\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Khanh Nguyen\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@https:\/\/twitter.com\/KhanhNguyenJ\" \/>\n<meta name=\"twitter:site\" content=\"@KhanhNguyenJ\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Khanh Nguyen\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html\"},\"author\":{\"name\":\"Khanh Nguyen\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#\\\/schema\\\/person\\\/dc859d7f8cbea3b593e6738de9cbb82d\"},\"headline\":\"Introduction to Spring Boot Actuator\",\"datePublished\":\"2018-12-21T19:07:30+00:00\",\"dateModified\":\"2025-10-03T02:32:19+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html\"},\"wordCount\":514,\"commentCount\":1,\"publisher\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#\\\/schema\\\/person\\\/dc859d7f8cbea3b593e6738de9cbb82d\"},\"image\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2016\\\/10\\\/spring-boot.png\",\"keywords\":[\"Spring Boot Actuator\"],\"articleSection\":[\"Spring Boot\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html\",\"url\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html\",\"name\":\"Introduction to Spring Boot Actuator - Huong Dan Java\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2016\\\/10\\\/spring-boot.png\",\"datePublished\":\"2018-12-21T19:07:30+00:00\",\"dateModified\":\"2025-10-03T02:32:19+00:00\",\"description\":\"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#primaryimage\",\"url\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2016\\\/10\\\/spring-boot.png\",\"contentUrl\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2016\\\/10\\\/spring-boot.png\",\"width\":300,\"height\":300},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/introduction-to-spring-boot-actuator.html#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/huongdanjava.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction to Spring Boot Actuator\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#website\",\"url\":\"https:\\\/\\\/huongdanjava.com\\\/\",\"name\":\"Huong Dan Java\",\"description\":\"Java development tutorials\",\"publisher\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#\\\/schema\\\/person\\\/dc859d7f8cbea3b593e6738de9cbb82d\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/huongdanjava.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/#\\\/schema\\\/person\\\/dc859d7f8cbea3b593e6738de9cbb82d\",\"name\":\"Khanh Nguyen\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2021\\\/07\\\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg\",\"url\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2021\\\/07\\\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg\",\"contentUrl\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2021\\\/07\\\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg\",\"width\":1267,\"height\":1517,\"caption\":\"Khanh Nguyen\"},\"logo\":{\"@id\":\"https:\\\/\\\/huongdanjava.com\\\/wp-content\\\/uploads\\\/2021\\\/07\\\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg\"},\"description\":\"I love Java and everything related to Java.\",\"sameAs\":[\"https:\\\/\\\/huongdanjava.com\",\"https:\\\/\\\/www.facebook.com\\\/nhkhanh2406\",\"https:\\\/\\\/x.com\\\/https:\\\/\\\/twitter.com\\\/KhanhNguyenJ\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Introduction to Spring Boot Actuator - Huong Dan Java","description":"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html","og_locale":"en_US","og_type":"article","og_title":"Introduction to Spring Boot Actuator - Huong Dan Java","og_description":"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.","og_url":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html","og_site_name":"Huong Dan Java","article_publisher":"https:\/\/www.facebook.com\/nhkhanh2406","article_author":"https:\/\/www.facebook.com\/nhkhanh2406","article_published_time":"2018-12-21T19:07:30+00:00","article_modified_time":"2025-10-03T02:32:19+00:00","og_image":[{"width":300,"height":300,"url":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png","type":"image\/png"}],"author":"Khanh Nguyen","twitter_card":"summary_large_image","twitter_creator":"@https:\/\/twitter.com\/KhanhNguyenJ","twitter_site":"@KhanhNguyenJ","twitter_misc":{"Written by":"Khanh Nguyen","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#article","isPartOf":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html"},"author":{"name":"Khanh Nguyen","@id":"https:\/\/huongdanjava.com\/#\/schema\/person\/dc859d7f8cbea3b593e6738de9cbb82d"},"headline":"Introduction to Spring Boot Actuator","datePublished":"2018-12-21T19:07:30+00:00","dateModified":"2025-10-03T02:32:19+00:00","mainEntityOfPage":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html"},"wordCount":514,"commentCount":1,"publisher":{"@id":"https:\/\/huongdanjava.com\/#\/schema\/person\/dc859d7f8cbea3b593e6738de9cbb82d"},"image":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#primaryimage"},"thumbnailUrl":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png","keywords":["Spring Boot Actuator"],"articleSection":["Spring Boot"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#respond"]}]},{"@type":"WebPage","@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html","url":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html","name":"Introduction to Spring Boot Actuator - Huong Dan Java","isPartOf":{"@id":"https:\/\/huongdanjava.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#primaryimage"},"image":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#primaryimage"},"thumbnailUrl":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png","datePublished":"2018-12-21T19:07:30+00:00","dateModified":"2025-10-03T02:32:19+00:00","description":"In this tutorial, I introduce with you all about the Spring Boot Actuator with its supporting APIs.","breadcrumb":{"@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#primaryimage","url":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png","contentUrl":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2016\/10\/spring-boot.png","width":300,"height":300},{"@type":"BreadcrumbList","@id":"https:\/\/huongdanjava.com\/introduction-to-spring-boot-actuator.html#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/huongdanjava.com\/"},{"@type":"ListItem","position":2,"name":"Introduction to Spring Boot Actuator"}]},{"@type":"WebSite","@id":"https:\/\/huongdanjava.com\/#website","url":"https:\/\/huongdanjava.com\/","name":"Huong Dan Java","description":"Java development tutorials","publisher":{"@id":"https:\/\/huongdanjava.com\/#\/schema\/person\/dc859d7f8cbea3b593e6738de9cbb82d"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/huongdanjava.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":["Person","Organization"],"@id":"https:\/\/huongdanjava.com\/#\/schema\/person\/dc859d7f8cbea3b593e6738de9cbb82d","name":"Khanh Nguyen","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2021\/07\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg","url":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2021\/07\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg","contentUrl":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2021\/07\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg","width":1267,"height":1517,"caption":"Khanh Nguyen"},"logo":{"@id":"https:\/\/huongdanjava.com\/wp-content\/uploads\/2021\/07\/CC6FAC58-D227-4DD8-93D1-6D6A795577E3_1_201_a.jpeg"},"description":"I love Java and everything related to Java.","sameAs":["https:\/\/huongdanjava.com","https:\/\/www.facebook.com\/nhkhanh2406","https:\/\/x.com\/https:\/\/twitter.com\/KhanhNguyenJ"]}]}},"_links":{"self":[{"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/posts\/12940","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/comments?post=12940"}],"version-history":[{"count":11,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/posts\/12940\/revisions"}],"predecessor-version":[{"id":24599,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/posts\/12940\/revisions\/24599"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/media\/1680"}],"wp:attachment":[{"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/media?parent=12940"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/categories?post=12940"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/huongdanjava.com\/wp-json\/wp\/v2\/tags?post=12940"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}