Monitor server health
Because IDM is highly modular and configurable, it is often difficult to assess whether a system has started up successfully, or whether the system is ready and stable after dynamic configuration changes have been made.
The health check service lets you monitor the status of internal resources.
To monitor the status of external resources such as LDAP servers and external databases, use the commands described in Check external system status over REST.
Basic health checks
The health check service reports on the state of the server and outputs this state to the OSGi console and to the log files. The server can be in one of the following states:
-
STARTING- the server is starting up -
ACTIVE_READY- all of the specified requirements have been met to consider the server ready -
ACTIVE_NOT_READY- one or more of the specified requirements have not been met and the server is not considered ready -
STOPPING- the server is shutting down
To verify the current server state, use the following REST call:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request GET \
"http://localhost:8080/openidm/info/ping"
{
"_id": "",
"_rev": "",
"shortDesc": "OpenIDM ready",
"state": "ACTIVE_READY"
}
Session information
To obtain information about the current IDM session, beyond basic health checks, use the following REST call:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request GET \
"http://localhost:8080/openidm/info/login"
{
"_id": "login",
"authenticationId": "openidm-admin",
"authorization": {
"userRolesProperty": "authzRoles",
"component": "internal/user",
"authLogin": false,
"authenticationIdProperty": "username",
"roles": [
"internal/role/openidm-admin",
"internal/role/openidm-authorized"
],
"ipAddress": "0:0:0:0:0:0:0:1",
"authenticationId": "openidm-admin",
"id": "openidm-admin",
"moduleId": "INTERNAL_USER",
"queryId": "credential-internaluser-query"
}
}
|
The precise output of this command will depend on the authentication module responsible for authenticating the user. For more information about authentication modules, see Authentication and Session Modules |
Health check service
The configurable health check service verifies the status of the modules and services required for an operational system. During system startup, IDM checks that these modules and services are available and reports on any requirements that have not been met. If dynamic configuration changes are made, IDM rechecks that the required modules and services are functioning, to allow ongoing monitoring of system operation.
Examples of Required Modules
IDM checks all required modules. Examples of those modules are shown here:
"org.forgerock.openicf.framework.connector-framework" "org.forgerock.openicf.framework.connector-framework-internal" "org.forgerock.openicf.framework.connector-framework-osgi" "org.forgerock.openidm.audit" "org.forgerock.openidm.core" "org.forgerock.openidm.enhanced-config" "org.forgerock.openidm.external-email" ... "org.forgerock.openidm.system" "org.forgerock.openidm.ui" "org.forgerock.openidm.util" "org.forgerock.commons.org.forgerock.json.resource" "org.forgerock.commons.org.forgerock.util" "org.forgerock.openidm.security-jetty" "org.forgerock.openidm.jetty-fragment" "org.forgerock.openidm.quartz-fragment" "org.ops4j.pax.web.pax-web-extender-whiteboard" "org.forgerock.openidm.scheduler" "org.ops4j.pax.web.pax-web-jetty" "org.forgerock.openidm.repo-jdbc" "org.forgerock.openidm.repo-ds" "org.forgerock.openidm.config" "org.forgerock.openidm.crypto"
Examples of Required Services
IDM checks all required services. Examples of those services are shown here:
"org.forgerock.openidm.config" "org.forgerock.openidm.provisioner" "org.forgerock.openidm.provisioner.openicf.connectorinfoprovider" "org.forgerock.openidm.external.rest" "org.forgerock.openidm.audit" "org.forgerock.openidm.policy" "org.forgerock.openidm.managed" "org.forgerock.openidm.script" "org.forgerock.openidm.crypto" "org.forgerock.openidm.recon" "org.forgerock.openidm.info" "org.forgerock.openidm.router" "org.forgerock.openidm.scheduler" "org.forgerock.openidm.scope" "org.forgerock.openidm.taskscanner"
You can replace the list of required modules and services, or add to it, by adding the following lines to your resolver/boot.properties file. Bundles and services are specified as a list of symbolic names, separated by commas:
-
openidm.healthservice.reqbundles- overrides the default required bundles. -
openidm.healthservice.reqservices- overrides the default required services. -
openidm.healthservice.additionalreqbundles- specifies required bundles (in addition to the default list). -
openidm.healthservice.additionalreqservices- specifies required services (in addition to the default list).
|
By default, the server is given 15 seconds to start up all the required bundles and services before system readiness is assessed. This is not the total start time, but the time required to complete the service startup after the framework has started. You can change this default by setting the value of the openidm.healthservice.servicestartmax=5000 |