Add docs for new console logging APIs #4918

maryamariyan · 2020-09-30T17:30:58Z

Summary

Adds docs for new console logging APIs.

cc: @carlossanlop

maryamariyan · 2020-09-30T17:41:06Z

cc: @safern

safern

cc: @gewarren

opbld34 · 2020-09-30T17:48:49Z

Docs Build status updates of commit 5bbad4f:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml	⚠️Warning	View	Details
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterOptions.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/JsonConsoleFormatterOptions.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml	✅Succeeded	View

xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml

Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

opbld32 · 2020-09-30T18:06:52Z

Docs Build status updates of commit c26a06f:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml	⚠️Warning	View	Details
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterOptions.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/JsonConsoleFormatterOptions.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml	✅Succeeded	View
xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml	✅Succeeded	View

xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml

Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

maryamariyan · 2020-10-01T01:33:47Z

closing in favor of #4925 (review)

gewarren · 2020-10-01T01:15:57Z

xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml

+        <param name="scopeProvider">The provider of scope data.</param>
+        <param name="textWriter">The string writer embedding ansi code for colors.</param>
+        <summary>Writes the log message to the specified TextWriter.</summary>
+        <remarks>if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>


Suggested change

<remarks>if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>

<remarks>If the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>

gewarren · 2020-10-01T01:16:08Z

xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml

+        <param name="logEntry">The log entry.</param>
+        <param name="scopeProvider">The provider of scope data.</param>
+        <param name="textWriter">The string writer embedding ansi code for colors.</param>
+        <summary>Writes the log message to the specified TextWriter.</summary>


Suggested change

<summary>Writes the log message to the specified TextWriter.</summary>

<summary>Writes the log message to the specified text writer.</summary>

gewarren · 2020-10-01T01:16:30Z

xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml

@@ -34,7 +34,7 @@
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Reserved name for json console formatter.</summary>


Suggested change

<summary>Reserved name for json console formatter.</summary>

<summary>The name reserved for the JSON console formatter.</summary>

gewarren · 2020-10-01T01:18:26Z

xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml

@@ -74,7 +74,7 @@
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Reserved name for systemd console formatter</summary>


Suggested change

<summary>Reserved name for systemd console formatter</summary>

<summary>Reserved name for the systemd console formatter.</summary>

gewarren · 2020-10-01T01:18:53Z

xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml

@@ -14,7 +14,7 @@
  </Base>
  <Interfaces />
  <Docs>
-    <summary>To be added.</summary>
+    <summary>Reserved formatter names for the built-in console formatters.</summary>


Suggested change

<summary>Reserved formatter names for the built-in console formatters.</summary>

<summary>Provides reserved formatter names for the built-in console formatters.</summary>

gewarren · 2020-10-01T01:45:19Z

xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml

@@ -74,7 +75,7 @@
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Enable color for logging.</summary>


Suggested change

<summary>Enable color for logging.</summary>

<summary>Use color for logging.</summary>

gewarren · 2020-10-01T01:46:06Z

xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml

@@ -14,7 +14,7 @@
  </Base>
  <Interfaces />
  <Docs>
-    <summary>To be added.</summary>
+    <summary>Options for the built-in default console log formatter.</summary>


Suggested change

<summary>Options for the built-in default console log formatter.</summary>

<summary>Specifies options for the built-in, default console log formatter.</summary>

gewarren · 2020-10-01T01:46:42Z

xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml

@@ -51,7 +51,7 @@
        <ReturnType>Microsoft.Extensions.Logging.Console.LoggerColorBehavior</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Determines when to use color when logging messages.</summary>


Suggested change

<summary>Determines when to use color when logging messages.</summary>

<summary>Gets or sets a value that indicates when to use color for log messages.</summary>

gewarren · 2020-10-01T01:47:57Z

xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml

@@ -72,7 +72,7 @@
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>
        <value>To be added.</value>


Suggested change

<value>To be added.</value>

<value><see langword="true" />to log the entire message as a single line; otherwise, <see langword=false />.</value>

gewarren · 2020-10-01T01:48:30Z

xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml

@@ -72,7 +72,7 @@
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>


Suggested change

<summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>

<summary>Gets or sets a value that indicates whether the entire message should be logged as a single line.</summary>

maryamariyan mentioned this pull request Sep 30, 2020

Fix xml doc comment for SimpleConsoleFormatterOptions.SingleLine dotnet/runtime#42896

Merged

Add docs for new console logging APIs

c26a06f

maryamariyan force-pushed the singleline branch from 5bbad4f to c26a06f Compare September 30, 2020 17:35

safern approved these changes Sep 30, 2020

View reviewed changes

maryamariyan closed this Oct 1, 2020

gewarren reviewed Oct 1, 2020

View reviewed changes

carlossanlop added the area-Extensions-Logging label Mar 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs for new console logging APIs #4918

Add docs for new console logging APIs #4918

maryamariyan commented Sep 30, 2020 •

edited

Loading

maryamariyan commented Sep 30, 2020

safern left a comment

opbld34 commented Sep 30, 2020

opbld32 commented Sep 30, 2020

maryamariyan commented Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

gewarren Oct 1, 2020

	<remarks>if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>
	<remarks>If the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>

	<summary>Writes the log message to the specified TextWriter.</summary>
	<summary>Writes the log message to the specified text writer.</summary>

	<summary>Reserved name for json console formatter.</summary>
	<summary>The name reserved for the JSON console formatter.</summary>

	<summary>Reserved name for systemd console formatter</summary>
	<summary>Reserved name for the systemd console formatter.</summary>

	<summary>Reserved formatter names for the built-in console formatters.</summary>
	<summary>Provides reserved formatter names for the built-in console formatters.</summary>

	<summary>Enable color for logging.</summary>
	<summary>Use color for logging.</summary>

	<summary>Options for the built-in default console log formatter.</summary>
	<summary>Specifies options for the built-in, default console log formatter.</summary>

	<summary>Determines when to use color when logging messages.</summary>
	<summary>Gets or sets a value that indicates when to use color for log messages.</summary>

	<value>To be added.</value>
	<value><see langword="true" />to log the entire message as a single line; otherwise, <see langword=false />.</value>

	<summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>
	<summary>Gets or sets a value that indicates whether the entire message should be logged as a single line.</summary>

Add docs for new console logging APIs #4918

Add docs for new console logging APIs #4918

Conversation

maryamariyan commented Sep 30, 2020 • edited Loading

Summary

maryamariyan commented Sep 30, 2020

safern left a comment

Choose a reason for hiding this comment

opbld34 commented Sep 30, 2020

⚠️ Validation status: warnings

opbld32 commented Sep 30, 2020

⚠️ Validation status: warnings

maryamariyan commented Oct 1, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maryamariyan commented Sep 30, 2020 •

edited

Loading