org.springframework.boot.actuate.endpoint.annotation

Annotation Type Endpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface Endpoint

Identifies a type as being an actuator endpoint that provides information about the running application. Endpoints can be exposed over a variety of technologies including JMX and HTTP.

Most @Endpoint classes will declare one or more @ReadOperation, @WriteOperation, @DeleteOperation annotated methods which will be automatically adapted to the exposing technology (JMX, Spring MVC, Spring WebFlux, Jersey etc.).

@Endpoint represents the lowest common denominator for endpoints and intentionally limits the sorts of operation methods that may be defined in order to support the broadest possible range of exposure technologies. If you need deeper support for a specific technology you can either write an endpoint that is filtered to a certain technology, or provide extension for the broader endpoint.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

See Also:

EndpointExtension, FilteredEndpoint, EndpointDiscoverer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	enableByDefault If the endpoint should be enabled or disabled by default.
String	id The id of the endpoint (must follow EndpointId rules).

Element Detail

id

public abstract String id

The id of the endpoint (must follow EndpointId rules).

Returns:

the id

See Also:

EndpointId

Default:

""

enableByDefault

public abstract boolean enableByDefault

If the endpoint should be enabled or disabled by default.

Returns:

true if the endpoint is enabled by default

Default:

true