Configure History Search Health Probe

The History Search health probe makes it possible to perform health checks related timing of Identity Panel operations. In particular it allows you to validate that schedules are running as expected, and may also be used to run SLA type validations.

The History Search probe works by running a query against the Identity Panel /histories REST API. It offers the same filtering options as a history chart or the history tab in Identity Panel, and returns matches from the last N Units (e.g. AD MA runs in the last 3 hours).

The health probe operations on an API result with the following structure:

{
   Count: 55,
   Data: [{ HistoryRecord } ... up to 10 entries ...]
}

This is then processed first by the Object Rule, and then by the Fail Rule. A typical scenario is to use the Count property to fail when there are zero results in a given time range.

Settings

Important: Just like dashboard charts and the run history interface itself, the dropdown lists will only be populated by actual existing history elements. This implies that the settings for this probe must be created after schedule operations have run for a little while.

Provider – Optional provider constraint, can show history for a MIM or AD Connect instance, or for Tools operations like a running a program or script.

History – Maps to RecordOf property, things like MA name, program name, etc.

Argument – Run profile name, program arguments, etc.

Result – result string from history entry e.g. "success", "completed-sync-errors"

Time Filter Unit – Unit of measure for time

Time Quantity – Number of unit, e.g. 3 hours or 1 day

Object Rule – Process data structure into a single value. Default is just

Count

for number of items returned.

Fail Rule – Default of

Value == 0

fails if there were no records matching the query.

Because it's common to have a separate period for long running schedule operations, e.g. a nightly full sync, it may be necessary to scope History Search probes by time of day. This can be done with a fail rule like the following:

Evaluates probe, but only between 6 AM and 5 PM

If(
   And(AddTime(Today(), Hours(6) >= Now(), AddTime(Today(), Hours(17)) <= Now())
   Value == 0,
   false
)