RavenDB.StructuredLogger 7.1.0

RavenDB.StructuredLog

一个使用 RavenDB 存储结构化日志的 ASP.NET Core 日志记录器。

<a href="https://andrewlock.net/creating-an-extension-method-for-attaching-key-value-pairs-to-scope-state-using-asp-net-core/">结构化日志</a> 使用 RavenDB 作为日志存储。

旧、丑陋的日志方式会导致成千上万不可见的日志

• "用户 [email protected] 于 10 月 7 日 5:13 登录"
• "用户 [email protected] 于 11 月 8 日 2:25 登录"
• "用户 [email protected] 于 11 月 21 日 3:18 登录"
• "用户 [email protected] 于 12 月 15 日 0:0 登录"
• [以及更多 1000 多个条目 - ouch!]

但是，使用结构化和分组日志，您可以获得更少的日志，将类似的日志分组在一起，使其可搜索

{
    "MessageTemplate": "User {email} signed in at {date}",
    "Level": "Information",
    "OccurrenceCount": 1032,
    "FirstOccurrence": "2017-09-27T17:29:46.6597966+00:00",
    "LastOccurrence": "2017-09-27T17:39:50.5554997+00:00",
    "Occurrences": [
        {
            "Message": "User [email protected] signed in at 5:13 Oct 7",
            "Level": "Information",
            "Created": "2017-09-27T17:39:48.4248681+00:00",
            "Category": "Sample.Controllers.HomeController",
            "EventId": null,
            "TemplateValues": {
                "{OriginalFormat}": "User {email} signed in at {date}",
                "email": "[email protected]",
                "date": "5:13 Oct 7"
            }
        },
        {
            "Message": "User [email protected] signed in at 2:25 Nov 8",
            "Level": "Information",
            "Created": "2017-09-27T17:39:48.4248681+00:00",
            "Category": "Sample.Controllers.HomeController",
            "EventId": null,
            "TemplateValues": {
                "{OriginalFormat}": "User {email} signed in at {date}",
                "email": "[email protected]",
                "date": "2:25 Nov 8"
            }
        }
    ]
}

最终结果是，人类可以轻松理解软件中发生的错误以及其出现频率。此外，与老式日志不同，其中日志是巨大的不可见字符串，结构化日志因模板值的提取和存储在日志消息之外而可搜索。

说明

1. 在 Startup.cs 中

public void ConfigureServices(IServiceCollection services)
{
	// Create your Raven doc store
	var docStore = new DocumentStore { ... };

	// Recommended: 
	// Avoid logging objects that contain self referenced loops.
	// Must be done before .Initialize().
	docStore.IgnoreSelfReferencingLoops();
	
	docStore.Initialize();

	// Add RavenDB structured logging.
	services.AddRavenStructuredLogger(docStore);  // docStore may be omitted if it's already in the DI container

	...
}

2. 像平常一样在控制器和 服务中使用日志记录

public class HomeController : Controller 
{
	private ILogger<HomeController> logger;

	public HomeController(ILogger<HomeController> logger)
	{
		this.logger = logger;
	}

	public string Get()
	{
		// Simple logging
		logger.LogInformation("Hi there!");

		// Logging with templates
		logger.LogInformation("The time on the server is {time}.", DateTime.UtcNow);

		// Logging exceptions
		logger.LogError(exception, "Woops, an error occurred");
		
		// Logging exceptions with templates
		logger.LogError(exception, "Woops, an error occurred executing {action} at {date}", this.ControllerContext.ActionDescriptor.ActionName, DateTime.UtcNow);

		// Logging with scopes
		using (logger.BeginScope(42))
		{
			logger.LogInformation("This message will have forty-two stored with it");
		}

		// Logging with multiple scopes and scope templates.
		using (logger.BeginScope(42))
		using (logger.BeginScope("The current user is {user}", User.Identity.Name))
		using (logger.BeginKeyValueScope(nameof(totalCount), totalCount))
		{
			logger.LogInformation("This log will contain forty-two, the current signed in user name, and a key-value pair containing the name of the totalCount variable and its value.");
		}
		
		...
	}
}

3. 完成！

需要帮助？请参阅 示例应用。