Microsoft.Extensions.Logging.Console.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.Console</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.Console.AnsiLogConsole">
  8. <summary>
  9. For consoles which understand the ANSI escape code sequences to represent color
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Logging.Console.AnsiParser.Parse(System.String)">
  13. <summary>
  14. Parses a subset of display attributes
  15. Set Display Attributes
  16. Set Attribute Mode [{attr1};...;{attrn}m
  17. Sets multiple display attribute settings. The following lists standard attributes that are getting parsed:
  18. 1 Bright
  19. Foreground Colours
  20. 30 Black
  21. 31 Red
  22. 32 Green
  23. 33 Yellow
  24. 34 Blue
  25. 35 Magenta
  26. 36 Cyan
  27. 37 White
  28. Background Colours
  29. 40 Black
  30. 41 Red
  31. 42 Green
  32. 43 Yellow
  33. 44 Blue
  34. 45 Magenta
  35. 46 Cyan
  36. 47 White
  37. </summary>
  38. </member>
  39. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatter">
  40. <summary>
  41. Allows custom log messages formatting
  42. </summary>
  43. </member>
  44. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Name">
  45. <summary>
  46. Gets the name associated with the console log formatter.
  47. </summary>
  48. </member>
  49. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Write``1(Microsoft.Extensions.Logging.Abstractions.LogEntry{``0}@,Microsoft.Extensions.Logging.IExternalScopeProvider,System.IO.TextWriter)">
  50. <summary>
  51. Writes the log message to the specified TextWriter.
  52. </summary>
  53. <remarks>
  54. if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
  55. </remarks>
  56. <param name="logEntry">The log entry.</param>
  57. <param name="scopeProvider">The provider of scope data.</param>
  58. <param name="textWriter">The string writer embedding ansi code for colors.</param>
  59. <typeparam name="TState">The type of the object to be written.</typeparam>
  60. </member>
  61. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames">
  62. <summary>
  63. Reserved formatter names for the built-in console formatters.
  64. </summary>
  65. </member>
  66. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Simple">
  67. <summary>
  68. Reserved name for simple console formatter
  69. </summary>
  70. </member>
  71. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Json">
  72. <summary>
  73. Reserved name for json console formatter
  74. </summary>
  75. </member>
  76. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Systemd">
  77. <summary>
  78. Reserved name for systemd console formatter
  79. </summary>
  80. </member>
  81. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions">
  82. <summary>
  83. Options for the built-in console log formatter.
  84. </summary>
  85. </member>
  86. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.IncludeScopes">
  87. <summary>
  88. Includes scopes when <see langword="true" />.
  89. </summary>
  90. </member>
  91. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.TimestampFormat">
  92. <summary>
  93. Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
  94. </summary>
  95. </member>
  96. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.UseUtcTimestamp">
  97. <summary>
  98. Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
  99. </summary>
  100. </member>
  101. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat">
  102. <summary>
  103. Format of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" /> messages.
  104. </summary>
  105. </member>
  106. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default">
  107. <summary>
  108. Produces messages in the default console format.
  109. </summary>
  110. </member>
  111. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Systemd">
  112. <summary>
  113. Produces messages in a format suitable for console output to the systemd journal.
  114. </summary>
  115. </member>
  116. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions">
  117. <summary>
  118. Options for a <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.
  119. </summary>
  120. </member>
  121. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors">
  122. <summary>
  123. Disables colors when <see langword="true" />.
  124. </summary>
  125. </member>
  126. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format">
  127. <summary>
  128. Gets or sets log message format. Defaults to <see cref="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default" />.
  129. </summary>
  130. </member>
  131. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.FormatterName">
  132. <summary>
  133. Name of the log message formatter to use. Defaults to "simple" />.
  134. </summary>
  135. </member>
  136. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes">
  137. <summary>
  138. Includes scopes when <see langword="true" />.
  139. </summary>
  140. </member>
  141. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.LogToStandardErrorThreshold">
  142. <summary>
  143. Gets or sets value indicating the minimum level of messages that would get written to <c>Console.Error</c>.
  144. </summary>
  145. </member>
  146. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat">
  147. <summary>
  148. Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
  149. </summary>
  150. </member>
  151. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp">
  152. <summary>
  153. Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
  154. </summary>
  155. </member>
  156. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider">
  157. <summary>
  158. A provider of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances.
  159. </summary>
  160. </member>
  161. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
  162. <summary>
  163. Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
  164. </summary>
  165. <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.Console.ConsoleFormatter})">
  168. <summary>
  169. Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
  170. </summary>
  171. <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
  172. <param name="formatters">Log formatters added for <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> insteaces.</param>
  173. </member>
  174. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.CreateLogger(System.String)">
  175. <inheritdoc />
  176. </member>
  177. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.Dispose">
  178. <inheritdoc />
  179. </member>
  180. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  181. <inheritdoc />
  182. </member>
  183. <member name="T:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions">
  184. <summary>
  185. Options for the built-in json console log formatter.
  186. </summary>
  187. </member>
  188. <member name="P:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions.JsonWriterOptions">
  189. <summary>
  190. Gets or sets JsonWriterOptions.
  191. </summary>
  192. </member>
  193. <member name="T:Microsoft.Extensions.Logging.Console.LoggerColorBehavior">
  194. <summary>
  195. Determines when to use color when logging messages.
  196. </summary>
  197. </member>
  198. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Default">
  199. <summary>
  200. Use the default color behavior, enabling color except when the console output is redirected.
  201. </summary>
  202. <remarks>
  203. Enables color except when the console output is redirected.
  204. </remarks>
  205. </member>
  206. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Enabled">
  207. <summary>
  208. Enable color for logging
  209. </summary>
  210. </member>
  211. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Disabled">
  212. <summary>
  213. Disable color for logging
  214. </summary>
  215. </member>
  216. <member name="T:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions">
  217. <summary>
  218. Options for the built-in default console log formatter.
  219. </summary>
  220. </member>
  221. <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.ColorBehavior">
  222. <summary>
  223. Determines when to use color when logging messages.
  224. </summary>
  225. </member>
  226. <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.SingleLine">
  227. <summary>
  228. When <see langword="true" />, the entire message gets logged in a single line.
  229. </summary>
  230. </member>
  231. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  232. <summary>
  233. Adds a console logger named 'Console' to the factory.
  234. </summary>
  235. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  236. </member>
  237. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
  238. <summary>
  239. Adds a console logger named 'Console' to the factory.
  240. </summary>
  241. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  242. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.</param>
  243. </member>
  244. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  245. <summary>
  246. Add the default console log formatter named 'simple' to the factory with default properties.
  247. </summary>
  248. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  249. </member>
  250. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions})">
  251. <summary>
  252. Add and configure a console log formatter named 'simple' to the factory.
  253. </summary>
  254. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  255. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in default log formatter.</param>
  256. </member>
  257. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  258. <summary>
  259. Add a console log formatter named 'json' to the factory with default properties.
  260. </summary>
  261. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  262. </member>
  263. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions})">
  264. <summary>
  265. Add and configure a console log formatter named 'json' to the factory.
  266. </summary>
  267. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  268. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in json log formatter.</param>
  269. </member>
  270. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions})">
  271. <summary>
  272. Add and configure a console log formatter named 'systemd' to the factory.
  273. </summary>
  274. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  275. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in systemd log formatter.</param>
  276. </member>
  277. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  278. <summary>
  279. Add a console log formatter named 'systemd' to the factory with default properties.
  280. </summary>
  281. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  282. </member>
  283. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder)">
  284. <summary>
  285. Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
  286. </summary>
  287. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  288. </member>
  289. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{``1})">
  290. <summary>
  291. Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
  292. </summary>
  293. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  294. <param name="configure">A delegate to configure options 'TOptions' for custom formatter 'TFormatter'.</param>
  295. </member>
  296. <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
  297. <summary>
  298. Scope provider that does nothing.
  299. </summary>
  300. </member>
  301. <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
  302. <summary>
  303. Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
  304. </summary>
  305. </member>
  306. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
  307. <inheritdoc />
  308. </member>
  309. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
  310. <inheritdoc />
  311. </member>
  312. <member name="T:Microsoft.Extensions.Logging.NullScope">
  313. <summary>
  314. An empty scope without any logic
  315. </summary>
  316. </member>
  317. <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
  318. <inheritdoc />
  319. </member>
  320. <member name="P:System.SR.BufferMaximumSizeExceeded">
  321. <summary>Cannot allocate a buffer of size {0}.</summary>
  322. </member>
  323. </members>
  324. </doc>