rspec/rules/S6670/why-dotnet.adoc
Costin Zaharia 70bdb31f51
Logging rules: add "how to fix" section (#3969)
* S6674: add how to fix section

* S6677: add how to fix section

* S2629: add how to fix section

* S6670: add how to fix section

* S1312: add how to fix section

* S6672: add how to fix section

* S6670: add compliant/noncompliant headers

* S6669: add how to fix section

* S6668: add how to fix section

* S2629: remove method definition

* S6669: update formatting

* S6670: add links

* Fix formatting
2024-06-05 10:39:56 +02:00

4 lines
1.2 KiB
Plaintext

== Why is this an issue?
https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace.write[Trace.Write] and https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace.writeline[Trace.WriteLine] methods are writing to the underlying output stream directly, bypassing the trace formatting and filtering performed by https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.tracelistener.traceevent[TraceListener.TraceEvent] implementations.
It is preferred to use https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace.traceerror[Trace.TraceError], https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace.tracewarning[Trace.TraceWarning], and https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace.traceinformation[Trace.TraceInformation] methods instead because they call the https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.tracelistener.traceevent[TraceEvent method] which filters the trace output according to the https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.traceeventtype[TraceEventType] (Error, Warning or Information) and enhance the output with additional information.