Rule Profiling

This article applies to:

Rule Profiling is an advanced feature of MailMarshal that can be used to tune the Engine and standard rules.

Rule Profiling records the average run time of a rule and the number of times it is run on the specific processing server.

The profile data is reset when rules are reloaded or the Engine service is restarted.

The profile data can be queried using the MMlookup.exe application (installed with the product) and can also be saved to a file in .csv format.

To query the profile data with MMlookup:

On a MailMarshal processing server, run MMLookup from the command line.
At the prompt mmlookup> enter one of the following commands:
- ?profile
  Lists the profile map
- ?profile clear
  Resets the map
- ?profile filename.csv
  Saves the data to a file that can be manipulated by excel.
  For instance, ?profile c:\temp\profile.csv
The output returns a line for each rule that has been used since the last profile clear on this server. Each line shows:
Rule name, Rule has triggered (True/False), average run time, number of times run

The profiler can be disabled (for all servers in an array) by setting the following registry item:

In MailMarshal 10.0 and above, open the Management Console and navigate to Advanced Settings. Add a new value:
- Name: Engine.EnableRuleProfiler
- Type: Boolean
- Value: False (NOT selected)
In MailMarshal 8.X and below, open the Registry Editor on the Array Manager. Within the base registry key, navigate to \Default\Engine
- In version 8.X: HKEY_LOCAL_MACHINE\SOFTWARE\Trustwave\Secure Email Gateway\Default\Engine
- For information about the registry location for each version, see article Q10832.
- Enter the value as a new DWORD value named EnableRuleProfiler with value 0 (disable).
Save your registry settings or configuration settings.
Commit the configuration changes and restart the MailMarshal Engine service on each node.

Warning: As always take due care when editing the Registry.