Actuator endpoints

Introduction

Actuator endpoints provide real-time insights and management capabilities. These endpoints expose information about your application's health, metrics, and various operational aspects. This documentation will guide you on how to add a user and how to call these endpoints.

How to add a user

Only users with role ROLE_actuator can access endpoints. To add a user, follow these steps:

Step 1, Add the user with a ROLE_actuator role to maintenance-users.properties. This will add user with username "blueriq" and password "welcome" and assign the role ROLE_actuator to it.

blueriq={noop}welcome,ROLE_actuator

Step 2, Add the user.properties file to the configuration blueriq-dcm-maintenance-app.yml

blueriq:
  dcm:
    maintenance:
      app:
        users:
          file: ${spring.config.additional-location}maintenance-users.properties

How to call endpoints

The actuator endpoint can be called using HTTP protocol:

Make sure to replace "{url}" with application domain.

GET http://{url}/dcm-maintenance/actuator/health
Authorization: Basic blueriq welcome