Spring Boot 2 - Actuator Metrics Endpoint not working

Question

In my Spring Boot App (2.0.0.M7) application.properties I set

management.endpoint.metrics.enabled=true

However, when i hit

localhost:8080/actuator/metrics

I get 404.

Whats the solution?

score 78 · Answer 1 · edited Jul 09 '18 at 13:22

I would like to enhance the OP's answer with more information as I struggled a bit before finally stumbling upon this solution and there seem to be lots of confusion about changes to actuator behavior with Spring Boot 2

What hasn't changed

You need to include a dependency to spring-boot-starter-actuator

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

If you want to access actuator endpoints via HTTP, you also need to add a dependency to spring-boot-starter-web

So your pom dependencies will look like below

    <dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

Changes introduced in Spring Boot 2

Endpoints like /health, /metrics etc. are no longer available at the default root context. They are available from now on at http://{host}:{port}/actuator. Also, it doesn't matter whether your application's all other endpoints begin with some other context such as /hello -- actuator is available at /actuator and not at /hello/actuator.
Response from /actuator endpoint is by default HATEOAS enabled. Prior to Spring Boot 2, this was the case only if HATEOAS is on the classpath and explicitly enabled in application.yml
To make an actuator endpoint available via HTTP, it needs to be both enabled and exposed.

By default:
- only the /health and /info endpoints are exposed, regardless of Spring Security being present and configured in your application.
- all endpoints but /shutdown are enabled (though only /health and /info are exposed)
If you want to expose all of the endpoints (not always a good idea), you may do so by adding management.endpoints.web.exposure.include=* to application.properties. Don't forget to quote the wildcard if you're using yml-configurations.
Old properties starting with endpoints.xyz are deprecated in favor of properties starting with management.xyz

For a full documentation, see official doc and also the migration guide

Starting from spring-boot2, now is `management.endpoints.web.exposure.include=*` — fabdouglas, Apr 30 '18 at 11:36
In case of yaml configuration you need to quote the wildcard, otherwise it will fail to parse: `management.endpoints.web.exposure.include: '*'` — Timi, May 11 '18 at 13:23
I wander what is the use of the actuator if so much has been removed or disabled by default. I have the actuator in my project and the only thing useful is the health status and even that is questionable. Something is running or not and if down then the heartbeat disappears. The info url creates an empty json. So why use it at all? — Martijn Hiemstra, Dec 22 '18 at 09:23
Nothing much is removed. Sensitive endpoints are disabled by default for some good reason — senseiwu, Jan 03 '19 at 16:56
this makes sense but it annoys me the latest documentation says the opposite https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints-enabling-endpoints — Chad, May 18 '20 at 20:21

score 19 · Answer 2 · edited Oct 30 '18 at 17:59

19

Add the following line to your application.properties file:

management.endpoints.web.exposure.include=metrics

That's all.

edited Oct 30 '18 at 17:59

Bonifacio2

2,687
4
30
44

answered May 04 '18 at 11:38

Jeen

281
3
4

2

Also `management.endpoints.web.exposure.include=*` worked for me – Vladyslav Nikolaiev Mar 05 '20 at 15:07

score 10 · Answer 3 · answered Mar 27 '18 at 11:53

10

What worked for me is the following (in YAML format) working with spring boot 2 release:

management:
  endpoints:
    web:
      exposure:
        include: info, health, metrics
  metrics:
    export:
      atlas:
        enabled: false

also specific documentation can be found here

answered Mar 27 '18 at 11:53

tbo

7,760
6
35
46

2

When I use this, the /metrics endpoint works, but shows only the keys, not the values. What up??? – djangofan Sep 14 '18 at 02:39
1

yes this is how it works you then select a metric to display instead of having all metrics displayed in a messy single page, also useful for other apps like prometheus or atlas to read the metrics – tbo Sep 21 '18 at 13:48

score 7 · Answer 4 · answered Mar 23 '19 at 15:24

7

"*" has a special meaning in YAML, so be sure to add quotes if you want to include (or exclude) all endpoints, as shown in the following example:

management:
  endpoints:
    web:
      exposure:
        include: "*"

answered Mar 23 '19 at 15:24

Dilan

1,259
5
14
21

score 6 · Answer 5 · edited Jan 10 '19 at 05:59

6

You need to add the below props in your application.properties file. I had the same issue until I added the below props.

management.endpoints.beans.enabled=false
management.endpoints.web.exposure.include=*

