Trace

[Trace]
:BlockWriteOnFailure=10
Call=0
:IncludeEvent=0
MaxSize=100
Path=none|{TS}||server,%WinDir%\\Temp\\netid.txt|{LOGONUI}||server|*
:RedirectAll=0
:RedirectOnFailure=0
UseCache=10000
UseDateTime=1
UseLocalTime=1
UseProcessName=0

BlockWriteOnFailure

The trace might not be able to write due to privileges on Windows. This parameter tells how many attempts to make before write is blocked.

Call

Use call trace instead of full trace. Call trace only traces every function call with result code.

Dump, DumpMax

It is possible to use the plugin to store data to a local file. This functionality is used to dump SOAP trace to a file.

SetProperty("Location", "Trace;Dump");
SetProperty("User", name);
SetProperty("Data", _BASE64.encode(_ToArrayOfUTF8(content)));
Invoke("SetLocationData");

[Trace]
Dump=file:///C:\Temp\soap\{name}.xml

The maximum number of file entries are stored in the same location, and read from plugin:

GetProperty("ConfigGlobal:Trace:DumpMax);

[Trace]
DumpMax=100

IncludeEvent

Trace include information about all PKCS11 function calls, except C_WaitForSlotEvent and C_HasNewEvent. Those calls is usually called to often resulting in huge traces, so will be skipped. This parameter can be used to also include those two functions in trace.

Values

0

off

1

on

Path

The trace path sets the location of the trace. The path can specify "server" to send the trace to the trace service. One can also specify an alternative path when used with trace service, and the service is not responding.

[Trace]
Path=C:\Temp\netid.txt
Path=server
Path=server,C:\Temp\netid.txt

The trace path can use environment variables.

[Trace]
Path=%TEMP%\netid.txt

Usually the trace service location is specified at Service Trace > Connect, but it is possible to set an alternative path:

[Trace]
Path=server net 192.168.1.100

RedirectAll

RedirectAll is used to send all trace calls to Net iD User Service. Used only to troubleshoot specific scenarios.

RedirectOnFailure

RedirectOnFailure will send all trace calls to Net iD User Service if not allowed to write to trace file.

UseCache

The trace is quite extensive, so writing the trace can have an effect on performance. The UseCache parameter allows the use of a write cache in the process. This improves the trace write performance, but can complicate the trace analysis. Specify the maximum number of trace rows that are allowed be to cached.

[Trace]
UseCache=10000
You must disable UseCache when investigating a crash, since the trace will not be written if the application crashes.

UseDateTime

Add date timestamp to trace entries.

This setting is disabled when using process execution time, see UseLocalTime. 
[Trace]
UseDateTime=1

Values

0

Off

1

On

UseLocalTime

Parameter UseLocalTime tells if timestamp should be based on local or process execution time.

[Trace]
UseLocalTime=1

Values

0

Use process execution time. Using this value deactivates UseDateTime.

1

Use local time.

UseProcessName

The UseProcessName parameter adds the application name to each row in the trace file. The output consists of the following fields: [<PID>:<THREAD>:<NAME>] <DATE> <TIME> <TEXT>

Values

0

Off, the application name is not added to each trace row. This is the default value.

1

On, the application name is added to each trace row.

Examples

Example 1. Add application name to trace output in the trace file.

To add the application name to the trace output, set the UseProcessName parameter to 1.

[Trace]
UseProcessName=1

The application name is now added to each row in the trace file.

[00003924:00003852:netid@system........] 2024-08-21 05:48:55.369 Supervisor - DetectReaders ...
[00003924:00003852:netid@system........] 2024-08-21 05:48:55.372 Supervisor - DetectReaders ... DONE (1)
[00004708:00011844:netid@user..........] 2024-08-21 05:48:56.057 Trace - Date 2024-08-21 05:48:56, 'C:\Temp\netid64.txt' (2)
1 The user running the netid.exe process is a system user.
2 The user running the netid.exe process is not a system user.