How to Configure Tracing for the PowerShellExecutor.dll Add-On

The PowerShellExecutor.dll is an add-on that implements communication between the gateway and Microsoft PowerShell. You can use PowerShell to manage Exchange Server 2007 accounts. This add-on cannot share tracing facilities with the rest of the gateway and provides a similar stand-alone tracing facility as the rest of the gateway.

The trace configuration for the PowerShellExecutor is stored in the same registry key as the other gateway registry keys:

HKEY_LOCAL_MACHINE\Software\Waveset\Lighthouse\Gateway

You create this base key when you configure tracing through the Waveset debug pages or when you start the gateway with trace command arguments.

On shut down, the gateway writes the current PowerShellExecutor settings for the tracing to the registry. These settings include:

• traceFileName

  Content. File name for the trace output (registry type REG_SZ)

  Default. " "

  Name of the trace file to generate for the PowerShellExecutor tracing. Where the name:

  • Can be a fully qualified path, including the filename

  • Cannot end in a slash (\)

    The full path, except the file, provided in the traceFileName must exist.

    If configured, log rotation adds a timestamp to the configured filename after rotation, when the file is no longer active. This timestamp displays in the following format:

    yyyyMMddHHmmss

• traceLevel

  Content. Trace level (registry type REG_DWORD)

  Default. 0 (no tracing)

  Allowed. 0–4

  This key is shared with the rest of the gateway. The whole gateway always provides tracing at the same level.

• traceMaxSize

  Content. Maximum file size in bytes (registry type REG_DWORD or REG_QWORD)

  Default. 100000 bytes

  Minimum. 100000 bytes

  Tracing text is written as UTF–8 encoded text with a byte order mark to make it portable to other systems.

• traceMaxFiles

  Content. Number of trace files (registry type REG_DWORD)

  Default. 2

  Minimum. 1

  This setting controls the number of trace files to keep on the system. Setting the maximum number of files to keep to 1, causes the file to be overwritten when the maximum size is reached. The oldest file, based on last write time, is removed when the maximum number of files is reached.

• traceConfigInterval

  Content. Time out in milliseconds (registry type REG_DWORD)

  Default. 300000 ms (5 minutes)

  Minimum. 60000 ms (1 minute)

All trace settings are reread from the registry based on this timeout value. In a production environment, consider setting this value to a large value, such as 24 hours, to minimize overhead.