edited Jan 10 '19 at 05:59

Sage Pourpre

6,335
2
21
32

answered Jan 10 '19 at 05:09

Krish

165
2
3
6

score 6 · Answer 6 · answered Apr 15 '19 at 10:16

6

Had the same issue upgrading from Spring Boot 1.5.15 to 2.1.4

Needed to modify the original dependency for the Spring Boot actuator in my pom.xml from:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-actuator</artifactId>
</dependency>

to:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

notice the addition of the word starter in the artifactId.

answered Apr 15 '19 at 10:16

disposedtrolley

152
1
6

Hi! Thanks for sharing! What is the difference between `enabled` and `exposed`? Thanks! – fongfong Mar 30 '20 at 21:14
This was rather infuriating since either one seems to build fine -- but the first silently fails to work. – Brent Bradburn Apr 29 '21 at 19:01

score 3 · Answer 7 · edited Oct 13 '18 at 19:45

3

According micrometer docs .Spring Boot 2.0.x supports Micrometer out of the box via Spring Boot Actuator.
The endpoint metric is disabled by default, in line with Spring Boot 2’s litmus test that any endpoint that potentially exposes sensitive data about an application should be disabled by default. It can be enabled by setting:

management.endpoints.web.exposure.include: metrics

Navigating to /actuator/metrics displays a list of available meter names.

To access them, use something like this: http://localhost:8080/actuator/metrics/jvm.memory.used

edited Oct 13 '18 at 19:45

dkb

3,238
3
26
41

answered Feb 09 '18 at 07:07

makson

1,056
3
12
26

Only this one worked for me for ```application.properties``` by specifying ```management.endpoints.web.exposure.include=metrics``` – Poli May 28 '21 at 06:34

score 2 · Answer 8 · answered Jan 29 '18 at 14:33

Okay i found the solution. I have added another line in application.properties

management.endpoints.web.expose=*

However, securing the actuator endoints is important

Read here: https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-monitoring.html

score 0 · Answer 9 · answered Oct 06 '19 at 02:58

0

The following configuration works for me

server.servlet.context-path=/travel management.endpoints.web.exposure.include=*

Then you need to add context path: http://localhost:8080/travel/actuator/metrics/

answered Oct 06 '19 at 02:58

Vikki

1,317
1
10
18

score 0 · Answer 10 · edited Dec 31 '19 at 12:29

0

management:
  endpoints:
    web:
      base-path: "/"
      exposure:
        include: '*'

it should works like that. * means expose all endpoints

edited Dec 31 '19 at 12:29

Lucifer

1,556
2
15
28

answered Dec 31 '19 at 09:50

mo rabah ouagoughi

56
2

score 0 · Answer 11 · answered Mar 07 '20 at 13:46

As @senseiwu mentioned, Unlike the previous versions, Actuator in spring boot 2 comes with most endpoints disabled. Would we want to enable all of them, we could set

management.endpoints.web.exposure.include=*

Alternatively, we could list endpoints that should be enabled.

You can easily use hal-browser which is a useful UI, mapped to "/" path by adding following dependencies:

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-rest-hal-browser</artifactId>
</dependency>

In the hal-browser you need to type /actuator to see all endpoints. It has been tested in Spring Boot 2.3.0.M2 and works perfectly. You can learn more in the following links:

Spring REST and HAL Browser

Spring Boot Actuator

score 0 · Answer 12 · answered Aug 20 '20 at 11:52

0

Adding the below property in application.properties solved the issues for me:

management.health.defaults.enabled=false

answered Aug 20 '20 at 11:52

KayV

9,560
8
68
111

score 0 · Answer 13 · answered Apr 15 '21 at 17:57

Put here the full config for micrometer. The following one is working fine for me. I use it for ELK stack

management:
  metrics:
    enable:
      jvm: true
      all: true
    export:
      elastic:
        enables: true
        step: 10s
        index: micrometer-${spring.application.name}
        host: http://localhost:9200
      simple:
        enabled: true
    distribution:
      percentiles-histogram:
        http:
          server:
            requests: true
      sla:
        http:
          server:
            requests: 100ms, 400ms, 500ms, 2000ms
      percentiles:
        http:
          server:
            requests: 0.5, 0.9, 0.95, 0.99
  endpoint:
    metrics:
      enabled: true
  endpoints:
    web:
      exposure:
        include: '*'

Spring Boot 2 - Actuator Metrics Endpoint not working

13 Answers13

Linked