Does setting TraceLogRetentionOption on EventSchemaTraceListener actually do anything?

Question

I'd like System.Diagnostics.EventSchemaTraceListener to generate an unlimited set of sequential files, so I initialised one with TraceLogRetentionOption.UnlimitedSequentialFiles. However, the trace output was written to one single file rather than multiple sequential files.

Is there any official or unofficial documentation or code sample on using this specific log retention option? And failing that, is my code below incorrect in any way?

---

To reduce magic configuration woo, I'll do everything in code. Here's how I think it's supposed to be initialised:

TraceSource ts = new TraceSource("My trace source", SourceLevels.All);
SourceSwitch sourceSwitch = new SourceSwitch("SourceSwitch", "Verbose");
ts.Switch = sourceSwitch;
ts.Listeners.Add(new System.Diagnostics.EventSchemaTraceListener(
  "event.log", // "file name"
  "eventschema", // "name"
  1024, // buffer in bytes - I set this to be <= maximum file size
  TraceLogRetentionOption.UnlimitedSequentialFiles,
  1024); // max. file size in bytes - very small to illustrate the concept

And then I log to it a few times:

for (var i = 0; i < aFew; i++) {
  ts.TraceData(
    TraceEventType.Information, // trace level
    100, // event ID: arbitrary integer
    "some data to output");
}

I observe a single event.log file is created and contains all the expected information, but the TraceLogRetentionOption is not respected as the single file's size exceeds the maximum 1kB specified.

What am I doing wrong?

Answer 1

From what it looks like, the file size limit you impose is only a threshold if the size of the message being output exceeds the size that you specify. Citing the MSDN's MaximumFileSizeProperty page:

The property value is set by the maximumFileSize parameter in the constructor or the maximumFileSize attribute in the configuration file. For performance reasons, you should set the maximum file size to a multiple of 1024 bytes. The MaximumFileSize property value is not an absolute; it is a threshold that can be exceeded up to the size of the last message.

Answer 2

OK, short version is that the problem was between the screen and the chair.

There's a few tricks here:

1. It's really important that the buffer size is less than the maximum file size, which I assumed but never confirmed prior to posting
2. Depending on how you set up the trace, it seems to miss any requests thrown at it for some amount of time while the application initialises. Not sure why.
3. Sometimes Windows Explorer doesn't refresh the list of files in a directory. So check that before making a fool of yourself on the internet.