User Store Availability gauge

The User Store Availability gauge monitors the directory servers that provide user data to PingAuthorize.

If PingAuthorize cannot reach these directory servers, it cannot:

Retrieve token owner information using a SCIM Token Resource Lookup Method
Handle SCIM 2 API requests

In this case, this gauge marks the status of PingAuthorize itself as UNAVAILABLE.

The status appears in the following locations:

The administrative console on the Status tab, in the Operational Status entry.
The Operational Status line in the bin/status output.
The Availability servlet. See Server status.

When PingAuthorize has a status of UNAVAILABLE, a load balancer can try to route traffic to a different PingAuthorize server or take some other action. See Auto-healing for unavailable servers.

If you followed the standard setup and configuration given in Getting started with PingAuthorize (tutorials), the User Store Availability gauge should automatically work.

The gauge assumes the PingAuthorize LDAP Store Adapter name is UserStoreAdapter. If your PingAuthorize SCIM configuration uses a different name, you must edit the gauge’s data source to reflect the custom store adapter name. Use the following dsconfig command to make this change, replacing <CustomStoreAdapter> in the last line with the actual name.

dsconfig set-gauge-data-source-prop \
  --source-name "User Store Availability"  \
  --set "include-filter:(store-adapter-name=<CustomStoreAdapter>)"

If your PingAuthorize deployment does not use SCIM or SCIM Token Resource Lookup Methods, you can disable the gauge with the following command.

dsconfig set-gauge-prop \
  --gauge-name "User Store Availability"  \
  --set enabled:false