Info endpoint configuration in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Info endpoint in Spring Boot Actuator?

The Info endpoint provides custom application information such as version, description, or build details. It helps monitor app metadata easily.

beginner

How do you add custom information to the Info endpoint in Spring Boot?

You add custom info by defining properties under management.info in application.properties or application.yml. For example, management.info.app.name=MyApp.

intermediate

Which file is commonly used to add build or git info to the Info endpoint automatically?

The build-info.properties file generated by the Spring Boot Maven or Gradle plugin can be used. It adds build details like version and time to the Info endpoint.

beginner

How do you enable the Info endpoint if it is disabled by default?

Set management.endpoint.info.enabled=true in your configuration file to enable the Info endpoint.

beginner

What is the default URL path to access the Info endpoint in Spring Boot Actuator?

The default URL path is /actuator/info. Accessing this returns the configured info data in JSON format.

Where do you configure custom info properties for the Info endpoint?

A In the static resources folder

B In the main application class

C Under management.info in application.properties or application.yml

D In the database configuration

Custom info properties are set under management.info in configuration files.

What plugin helps generate build-info.properties for the Info endpoint?

A JUnit plugin

B Spring Boot Maven or Gradle plugin

C Hibernate plugin

D Docker plugin

Spring Boot Maven or Gradle plugin can generate build-info.properties automatically.

What is the default path to access the Info endpoint?

A /api/info

B /info

C /management/info

D /actuator/info

The Info endpoint is available by default at /actuator/info.

How do you enable the Info endpoint if it is disabled?

A Set management.endpoint.info.enabled=true

B Restart the server twice

C Add @EnableInfoEndpoint annotation

D No need to enable, always active

You enable the Info endpoint by setting management.endpoint.info.enabled=true.

Which of these is NOT a typical use of the Info endpoint?

A Exposing sensitive user data

B Showing app version and build info

C Providing app description

D Displaying git commit details

The Info endpoint should not expose sensitive user data.

Explain how to add and expose custom application information using the Spring Boot Info endpoint.

Think about configuration files and endpoint URLs.

Describe how build and git information can be automatically included in the Info endpoint output.

Consider build tools and generated files.

Practice

1. What is the primary purpose of the info endpoint in a Spring Boot application?

easy

A. To provide application metadata like version and description

B. To expose database query results

C. To handle user authentication

D. To serve static web content

Solution

1. Step 1: Understand the role of the info endpoint

   The info endpoint is designed to share metadata about the application, such as version, description, or build info.

2. Step 2: Compare with other endpoint purposes

   Unlike authentication or serving static content, info is specifically for metadata exposure.

3. Final Answer:

   To provide application metadata like version and description -> Option A

4. Quick Check:

   Info endpoint = app metadata [OK]

Hint: Info endpoint shares app details, not data or auth [OK]

Common Mistakes:

• Confusing info endpoint with security or data endpoints
• Thinking it serves static files
• Assuming it handles user login

2. Which property correctly enables the info endpoint in Spring Boot's application.properties file?

easy

A. info.endpoint.management.enabled=true

B. spring.info.endpoint.enabled=true

C. management.endpoint.info.enabled=true

D. management.info.enabled=true

Solution

1. Step 1: Recall the correct property prefix for management endpoints

   Spring Boot uses management.endpoint.{name}.enabled to enable endpoints.

2. Step 2: Match the property for info endpoint

   For the info endpoint, it is management.endpoint.info.enabled.

3. Final Answer:

   management.endpoint.info.enabled=true -> Option C

4. Quick Check:

   Enable info endpoint = management.endpoint.info.enabled [OK]

Hint: Use management.endpoint.info.enabled to enable info [OK]

Common Mistakes:

• Using spring.info.endpoint.enabled which is invalid
• Mixing property order or names
• Using management.info.enabled which is incorrect

3. Given this application.properties snippet:

management.endpoints.web.exposure.include=info,health
spring.info.app.name=MyApp
spring.info.app.version=1.2.3

What will the /actuator/info endpoint return?

medium

A. {"application":{"name":"MyApp","version":"1.2.3"}}

B. {"app":{"name":"MyApp","version":"1.2.3"}}

C. {"appName":"MyApp","appVersion":"1.2.3"}

D. {"info":{"name":"MyApp","version":"1.2.3"}}

Solution

1. Step 1: Understand spring.info property mapping

   Properties under spring.info.* appear as nested JSON keys matching their structure. Here, spring.info.app.name and spring.info.app.version create an "app" object.

2. Step 2: Check the JSON structure returned by /actuator/info

   The info endpoint returns JSON with keys matching the spring.info hierarchy, so it returns {"app":{"name":"MyApp","version":"1.2.3"}}.

3. Final Answer:

   {"app":{"name":"MyApp","version":"1.2.3"}} -> Option B

4. Quick Check:

   spring.info.app.* -> JSON key "app" [OK]

Hint: spring.info.app.name -> JSON key 'app' with nested fields [OK]

Common Mistakes:

• Assuming keys are renamed to 'info' or 'application'
• Expecting flat JSON without nesting
• Confusing property names with JSON keys

4. You added management.endpoint.info.enabled=true but /actuator/info still returns 404. What is the most likely cause?

medium

A. The property name is misspelled as management.endpoint.info.enable

B. The actuator dependency is not added

C. The application.properties file is missing

D. The info endpoint is not included in management.endpoints.web.exposure.include

Solution

1. Step 1: Check endpoint exposure settings

   Even if the info endpoint is enabled, it must be exposed over HTTP by including it in management.endpoints.web.exposure.include.

2. Step 2: Verify exposure includes 'info'

   If 'info' is missing from the exposure list, the endpoint returns 404 despite being enabled.

3. Final Answer:

   The info endpoint is not included in management.endpoints.web.exposure.include -> Option D

4. Quick Check:

   Enable + expose info endpoint = no 404 [OK]

Hint: Enable and expose info endpoint to avoid 404 [OK]

Common Mistakes:

• Only enabling endpoint without exposing it
• Misspelling property names
• Assuming actuator dependency is always missing

5. You want to add custom build info to the info endpoint using spring.info.build.* properties and expose it. Which configuration snippet correctly achieves this?

hard

A. management.endpoint.info.enabled=true
management.endpoints.web.exposure.include=info
spring.info.build.version=2.0.1
spring.info.build.time=2024-06-01T12:00:00Z

B. management.endpoints.web.exposure.include=info
spring.info.build.version=2.0.1
spring.info.build.time=2024-06-01T12:00:00Z

C. management.endpoint.info.enabled=true
spring.info.build.version=2.0.1
management.endpoints.web.exposure.include=health

D. spring.info.build.version=2.0.1
management.endpoint.info.enabled=false
management.endpoints.web.exposure.include=info

Solution

1. Step 1: Enable the info endpoint

   Set management.endpoint.info.enabled=true to activate the info endpoint.

2. Step 2: Expose the info endpoint over HTTP

   Include 'info' in management.endpoints.web.exposure.include to make it accessible.

3. Step 3: Add custom build info properties

   Use spring.info.build.version and spring.info.build.time to add custom metadata.

4. Final Answer:

   management.endpoint.info.enabled=true management.endpoints.web.exposure.include=info spring.info.build.version=2.0.1 spring.info.build.time=2024-06-01T12:00:00Z -> Option A

5. Quick Check:

   Enable + expose + add spring.info.build.* = correct config [OK]

Hint: Enable, expose info, add spring.info.build.* properties [OK]

Common Mistakes:

• Forgetting to expose info endpoint
• Disabling info endpoint accidentally
• Exposing wrong endpoints like only health