All properties

Every property the actuator reads, grouped by prefix. The keys are Spring Boot's. spring_boot_actuator holds the property classes of the endpoints (HealthEndpointProperties, ManagementHealthProperties, ManagementInfoProperties, EndpointsProperties, ProjectInfoProperties); spring_boot_starter_actuator adds WebEndpointProperties. Both produce editor metadata from them.

Why

The actuator is configured entirely with properties. This page lists every key, so you can check a name, its default and its allowed values in one place.

Example

A server behind Kubernetes, with an admin-only view of the details:

# lib/resources/application.yml
management:
  endpoints:
    web:
      base-path: /actuator
      exposure:
        include: health,info,mappings
      path-mapping:
        health: health
    access:
      default: read-only
  endpoint:
    health:
      show-details: when-authorized
      show-components: always
      roles: ADMIN
      status:
        order: fatal,down,out-of-service,unknown,up
        http-mapping:
          fatal: 500
      group:
        core:
          include: ping,db
          show-details: always
          additional-path: "server:/healthz"
      probes:
        enabled: true
        add-additional-paths: true
      logging:
        slow-indicator-threshold: 5s
    mappings:
      access: none
  health:
    diskspace:
      path: /srv/shop
      threshold: 500MB
  info:
    env:
      enabled: true
    git:
      mode: full
spring:
  info:
    git:
      location: file:./git.properties
info:
  app:
    team: neon-books
# lib/resources/application.properties: the same
management.endpoints.web.base-path=/actuator
management.endpoints.web.exposure.include=health,info,mappings
management.endpoints.web.path-mapping.health=health
management.endpoints.access.default=read-only
management.endpoint.health.show-details=when-authorized
management.endpoint.health.show-components=always
management.endpoint.health.roles=ADMIN
management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up
management.endpoint.health.status.http-mapping.fatal=500
management.endpoint.health.group.core.include=ping,db
management.endpoint.health.group.core.show-details=always
management.endpoint.health.group.core.additional-path=server:/healthz
management.endpoint.health.probes.enabled=true
management.endpoint.health.probes.add-additional-paths=true
management.endpoint.health.logging.slow-indicator-threshold=5s
management.endpoint.mappings.access=none
management.health.diskspace.path=/srv/shop
management.health.diskspace.threshold=500MB
management.info.env.enabled=true
management.info.git.mode=full
spring.info.git.location=file:./git.properties
info.app.team=neon-books

Writing values

management.endpoints.web.*: exposure and paths (spring_boot_starter_actuator)

Key Type Default Meaning
management.endpoints.web.base-path path /actuator Where the endpoints are; / puts them at the root, without the discovery page → Endpoints
management.endpoints.web.exposure.include List<String> health The ids exposed over HTTP; * for all
management.endpoints.web.exposure.exclude List<String> none The ids not exposed; wins over include
management.endpoints.web.path-mapping.<id> path the id Another path of an endpoint
management.endpoints.web.discovery.enabled bool true The base path answers the _links of the exposed endpoints

management.endpoints.* and management.endpoint.<id>.*: enabling

Key Type Default Meaning
management.endpoint.<id>.access none / read-only / unrestricted none Spring Boot 3.4's switch; none disables the endpoint. Wins over enabled
management.endpoint.<id>.enabled bool the endpoint's default (true for health, info, mappings) Whether the endpoint exists
management.endpoints.access.default none / read-only / unrestricted none The access of every endpoint without its own
management.endpoints.enabled-by-default bool none The default of every management.endpoint.<id>.enabled

<id> is health, info, mappings, jsonschemas, isolates, qps or the id of an endpoint of your own. See Endpoints.

management.endpoint.health.*: the health endpoint

