Microsoft.Extensions.Logging.Abstractions.xml 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.IExternalScopeProvider">
  8. <summary>
  9. Represents a storage of common scope data.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  13. <summary>
  14. Executes callback for each currently active scope objects in order of creation.
  15. All callbacks are guaranteed to be called inline from this method.
  16. </summary>
  17. <param name="callback">The callback to be executed for every scope object</param>
  18. <param name="state">The state object to be passed into the callback</param>
  19. <typeparam name="TState"></typeparam>
  20. </member>
  21. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.Push(System.Object)">
  22. <summary>
  23. Adds scope object to the list
  24. </summary>
  25. <param name="state">The scope object</param>
  26. <returns>The <see cref="T:System.IDisposable"/> token that removes scope on dispose.</returns>
  27. </member>
  28. <member name="T:Microsoft.Extensions.Logging.ILogger">
  29. <summary>
  30. Represents a type used to perform logging.
  31. </summary>
  32. <remarks>Aggregates most logging patterns to a single method.</remarks>
  33. </member>
  34. <member name="M:Microsoft.Extensions.Logging.ILogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  35. <summary>
  36. Writes a log entry.
  37. </summary>
  38. <param name="logLevel">Entry will be written on this level.</param>
  39. <param name="eventId">Id of the event.</param>
  40. <param name="state">The entry to be written. Can be also an object.</param>
  41. <param name="exception">The exception related to this entry.</param>
  42. <param name="formatter">Function to create a <c>string</c> message of the <paramref name="state"/> and <paramref name="exception"/>.</param>
  43. </member>
  44. <member name="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  45. <summary>
  46. Checks if the given <paramref name="logLevel"/> is enabled.
  47. </summary>
  48. <param name="logLevel">level to be checked.</param>
  49. <returns><c>true</c> if enabled.</returns>
  50. </member>
  51. <member name="M:Microsoft.Extensions.Logging.ILogger.BeginScope``1(``0)">
  52. <summary>
  53. Begins a logical operation scope.
  54. </summary>
  55. <param name="state">The identifier for the scope.</param>
  56. <returns>An IDisposable that ends the logical operation scope on dispose.</returns>
  57. </member>
  58. <member name="T:Microsoft.Extensions.Logging.ILoggerFactory">
  59. <summary>
  60. Represents a type used to configure the logging system and create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from
  61. the registered <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s.
  62. </summary>
  63. </member>
  64. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.CreateLogger(System.String)">
  65. <summary>
  66. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
  67. </summary>
  68. <param name="categoryName">The category name for messages produced by the logger.</param>
  69. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</returns>
  70. </member>
  71. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  72. <summary>
  73. Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to the logging system.
  74. </summary>
  75. <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.</param>
  76. </member>
  77. <member name="T:Microsoft.Extensions.Logging.ILogger`1">
  78. <summary>
  79. A generic interface for logging where the category name is derived from the specified
  80. <typeparamref name="TCategoryName"/> type name.
  81. Generally used to enable activation of a named <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from dependency injection.
  82. </summary>
  83. <typeparam name="TCategoryName">The type who's name is used for the logger category name.</typeparam>
  84. </member>
  85. <member name="T:Microsoft.Extensions.Logging.ILoggerProvider">
  86. <summary>
  87. Represents a type that can create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
  88. </summary>
  89. </member>
  90. <member name="M:Microsoft.Extensions.Logging.ILoggerProvider.CreateLogger(System.String)">
  91. <summary>
  92. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
  93. </summary>
  94. <param name="categoryName">The category name for messages produced by the logger.</param>
  95. <returns></returns>
  96. </member>
  97. <member name="T:Microsoft.Extensions.Logging.Internal.FormattedLogValues">
  98. <summary>
  99. LogValues to enable formatting options supported by <see cref="M:string.Format"/>.
  100. This also enables using {NamedformatItem} in the format string.
  101. </summary>
  102. </member>
  103. <member name="T:Microsoft.Extensions.Logging.Internal.LogValuesFormatter">
  104. <summary>
  105. Formatter to convert the named format items like {NamedformatItem} to <see cref="M:string.Format"/> format.
  106. </summary>
  107. </member>
  108. <member name="T:Microsoft.Extensions.Logging.Abstractions.Internal.NullScope">
  109. <summary>
  110. An empty scope without any logic
  111. </summary>
  112. </member>
  113. <member name="M:Microsoft.Extensions.Logging.Abstractions.Internal.NullScope.Dispose">
  114. <inheritdoc />
  115. </member>
  116. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger">
  117. <summary>
  118. Minimalistic logger that does nothing.
  119. </summary>
  120. </member>
  121. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.BeginScope``1(``0)">
  122. <inheritdoc />
  123. </member>
  124. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  125. <inheritdoc />
  126. </member>
  127. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  128. <inheritdoc />
  129. </member>
  130. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
  131. <summary>
  132. An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> used to create instance of
  133. <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> that logs nothing.
  134. </summary>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.CreateLogger(System.String)">
  137. <inheritdoc />
  138. <remarks>
  139. This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> instance which logs nothing.
  140. </remarks>
  141. </member>
  142. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  143. <inheritdoc />
  144. <remarks>
  145. This method ignores the parameter and does nothing.
  146. </remarks>
  147. </member>
  148. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1">
  149. <summary>
  150. Minimalistic logger that does nothing.
  151. </summary>
  152. </member>
  153. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.BeginScope``1(``0)">
  154. <inheritdoc />
  155. </member>
  156. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  157. <inheritdoc />
  158. <remarks>
  159. This method ignores the parameters and does nothing.
  160. </remarks>
  161. </member>
  162. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  163. <inheritdoc />
  164. </member>
  165. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
  166. <summary>
  167. Provider for the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
  168. </summary>
  169. </member>
  170. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.CreateLogger(System.String)">
  171. <inheritdoc />
  172. </member>
  173. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Dispose">
  174. <inheritdoc />
  175. </member>
  176. <member name="P:Microsoft.Extensions.Logging.Abstractions.Resource.UnexpectedNumberOfNamedParameters">
  177. <summary>
  178. The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).
  179. </summary>
  180. </member>
  181. <member name="M:Microsoft.Extensions.Logging.Abstractions.Resource.FormatUnexpectedNumberOfNamedParameters(System.Object,System.Object,System.Object)">
  182. <summary>
  183. The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).
  184. </summary>
  185. </member>
  186. <member name="T:Microsoft.Extensions.Logging.ISupportExternalScope">
  187. <summary>
  188. Represents a <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> that is able to consume external scope information.
  189. </summary>
  190. </member>
  191. <member name="M:Microsoft.Extensions.Logging.ISupportExternalScope.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  192. <summary>
  193. Sets external scope information source for logger provider.
  194. </summary>
  195. <param name="scopeProvider"></param>
  196. </member>
  197. <member name="T:Microsoft.Extensions.Logging.LoggerExtensions">
  198. <summary>
  199. ILogger extension methods for common scenarios.
  200. </summary>
  201. </member>
  202. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  203. <summary>
  204. Formats and writes a debug log message.
  205. </summary>
  206. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  207. <param name="eventId">The event id associated with the log.</param>
  208. <param name="exception">The exception to log.</param>
  209. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  210. <param name="args">An object array that contains zero or more objects to format.</param>
  211. <example>logger.LogDebug(0, exception, "Error while processing request from {Address}", address)</example>
  212. </member>
  213. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  214. <summary>
  215. Formats and writes a debug log message.
  216. </summary>
  217. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  218. <param name="eventId">The event id associated with the log.</param>
  219. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  220. <param name="args">An object array that contains zero or more objects to format.</param>
  221. <example>logger.LogDebug(0, "Processing request from {Address}", address)</example>
  222. </member>
  223. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  224. <summary>
  225. Formats and writes a debug log message.
  226. </summary>
  227. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  228. <param name="exception">The exception to log.</param>
  229. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  230. <param name="args">An object array that contains zero or more objects to format.</param>
  231. <example>logger.LogDebug(exception, "Error while processing request from {Address}", address)</example>
  232. </member>
  233. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  234. <summary>
  235. Formats and writes a debug log message.
  236. </summary>
  237. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  238. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  239. <param name="args">An object array that contains zero or more objects to format.</param>
  240. <example>logger.LogDebug("Processing request from {Address}", address)</example>
  241. </member>
  242. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  243. <summary>
  244. Formats and writes a trace log message.
  245. </summary>
  246. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  247. <param name="eventId">The event id associated with the log.</param>
  248. <param name="exception">The exception to log.</param>
  249. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  250. <param name="args">An object array that contains zero or more objects to format.</param>
  251. <example>logger.LogTrace(0, exception, "Error while processing request from {Address}", address)</example>
  252. </member>
  253. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  254. <summary>
  255. Formats and writes a trace log message.
  256. </summary>
  257. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  258. <param name="eventId">The event id associated with the log.</param>
  259. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  260. <param name="args">An object array that contains zero or more objects to format.</param>
  261. <example>logger.LogTrace(0, "Processing request from {Address}", address)</example>
  262. </member>
  263. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  264. <summary>
  265. Formats and writes a trace log message.
  266. </summary>
  267. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  268. <param name="exception">The exception to log.</param>
  269. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  270. <param name="args">An object array that contains zero or more objects to format.</param>
  271. <example>logger.LogTrace(exception, "Error while processing request from {Address}", address)</example>
  272. </member>
  273. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  274. <summary>
  275. Formats and writes a trace log message.
  276. </summary>
  277. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  278. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  279. <param name="args">An object array that contains zero or more objects to format.</param>
  280. <example>logger.LogTrace("Processing request from {Address}", address)</example>
  281. </member>
  282. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  283. <summary>
  284. Formats and writes an informational log message.
  285. </summary>
  286. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  287. <param name="eventId">The event id associated with the log.</param>
  288. <param name="exception">The exception to log.</param>
  289. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  290. <param name="args">An object array that contains zero or more objects to format.</param>
  291. <example>logger.LogInformation(0, exception, "Error while processing request from {Address}", address)</example>
  292. </member>
  293. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  294. <summary>
  295. Formats and writes an informational log message.
  296. </summary>
  297. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  298. <param name="eventId">The event id associated with the log.</param>
  299. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  300. <param name="args">An object array that contains zero or more objects to format.</param>
  301. <example>logger.LogInformation(0, "Processing request from {Address}", address)</example>
  302. </member>
  303. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  304. <summary>
  305. Formats and writes an informational log message.
  306. </summary>
  307. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  308. <param name="exception">The exception to log.</param>
  309. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  310. <param name="args">An object array that contains zero or more objects to format.</param>
  311. <example>logger.LogInformation(exception, "Error while processing request from {Address}", address)</example>
  312. </member>
  313. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  314. <summary>
  315. Formats and writes an informational log message.
  316. </summary>
  317. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  318. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  319. <param name="args">An object array that contains zero or more objects to format.</param>
  320. <example>logger.LogInformation("Processing request from {Address}", address)</example>
  321. </member>
  322. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  323. <summary>
  324. Formats and writes a warning log message.
  325. </summary>
  326. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  327. <param name="eventId">The event id associated with the log.</param>
  328. <param name="exception">The exception to log.</param>
  329. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  330. <param name="args">An object array that contains zero or more objects to format.</param>
  331. <example>logger.LogWarning(0, exception, "Error while processing request from {Address}", address)</example>
  332. </member>
  333. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  334. <summary>
  335. Formats and writes a warning log message.
  336. </summary>
  337. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  338. <param name="eventId">The event id associated with the log.</param>
  339. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  340. <param name="args">An object array that contains zero or more objects to format.</param>
  341. <example>logger.LogWarning(0, "Processing request from {Address}", address)</example>
  342. </member>
  343. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  344. <summary>
  345. Formats and writes a warning log message.
  346. </summary>
  347. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  348. <param name="exception">The exception to log.</param>
  349. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  350. <param name="args">An object array that contains zero or more objects to format.</param>
  351. <example>logger.LogWarning(exception, "Error while processing request from {Address}", address)</example>
  352. </member>
  353. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  354. <summary>
  355. Formats and writes a warning log message.
  356. </summary>
  357. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  358. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  359. <param name="args">An object array that contains zero or more objects to format.</param>
  360. <example>logger.LogWarning("Processing request from {Address}", address)</example>
  361. </member>
  362. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  363. <summary>
  364. Formats and writes an error log message.
  365. </summary>
  366. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  367. <param name="eventId">The event id associated with the log.</param>
  368. <param name="exception">The exception to log.</param>
  369. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  370. <param name="args">An object array that contains zero or more objects to format.</param>
  371. <example>logger.LogError(0, exception, "Error while processing request from {Address}", address)</example>
  372. </member>
  373. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  374. <summary>
  375. Formats and writes an error log message.
  376. </summary>
  377. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  378. <param name="eventId">The event id associated with the log.</param>
  379. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  380. <param name="args">An object array that contains zero or more objects to format.</param>
  381. <example>logger.LogError(0, "Processing request from {Address}", address)</example>
  382. </member>
  383. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  384. <summary>
  385. Formats and writes an error log message.
  386. </summary>
  387. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  388. <param name="exception">The exception to log.</param>
  389. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  390. <param name="args">An object array that contains zero or more objects to format.</param>
  391. <example>logger.LogError(exception, "Error while processing request from {Address}", address)</example>
  392. </member>
  393. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  394. <summary>
  395. Formats and writes an error log message.
  396. </summary>
  397. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  398. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  399. <param name="args">An object array that contains zero or more objects to format.</param>
  400. <example>logger.LogError("Processing request from {Address}", address)</example>
  401. </member>
  402. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  403. <summary>
  404. Formats and writes a critical log message.
  405. </summary>
  406. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  407. <param name="eventId">The event id associated with the log.</param>
  408. <param name="exception">The exception to log.</param>
  409. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  410. <param name="args">An object array that contains zero or more objects to format.</param>
  411. <example>logger.LogCritical(0, exception, "Error while processing request from {Address}", address)</example>
  412. </member>
  413. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  414. <summary>
  415. Formats and writes a critical log message.
  416. </summary>
  417. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  418. <param name="eventId">The event id associated with the log.</param>
  419. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  420. <param name="args">An object array that contains zero or more objects to format.</param>
  421. <example>logger.LogCritical(0, "Processing request from {Address}", address)</example>
  422. </member>
  423. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  424. <summary>
  425. Formats and writes a critical log message.
  426. </summary>
  427. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  428. <param name="exception">The exception to log.</param>
  429. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  430. <param name="args">An object array that contains zero or more objects to format.</param>
  431. <example>logger.LogCritical(exception, "Error while processing request from {Address}", address)</example>
  432. </member>
  433. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  434. <summary>
  435. Formats and writes a critical log message.
  436. </summary>
  437. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  438. <param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  439. <param name="args">An object array that contains zero or more objects to format.</param>
  440. <example>logger.LogCritical("Processing request from {Address}", address)</example>
  441. </member>
  442. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.String,System.Object[])">
  443. <summary>
  444. Formats and writes a log message at the specified log level.
  445. </summary>
  446. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  447. <param name="logLevel">Entry will be written on this level.</param>
  448. <param name="message">Format string of the log message.</param>
  449. <param name="args">An object array that contains zero or more objects to format.</param>
  450. </member>
  451. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  452. <summary>
  453. Formats and writes a log message at the specified log level.
  454. </summary>
  455. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  456. <param name="logLevel">Entry will be written on this level.</param>
  457. <param name="eventId">The event id associated with the log.</param>
  458. <param name="message">Format string of the log message.</param>
  459. <param name="args">An object array that contains zero or more objects to format.</param>
  460. </member>
  461. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.Exception,System.String,System.Object[])">
  462. <summary>
  463. Formats and writes a log message at the specified log level.
  464. </summary>
  465. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  466. <param name="logLevel">Entry will be written on this level.</param>
  467. <param name="exception">The exception to log.</param>
  468. <param name="message">Format string of the log message.</param>
  469. <param name="args">An object array that contains zero or more objects to format.</param>
  470. </member>
  471. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  472. <summary>
  473. Formats and writes a log message at the specified log level.
  474. </summary>
  475. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  476. <param name="logLevel">Entry will be written on this level.</param>
  477. <param name="eventId">The event id associated with the log.</param>
  478. <param name="exception">The exception to log.</param>
  479. <param name="message">Format string of the log message.</param>
  480. <param name="args">An object array that contains zero or more objects to format.</param>
  481. </member>
  482. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.BeginScope(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  483. <summary>
  484. Formats the message and creates a scope.
  485. </summary>
  486. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to create the scope in.</param>
  487. <param name="messageFormat">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
  488. <param name="args">An object array that contains zero or more objects to format.</param>
  489. <returns>A disposable scope object. Can be null.</returns>
  490. <example>
  491. using(logger.BeginScope("Processing request from {Address}", address))
  492. {
  493. }
  494. </example>
  495. </member>
  496. <member name="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider">
  497. <summary>
  498. Default implemenation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>
  499. </summary>
  500. </member>
  501. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  502. <inheritdoc />
  503. </member>
  504. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.Push(System.Object)">
  505. <inheritdoc />
  506. </member>
  507. <member name="T:Microsoft.Extensions.Logging.LoggerFactoryExtensions">
  508. <summary>
  509. ILoggerFactory extension methods for common scenarios.
  510. </summary>
  511. </member>
  512. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger``1(Microsoft.Extensions.Logging.ILoggerFactory)">
  513. <summary>
  514. Creates a new ILogger instance using the full name of the given type.
  515. </summary>
  516. <typeparam name="T">The type.</typeparam>
  517. <param name="factory">The factory.</param>
  518. </member>
  519. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger(Microsoft.Extensions.Logging.ILoggerFactory,System.Type)">
  520. <summary>
  521. Creates a new ILogger instance using the full name of the given type.
  522. </summary>
  523. <param name="factory">The factory.</param>
  524. <param name="type">The type.</param>
  525. </member>
  526. <member name="T:Microsoft.Extensions.Logging.LoggerMessage">
  527. <summary>
  528. Creates delegates which can be later cached to log messages in a performant way.
  529. </summary>
  530. </member>
  531. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope(System.String)">
  532. <summary>
  533. Creates a delegate which can be invoked to create a log scope.
  534. </summary>
  535. <param name="formatString">The named format string</param>
  536. <returns>A delegate which when invoked creates a log scope.</returns>
  537. </member>
  538. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``1(System.String)">
  539. <summary>
  540. Creates a delegate which can be invoked to create a log scope.
  541. </summary>
  542. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  543. <param name="formatString">The named format string</param>
  544. <returns>A delegate which when invoked creates a log scope.</returns>
  545. </member>
  546. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``2(System.String)">
  547. <summary>
  548. Creates a delegate which can be invoked to create a log scope.
  549. </summary>
  550. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  551. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  552. <param name="formatString">The named format string</param>
  553. <returns>A delegate which when invoked creates a log scope.</returns>
  554. </member>
  555. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``3(System.String)">
  556. <summary>
  557. Creates a delegate which can be invoked to create a log scope.
  558. </summary>
  559. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  560. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  561. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  562. <param name="formatString">The named format string</param>
  563. <returns>A delegate which when invoked creates a log scope.</returns>
  564. </member>
  565. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  566. <summary>
  567. Creates a delegate which can be invoked for logging a message.
  568. </summary>
  569. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  570. <param name="eventId">The event id</param>
  571. <param name="formatString">The named format string</param>
  572. <returns>A delegate which when invoked creates a log message.</returns>
  573. </member>
  574. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  575. <summary>
  576. Creates a delegate which can be invoked for logging a message.
  577. </summary>
  578. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  579. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  580. <param name="eventId">The event id</param>
  581. <param name="formatString">The named format string</param>
  582. <returns>A delegate which when invoked creates a log message.</returns>
  583. </member>
  584. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  585. <summary>
  586. Creates a delegate which can be invoked for logging a message.
  587. </summary>
  588. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  589. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  590. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  591. <param name="eventId">The event id</param>
  592. <param name="formatString">The named format string</param>
  593. <returns>A delegate which when invoked creates a log message.</returns>
  594. </member>
  595. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  596. <summary>
  597. Creates a delegate which can be invoked for logging a message.
  598. </summary>
  599. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  600. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  601. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  602. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  603. <param name="eventId">The event id</param>
  604. <param name="formatString">The named format string</param>
  605. <returns>A delegate which when invoked creates a log message.</returns>
  606. </member>
  607. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  608. <summary>
  609. Creates a delegate which can be invoked for logging a message.
  610. </summary>
  611. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  612. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  613. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  614. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  615. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  616. <param name="eventId">The event id</param>
  617. <param name="formatString">The named format string</param>
  618. <returns>A delegate which when invoked creates a log message.</returns>
  619. </member>
  620. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  621. <summary>
  622. Creates a delegate which can be invoked for logging a message.
  623. </summary>
  624. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  625. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  626. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  627. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  628. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  629. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  630. <param name="eventId">The event id</param>
  631. <param name="formatString">The named format string</param>
  632. <returns>A delegate which when invoked creates a log message.</returns>
  633. </member>
  634. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  635. <summary>
  636. Creates a delegate which can be invoked for logging a message.
  637. </summary>
  638. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  639. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  640. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  641. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  642. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  643. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  644. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  645. <param name="eventId">The event id</param>
  646. <param name="formatString">The named format string</param>
  647. <returns>A delegate which when invoked creates a log message.</returns>
  648. </member>
  649. <member name="T:Microsoft.Extensions.Logging.Logger`1">
  650. <summary>
  651. Delegates to a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type, created by the
  652. provided <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
  653. </summary>
  654. <typeparam name="T">The type.</typeparam>
  655. </member>
  656. <member name="M:Microsoft.Extensions.Logging.Logger`1.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
  657. <summary>
  658. Creates a new <see cref="T:Microsoft.Extensions.Logging.Logger`1"/>.
  659. </summary>
  660. <param name="factory">The factory.</param>
  661. </member>
  662. <member name="T:Microsoft.Extensions.Logging.LogLevel">
  663. <summary>
  664. Defines logging severity levels.
  665. </summary>
  666. </member>
  667. <member name="F:Microsoft.Extensions.Logging.LogLevel.Trace">
  668. <summary>
  669. Logs that contain the most detailed messages. These messages may contain sensitive application data.
  670. These messages are disabled by default and should never be enabled in a production environment.
  671. </summary>
  672. </member>
  673. <member name="F:Microsoft.Extensions.Logging.LogLevel.Debug">
  674. <summary>
  675. Logs that are used for interactive investigation during development. These logs should primarily contain
  676. information useful for debugging and have no long-term value.
  677. </summary>
  678. </member>
  679. <member name="F:Microsoft.Extensions.Logging.LogLevel.Information">
  680. <summary>
  681. Logs that track the general flow of the application. These logs should have long-term value.
  682. </summary>
  683. </member>
  684. <member name="F:Microsoft.Extensions.Logging.LogLevel.Warning">
  685. <summary>
  686. Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
  687. application execution to stop.
  688. </summary>
  689. </member>
  690. <member name="F:Microsoft.Extensions.Logging.LogLevel.Error">
  691. <summary>
  692. Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
  693. failure in the current activity, not an application-wide failure.
  694. </summary>
  695. </member>
  696. <member name="F:Microsoft.Extensions.Logging.LogLevel.Critical">
  697. <summary>
  698. Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
  699. immediate attention.
  700. </summary>
  701. </member>
  702. <member name="F:Microsoft.Extensions.Logging.LogLevel.None">
  703. <summary>
  704. Not used for writing log messages. Specifies that a logging category should not write any messages.
  705. </summary>
  706. </member>
  707. </members>
  708. </doc>