Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Execute Run the following SQL stored procedure in SQL to perform , Z_EmpowerID_Health, to conduct a health check assessment of core EmpowerID processes: Z_EmpowerID_Health. This stored procedure has been pre-programmed to check the health of a common set of EmpowerID functionality and is meant to be consumed by an enterprise monitoring tool to help alert IT staff when attention is needed. The stored procedure can be customized procedure is designed to evaluate the performance of standard EmpowerID functionalities and should be used by enterprise monitoring tools to notify IT personnel when intervention is needed. Customization options are available to include additional checks. This procedure It is intended advised to be run regularly and periodically; a 5-minute interval is recommended, and an interval smaller run this procedure on a regular basis at 5-minute intervals; intervals shorter than 1 minute may put undue load on the system.A few cause excessive system load.

Two settings are needed for certain pre-programmed health checks in this stored procedure require 2 settings to be effective. The following can be set through to function effectively. Configure these settings via the EID UI: https://<EID-URL>/ui/#custom/EmpowerIDConfigSettings

  1. EmpowerID_Health_EmpowerIDServerRoleNames_ToMonitor:

...

  1. Enter a comma-separated list of

...

  1. EmpowerID Server Roles

...

  1. used in your EID instance.

...

  1. Typically, this value should be

...

  1. "Application Server Full, Web Front-End"

...

  1. to cover the two most common server roles.

  2. EmpowerID_Health_EmpowerIDServiceFriendlyNames_ToMonitor:

...

  1. Provide a comma-separated list of

...

  1. EmpowerID Services

...

  1. used in

...

  1. your EID instance.

...

  1. Generally, this value should be

...

  1. "Web Role Service, Worker Role Service"

...

  1. to include the two most frequently utilized services.

When you run the Z_EmpowerID_Health procedure, you will always receive a single resultset containing at least one result. The resultset includes a single column. If all checks pass, only a default record with the text "Z_EmpowerID_Health Complete (disregard this message)”. This record " will be the only one returned if all checks succeed. Otherwise, it will be the last record returned returned. If any checks fail, the default record will be preceded by records with text indicating which the failed checks are currently failing. The This design was meant to simplify incorporation into almost any enterprise monitoring tool.Numerous checks are is intended to facilitate easy integration with most enterprise monitoring tools.

The stored procedure contains various built-in health checks, and additional checks can be added to this stored procedure that ensures you have the option to add more checks for use-case-specific logic. The following Below is a list of possible potential health checks , and the corresponding text returned if the check failsin case of a failure:

  • EmpowerID Service <ServiceName> Heartbeat Overdue (5 minutes or more elapsed)

  • EmpowerID Server Role <RoleName> Heartbeat Overdue (5 minutes or more elapsed)

  • Job Overdue: <JobName> (10 minutes or more elapsed)

  • Job Not Succeeding: <JobName>

  • Inventory Progress Stalled: <SystemName>

  • Enforcement Progress Stalled: <SystemName>

  • Membership Progress Stalled: <SystemName>

  • Projection Progress Stalled: <SystemName>

  • Inventory Overdue: <SystemName>

  • Enforcement Overdue: <SystemName>

  • Membership Overdue: <SystemName>

  • Projection Overdue: <SystemName>

  • Inventory Not Succeeding: <SystemName>

  • Enforcement Not Succeeding: <SystemName>

  • Membership Not Succeeding: <SystemName>

  • Projection Not Succeeding: <SystemName>

  • Job <JobName> on AccountStore <SystemName> failed <#Failures> times consecutively from <EarliestFailureDateTime> to <RecentFailureDateTime>

  • Permanent Workflow <PermamentWorkflowName> is marked Active but overdue

  • Compiled Set <SetName> is marked Enabled but overdue

  • Cloud Gateway Server <ServerName> has not contacted EmpowerID in more than 5 minutes

...