Enable component

To enable Blueriq Actuators add the Spring profile named actuator in file bootstrap.properties. For example:

 spring.profiles.active=native,actuator

Context path

The default path for Blueriq Actuators is /actuator. This can be changed to a different path with the management.endpoints.web.base-path property:

management.endpoints.web.base-path=/somethingElse

If the runtime is accessible via https://localhost:8080/Runtime, the actuators can be found at https://localhost:8080/Runtime/actuator by default, or at http://localhost:8080/Runtime/somethingElse if the property above would be set.

Exposing endpoints

All enabled endpoints are available through both JMX and HTTP. (except for the logfile endpoint, which is only available through HTTP). You should limit the access to the endpoint to not be accessible from the public network. To customize this, you can change the following properties.

So for instance to disable exposing all the endpoints but the health endpoint via JMX, add the following property.

management.endpoints.jmx.exposure.include=health

In this example all endpoints are still exposed via HTTP.

Default security

By default all actuators are secured using basic authentication with the user below. You can override this, please keep in mind that the user must have the role 'ACTUATOR'.

spring.security.user.name=blueriq
spring.security.user.password={noop}welcome
spring.security.user.roles=ACTUATOR

Enable/disable default security

When more control over the security of individual endpoints is required, a custom implementation can be written.
For this, you first need to disable the default security for the actuators. This can be done by setting the property blueriq.security.actuator.enabled in application-actuator.properties:

# Security
blueriq.security.actuator.enabled=false

Implementing custom security for actuator endpoints

Then you can implement custom your own security logic. In the following example, the endpoints actuator/health and actuator/info are available to everyone, but the CUSTOM_ROLE is required to access the other actuator endpoints. This can be done by disabling the default security for actuator, and implement your own custom security configuration like in the example below.

@Configuration
@ConditionalOnProperty(name = "blueriq.security.actuator.enabled", havingValue = "false", matchIfMissing = false)
public class CustomMetricsApiSecurityConfiguration {
 
  @Bean
  @Order(1) // before runtime security configurations
  protected SecurityFilterChain customActuatorSecurityChain(HttpSecurity http, WebEndpointProperties webEndpointProperties) throws Exception {
    return http.securityMatcher(new AntPathRequestMatcher(webEndpointProperties.getBasePath() + "/**"))
        .authorizeHttpRequests(auth -> {
          auth.requestMatchers(EndpointRequest.to(HealthEndpoint.class, InfoEndpoint.class)).permitAll();
          auth.requestMatchers(EndpointRequest.toAnyEndpoint()).hasRole("CUSTOM_ROLE");
        })
        .build();
  }
}

Enable/Disable individual endpoints

Each endpoint can be enabled or disabled via a property with the format management.endpoint.[endpoint-id].enabled=true/false

# Enable all endpoints
management.endpoints.enabled-by-default=true

Actuator Endpoints

For a complete overview of the standard Spring Boot Actuator web API, which described example request and responses for all actuator endpoints, have a look at the documentation.

Info

The standard info 

GET http://localhost:92/Runtime/actuator/info

{
    "exceptions": [
        {
            "cause": null,
            "stackTrace": [
                {
                    "methodName": "getInternalFlow",
                    "fileName": "FlowEngine.java",
                    "lineNumber": 269,
                    "className": "com.aquima.interactions.flow.model.FlowEngine",
                    "nativeMethod": false
                },
                {
                    "methodName": "startFlow",
                    "fileName": "FlowEngine.java",
                    "lineNumber": 130,
                    "className": "com.aquima.interactions.flow.model.FlowEngine",
                    "nativeMethod": false
                }
... 
            ],
            "flowName": "main",
            "message": "Unknown flow: main",
            "localizedMessage": "Unknown flow: main",
            "suppressed": []
        }
    ]
}

Metrics

Navigating to /Runtime/actuator/metrics displays a list of available metrics. You can drill down to view information about a particular metric by providing its name as a selector, e.g. /actuator/metrics/jvm.memory.max

GET http://localhost:92/Runtime/actuator/metrics

{
"names": [
	"jvm.buffer.memory.used",
	"jvm.memory.used",
	"jvm.gc.memory.allocated",
	"jvm.memory.committed",
	"jvm.gc.max.data.size",
	"logback.events",
	"system.cpu.count",
	"runtime.session.counter",
	"jvm.memory.max",
	"jvm.buffer.total.capacity",
	"jvm.buffer.count",
	"jvm.threads.daemon",
	"process.start.time",
	"runtime.average.compose.time",
	"runtime.request.counter",
	"jvm.gc.live.data.size",
	"process.cpu.usage",
	"jvm.gc.pause",
	"process.uptime",
	"runtime.average.event.time",
	"runtime.exceptions.counter",
	"http.server.requests",
	"system.cpu.usage",
	"jvm.threads.live",
	"jvm.threads.peak",
	"jvm.gc.memory.promoted"
]
}

Blueriq specific metrics

The following Runtime specific metrics are available.

Blueriq specific endpoints

With the endpoints below you can reset some of the Blueriq specific metrics provided by the metrics endpoint.

Reset Runtime Requests

POST http://localhost:92/Runtime/actuator/runtimeResetRequestCount

runtime.request.counter was reset

Reset Portal-Session Exceptions

POST http://localhost:92/Runtime/actuator/portalSessionResetExceptions

runtime.exceptions.counter was reset

Reset Portal-Session Compose Time

POST http://localhost:92/Runtime/actuator/portalSessionResetComposeTime

gauge.portal-session.page.compose.average-time was reset

Reset Portal-Session Handle-Event Time

POST http://localhost:92/Runtime/actuator/portalSessionResetHandleEvent

gauge.response.portal-session.handle-event was reset