Skip to content

docs: add DefaultTraceListener entry to trace listeners table #50120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhiramch018 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add DefaultTraceListener entry to trace listeners table #50120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...k/configure-apps/file-schema/trace-debug/add-element-for-listeners-for-trace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,10 @@
|<xref:System.Diagnostics.EventLogTraceListener?displayProperty=nameWithType>|The name of the name of an existing event log source.|
|<xref:System.Diagnostics.EventSchemaTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.EventSchemaTraceListener> writes to.|
|<xref:System.Diagnostics.TextWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.TextWriterTraceListener> writes to.|
|<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.|
|<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.|
Copy link

@KalleOlaviNiemitalo KalleOlaviNiemitalo Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is another similar table here:

docs/docs/framework/configure-apps/file-schema/trace-debug/add-element-for-sharedlisteners.md

Lines 66 to 75 in 0f1e282

The following table shows the trace listeners that are included with the .NET Framework and describes the value of their `initializeData` attributes.
|Trace listener class|initializeData attribute value|
|--------------------------|------------------------------------|
|<xref:System.Diagnostics.ConsoleTraceListener>|The `useErrorStream` value for the <xref:System.Diagnostics.ConsoleTraceListener.%23ctor%2A> constructor. Set the `initializeData` attribute to "`true`" to write trace and debug output to the standard error stream; set it to "`false`" to write to the standard output stream.|
|<xref:System.Diagnostics.DelimitedListTraceListener>|The name of the file the <xref:System.Diagnostics.DelimitedListTraceListener> writes to.|
|<xref:System.Diagnostics.EventLogTraceListener?displayProperty=nameWithType>|The name of an existing event log source.|
|<xref:System.Diagnostics.EventSchemaTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.EventSchemaTraceListener> writes to.|
|<xref:System.Diagnostics.TextWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.TextWriterTraceListener> writes to.|
|<xref:System.Diagnostics.XmlWriterTraceListener>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.|

|xref:System.Diagnostics.DefaultTraceListener?displayProperty=nameWithType|The default trace listener that outputs messages to the Visual Studio Output window or debugger. This listener is automatically included in the `Trace.Listeners` collection unless explicitly removed in the configuration.|
Copy link

@KalleOlaviNiemitalo KalleOlaviNiemitalo Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume the new xref link should have < > around it like the existing ones have.

Copy link

@KalleOlaviNiemitalo KalleOlaviNiemitalo Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second column of this table is "initializeData attribute value", but DefaultTraceListener does not support initializeData. Instead of describing the purpose of DefaultTraceListener, the new row should state that initializeData is not used with that type of listener.



Check failure on line 84 in docs/framework/configure-apps/file-schema/trace-debug/add-element-for-listeners-for-trace.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines 

docs/framework/configure-apps/file-schema/trace-debug/add-element-for-listeners-for-trace.md:84 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md012.md

Check failure on line 84 in docs/framework/configure-apps/file-schema/trace-debug/add-element-for-listeners-for-trace.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines 

docs/framework/configure-apps/file-schema/trace-debug/add-element-for-listeners-for-trace.md:84 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md012.md
## Example

The following example shows how to use **\<add>** elements to add the listeners `MyListener` and `MyEventListener` to the **Listeners** collection. `MyListener` creates a file called `MyListener.log` and writes the output to the file. `MyEventListener` creates an entry in the event log.
Expand Down
Loading