@@ -100,11 +100,16 @@ content:
100100}
101101```
102102
103- ` LogDirectory ` is the directory of the output file. It can be an absolute path
104- or a relative path to the current directory. ` FileSize ` is a positive integer,
103+ #### Configuration Parameters
104+
105+ 1 . ` LogDirectory ` is the directory of the output file. It can be an absolute
106+ path or a relative path to the current directory.
107+
108+ 2 . ` FileSize ` is a positive integer,
105109which specifies the log file size in
106110[ KiB] ( https://en.wikipedia.org/wiki/Kibibyte ) .
107- ` LogLevel ` is the lowest level of the events to be captured.
111+
112+ 3 . ` LogLevel ` is the lowest level of the events to be captured.
108113It has to be one of the
109114[ values] ( https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventlevel#fields )
110115of the [ ` EventLevel `
@@ -115,18 +120,23 @@ higher severity levels. For example, `Warning` includes the `Error` and
115120[ here] ( https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventlevel )
116121for more.)
117122
123+ #### Remarks
124+
125+ A ` FileSize ` -KiB log file named as ` ExecutableName.ProcessId.log ` (e.g.
126+ ` foobar.exe.12345.log ` ) will be generated at the specific directory
127+ ` LogDirectory ` .
128+
118129The SDK will attempt to open the configuration file in non-exclusive read-only
119- mode, read the file and parse it as the configuration file every 3 seconds. If
130+ mode, read the file and parse it as the configuration file every 10 seconds. If
120131the SDK fails to parse the ` LogDirectory ` , ` FileSize ` or ` LogLevel ` fields as
121132the specified format, the configuration file will be treated as invalid and no
122- log file would be generated. Otherwise, it will create or overwrite a
123- ` FileSize ` -KiB file at the specific directory ` LogDirectory ` with the log file
124- named as ` ExecutableName.ProcessId.log ` (e.g. ` foobar.exe.12345.log ` ).
133+ log file would be generated. Otherwise, it will create or overwrite the log
134+ file as described above.
125135
126136Note that the ` FileSize ` has to be between 1 MiB and 128 MiB (inclusive), or it
127- will be rounded to the closest upper or lower limit. When the ` LogDirectory ` or
137+ will be rounded to the closest upper or lower limit. When the ` LogDirectory ` or
128138` FileSize ` is found to be changed, the SDK will create or overwrite a file with
129- new logs according to the new configuration. The configuration file has to be
139+ new logs according to the new configuration. The configuration file has to be
130140no more than 4 KiB. In case the file is larger than 4 KiB, only the first 4 KiB
131141of content will be read.
132142
0 commit comments