F Rule Logging

Rule logging records the required rule processing information so that the Rule Administrator can monitor the required information from a user session.

F.1 Configuration Controls

The properties used to enable/disable and specify the Runtime for Rule logging are listed below.

vcrypt.tracker.rules.trace.policySet=[true|false]
vcrypt.tracker.rules.trace.policySet.<runtime string value>=[true|false]

Use the Properties Editor to edit these properties.

F.2 Scenario

In the scenario, the Post-Authentication Runtime will be used. The Runtime string value for

profile.type.enum.postauth.name=Post-Authentication

is "postauth".

F.2.1 How It Works

The flow of how Rule logging works is as follows:

1. The Rules Engine first checks to see if a configuration exists for vcrypt.tracker.rules.trace.policySet.postauth.

2. If there is no configuration value set, the Rules Engine will check the configuration value of vcrypt.tracker.rules.trace.policySet.

The default value for vcrypt.tracker.rules.trace.policySet is "true".

F.2.2 Cases

The matrix below shows an example of how value combinations control logging during a specified Runtime.

value of vcrypt.tracker.rules.trace.policySet.postauth	value of vcrypt.tracker.rules.trace.policySet	Will Rule logging be enabled for the postauth Runtime?
true	false	yes
true	true	yes
true	not set	yes
false	false	no
false	true	no
false	not set	no
not set	false	no
not set	true	yes
not set	not set	yes

F.2.3 Main Point of Scenario

The main point of the scenario is that if the logging configuration is explicitly set at the given Runtime, the Rules Engine uses that value; otherwise, it uses the parent's value.

F.3 How to Control What Rules Are Logged:

The properties to control which Rules are logged are shown below.

vcrypt.tracker.rules.trace.notTriggered=[true|false]
vcrypt.tracker.rules.trace.notTriggered.logMillis=[millis]

If vcrypt.tracker.rules.trace.notTriggered is set to "true," Rules that are not triggered are also logged.

The value of vcrypt.tracker.rules.trace.notTriggered.logMillis will narrow down which Rules are shown.

If the Rule execution for non-triggered Rules exceeds the value of vcrypt.tracker.rules.trace.notTriggered.logMillis, only then will the Rules Engine log the non-triggered Rules.

F.4 Examples

The table below shows the property values that control what Rules get logged.

vcrypt.tracker.rules.trace.notTriggered	vcrypt.tracker.rules.trace.notTriggered.logMillis	Result
true	n	Logs the non-triggered Rules that took more than "n". If "n" is set to a negative value, all Rules are logged
false	n	None of the non-triggered Rules will be logged