Key Type Default Meaning
management.endpoint.health.show-details Show never Who sees the indicators' details → Health
management.endpoint.health.show-components Show as show-details Who sees the components by name
management.endpoint.health.roles List<String> empty: any logged-in user The roles when-authorized asks for (any one); ADMIN matches ROLE_ADMIN
management.endpoint.health.status.order List<String> down, out-of-service, up, unknown The statuses from the most severe; the first one of the parts is the aggregate
management.endpoint.health.status.http-mapping.<status> int down and out-of-service: 503; others 200 The HTTP status of a health status
management.endpoint.health.group.<name>.include List<String> all The members of the group at /actuator/health/<name>; db/primary for a part of a composite
management.endpoint.health.group.<name>.exclude List<String> none Members left out
management.endpoint.health.group.<name>.show-details Show the endpoint's Who sees the group's details
management.endpoint.health.group.<name>.show-components Show the group's show-details Who sees the group's components
management.endpoint.health.group.<name>.roles List<String> the endpoint's The roles of the group's when-authorized
management.endpoint.health.group.<name>.status.order List<String> the endpoint's The group's aggregation
management.endpoint.health.group.<name>.status.http-mapping.<status> int the endpoint's The group's HTTP codes
management.endpoint.health.group.<name>.additional-path server:/path none The group also at that path of the main server
management.endpoint.health.probes.enabled bool false; true on Kubernetes and Cloud Foundry The liveness and readiness groups, with their indicators
management.endpoint.health.probes.add-additional-paths bool false The probes also at /livez and /readyz
management.endpoint.health.validate-group-membership bool true A group naming a contributor that does not exist stops the start
management.endpoint.health.logging.slow-indicator-threshold Duration 10s An indicator slower than this is logged as a warning
management.endpoint.health.enabled, .access See enabling, above

management.health.*: the indicators

Key Type Default Meaning
management.health.defaults.enabled bool true The default of every indicator's enabled
management.health.ping.enabled bool defaults.enabled The ping indicator, always UP
management.health.diskspace.enabled bool defaults.enabled The diskSpace indicator
management.health.diskspace.path path . The path whose file system is checked
management.health.diskspace.threshold DataSize 10MB The least free space that is UP
management.health.db.enabled bool defaults.enabled The db indicator of spring_boot_starter_data
management.health.livenessstate.enabled bool false The livenessState indicator without the probes
management.health.readinessstate.enabled bool false The readinessState indicator without the probes
management.health.<name>.enabled bool defaults.enabled An indicator of a library, with @ConditionalOnEnabledHealthIndicator('<name>')

management.info.*: the info contributors

Key Type Default Meaning
management.info.defaults.enabled bool true The default of build and git → Info
management.info.build.enabled bool defaults.enabled The build contributor, when its file exists
management.info.git.enabled bool defaults.enabled The git contributor, when its file exists
management.info.git.mode simple / full simple The branch, short commit id and time, or every key
management.info.env.enabled bool false The info.* properties, without the prefix
management.info.os.enabled bool false The operating system
management.info.dart.enabled bool false The Dart version (Spring Boot's java)
management.info.<id>.enabled bool A contributor of a library, with @ConditionalOnEnabledInfoContributor('<id>')

spring.info.*: the project information files

Key Type Default Meaning
spring.info.build.location location resources:build-info.properties The build's build.* keys (Spring Boot: classpath:META-INF/build-info.properties)
spring.info.build.encoding UTF-8 / ISO-8859-1 UTF-8 Its encoding
spring.info.git.location location resources:git.properties The git.* keys
spring.info.git.encoding UTF-8 / ISO-8859-1 UTF-8 Its encoding

info.*

Key Type Default Meaning
info.<anything> any none Free details, shown under their key (without info.) when management.info.env.enabled=true

Properties of other packages the actuator uses

Key Package Effect
spring.application.name spring_boot_dart The context's name in mappings
spring.main.cloud-platform spring_core_dart Kubernetes or Cloud Foundry turns the probes on
server.port, server.context-path spring_boot_starter_web Where the endpoints answer
spring.web.debug.qps.enabled spring_boot_starter_web Read by the build: true puts the qps endpoint into the application, with the code that counts the requests → Requests per second
server.isolates.* spring_boot_starter_web With a pool of isolates isolates and qps answer for the whole application from any isolate; the other endpoints answer for the isolate that takes the request → Isolates

Not supported yet

management.server.* (a port of the endpoints' own), management.endpoints.web.cors.*, management.endpoints.jmx.*, management.metrics.*, management.tracing.*, and Spring Boot's endpoints other than health, info and mappings.

See also