Monitoring / Statistics

Actuator endpoints used to monitor and diagnose the internal configuration of the CAS server are typically exposed over the endpoint /actuator.

:information_source: Definition of Actuator

This is not a CAS term and the concept comes from Spring Boot. An actuator is a manufacturing term that refers to a mechanical device for moving or controlling something. Actuators can generate a large amount of motion from a small change.

Actuator Endpoints

The following actuator endpoints are provided:

Actuator Reference
/actuator/auditevents See this guide.
/actuator/beans See this guide.
/actuator/caches See this guide.
/actuator/conditions See this guide.
/actuator/configprops See this guide.
/actuator/env See this guide.
/actuator/health See this guide.
/actuator/heapdump See this guide.
/actuator/httpexchanges See this guide.
/actuator/httptrace See this guide.
/actuator/info See this guide.
/actuator/logfile See this guide.
/actuator/loggers See this guide.
/actuator/mappings See this guide.
/actuator/metrics See this guide.
/actuator/prometheus See this guide.
/actuator/quartz See this guide.
/actuator/scheduledtasks See this guide.
/actuator/startup See this guide.
/actuator/startup See this guide.
/actuator/threaddump See this guide.
:information_source: Usage

Note that the above table is not a comprehensive list of all possible actuator endpoints in CAS. Each CAS module may present and activate a different set of actuator endpoints specific to a feature such as SSO session management, application registration, and more. Please see the specific documentation for the feature you need to get more details.

Metrics

Metrics allow to gain insight into the running CAS software, and provide ways to measure the behavior of critical components. See this guide for more info.