Logging

    In Umbraco we use the underlying logging framework of Serilog.

    Out of the box we write a JSON log file that contains a more rich logfile, that allows tools to perform searches & correlation on log patterns a lot easier.

    The default location of this file is written to umbraco/Logs and contains the Machine name, along with the date too:

    • umbraco/Logs/UmbracoTraceLog.DELLBOOK.20210809.json

    Structured logging

    Serilog is a logging framework that allows us to do structured logging or write log messages using the message template format. This allows us to have a more detailed log message, rather than the traditional text message in a long txt file.

    2021-08-10 09:33:23,677 [P25776/D1/T22] INFO   Umbraco.Cms.Core.Services.Implement.ContentService - Document Home (id=1062) has been published.

    Here is an example of the same log message represented as JSON, you can see here we have much more information that would allow us to search & filter logs based on these properties with an appropriate logging system.

    {
      "@t":"2021-08-10T08:33:23.6778640Z",
      "@mt":"Document {ContentName} (id={ContentId}) has been published.",
      "ContentName":"Home",
      "ContentId":1062,
      "SourceContext":"Umbraco.Cms.Core.Services.Implement.ContentService",
      "ActionId":"7726d745-d502-4b2d-b55e-97731308041b",
      "ActionName":"Umbraco.Cms.Web.BackOffice.Controllers.ContentController.PostSave (Umbraco.Web.BackOffice)",
      "RequestId":"8000000c-0012-fb00-b63f-84710c7967bb",
      "RequestPath":"/umbraco/backoffice/umbracoapi/content/PostSave",
      "ProcessId":25776,
      "ProcessName":"iisexpress",
      "ThreadId":22,
      "AppDomainId":1,
      "AppDomainAppId":"2f4961977e5c252fa708f7d83915c269b53a620c",
      "MachineName":"DELLBOOK",
      "Log4NetLevel":"INFO ",
      "HttpRequestId":"318b6dd4-b127-4da3-8339-37701f4d1416",
      "HttpRequestNumber":4,
      "HttpSessionId":"0cea7395-ba29-e6c6-93ee-7c08a2fd7219"
    }

    To learn more about structured logging and message templates you can read more about it over on the https://messagetemplates.org website or alternatively watch this video from the Serilog creator - https://www.youtube.com/watch?v=OhmNp8UPEEg

    Writing to the log

    Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed, so you can get further insights and details about your implementation.

    Here is an example of using the logger to write an Information message to the log which will contain one property of Name which will output the name variable that is passed into the method

    using Microsoft.AspNetCore.Mvc;
    using Microsoft.Extensions.Logging;
    using Umbraco.Cms.Web.Common.Controllers;
    
    namespace Umbraco.Cms.Web.UI.NetCore
    {
        public class MyApiController : UmbracoApiController
        {
            private readonly ILogger<MyApiController> _logger;
    
            public MyApiController(ILogger<MyApiController> logger)
            {
                _logger = logger;
            }
    
            /// /umbraco/api/MyApi/SayHello?name=John
            [HttpGet]
            public string SayHello(string name)
            {
                _logger.LogInformation("We are saying hello to {Name}", name);
                return $"Hello {name}";
            }
        }
    }
    

    The incorrect way to log the message would be use string interpolation or string concatenation such as

    //GOOD - Do use :)
    _logger.LogInformation("We are saying hello to {Name}", name);
    
    //BAD - Do not use :(
    _logger.LogInformation($"We are saying hello to {name}");
    
    //BAD - Do not use :(
    _logger.LogInformation("We are saying hello to " + name);
    

    The bad examples above will write to the log file, but we will not get a separate property logged with the message. This means we can't find them by searching for log messages that use the message template We are saying hello to {Name}

    Log Levels

    Serilog uses levels as the primary means for assigning importance to log events. The levels in increasing order of importance are:

    1. Verbose - tracing information and debugging minutiae; generally only switched on in unusual situations
    2. Debug - internal control flow and diagnostic state dumps to facilitate pinpointing of recognised problems
    3. Information - events of interest or that have relevance to outside observers; the default enabled minimum logging level
    4. Warning - indicators of possible issues or service/functionality degradation
    5. Error - indicating a failure within the application or connected system
    6. Fatal - critical errors causing complete failure of the application

    Configuration

    Serilog can be configured and extended by using the .NETCore configuration such as the AppSetting.json files or environment variables. Info on the Serilog config here.

    The logviewer dashboard

    Learn more about the logviewer dashboard in the backoffice and how it can be extended.

    The logviewer desktop app

    This is a tool for viewing & querying JSON log files from disk in the same way as the built in log viewer dashboard.

    English badge

    Serilog project/references shipped

    Umbraco ships with the following Serilog projects, where you can find further information & details with the GitHub readme files as needed.

    Further Resources

    If you are interested in learning more then the following resources will beneficial: