Custom actuator endpoints in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a custom actuator endpoint in Spring Boot?

A custom actuator endpoint is a user-defined feature that exposes specific application information or operations through HTTP or JMX, extending the built-in actuator endpoints.

beginner

Which annotation is used to create a custom actuator endpoint in Spring Boot?

The @Endpoint annotation is used to define a custom actuator endpoint class in Spring Boot.

intermediate

How do you expose a read operation in a custom actuator endpoint?

You use the @ReadOperation annotation on a method inside the @Endpoint class to expose a read-only operation accessible via HTTP GET.

intermediate

What is the purpose of the @WriteOperation annotation in a custom actuator endpoint?

The @WriteOperation annotation marks a method that performs a write or change operation, accessible via HTTP POST.

intermediate

How do you register a custom actuator endpoint bean in Spring Boot?

You register the custom endpoint as a Spring bean, typically by annotating the class with @Component or defining it in a configuration class.

Which annotation defines a custom actuator endpoint class in Spring Boot?

A @Service

B @RestController

C @Component

D @Endpoint

The @Endpoint annotation is specifically used to define custom actuator endpoints.

Which annotation exposes a read-only operation in a custom actuator endpoint?

A @ReadOperation

B @WriteOperation

C @DeleteOperation

D @PostMapping

@ReadOperation marks a method as a read-only operation accessible via HTTP GET.

How do you make a custom actuator endpoint available in your Spring Boot app?

A Add it to application.properties

B Register it as a Spring bean

C Use @RestController only

D No registration needed

Custom endpoints must be registered as Spring beans to be recognized.

Which HTTP method is typically used with @WriteOperation in custom actuator endpoints?

A GET

B DELETE

C POST

D PUT

@WriteOperation methods are exposed via HTTP POST to perform changes.

What is the main benefit of creating custom actuator endpoints?

A To add custom monitoring or management features

B To replace all default endpoints

C To disable actuator completely

D To improve UI design

Custom endpoints let you add specific monitoring or management features tailored to your app.

Explain how to create and expose a custom actuator endpoint in Spring Boot.

Think about annotations and bean registration.

Describe the difference between @ReadOperation and @WriteOperation in custom actuator endpoints.

Consider HTTP methods and operation types.