为 api 控制器自动记录消息

Question

I have the following controller method in my Entity Framework Core project.

I just started learning about .NetCore logging and I love it!

However I have a feeling it might become difficult to attach logging to all of my controllers.

Currently my project has quite a few controllers for various endpoints.

I started adding logging code, and I fear that I may be making it more difficult than needs to be.

So I inject the logger, then I create a few strings like Message , Controller , and ErrorMessage .

I then assign values to those inside the controller method as needed.

I was wondering if there was a way to do this in a more automated way instead of manually all that to every controller method.

Unfortunately I can't create a base class because my controllers need to use ControllerBase .

[Route("api/[controller]")]
[ApiController]
public class PetrolStationController : ControllerBase
{
    private readonly petrol_ProdContext _context;
    private readonly ILogger _logger;

    public PetrolStationController(petrol_ProdContext context, ILogger<PetrolStationController> logger)
    {
        _context = context;
        _stationService = stationService;
        _logger = logger;
    }

    public string Message { get; set; }
    public string Controller { get; set; }
    public string ErrorMessage { get; set; }

    [HttpGet("GetStationNodeObject/{stationId}")]
    public async Task<ActionResult<StationList>> GetStationLocation(Guid stationID)
    {
        Controller = this.GetType().Name.ToString();

        var stationList = await _context.StationList.FindAsync(stationID);

        if (stationList == null)
        {
            ErrorMessage = "stationID does not exist";
            Message = $"Endpoint: {Controller}: {DateTime.UtcNow.ToLongTimeString()} => {ErrorMessage}";
            _logger.LogInformation(Message);
            return NotFound();
        }

        var petrolStation = await _stationService.GetStationLocation(stationID);
        Message = $"Endpoint: {Controller}: {DateTime.UtcNow.ToLongTimeString()}, Success!";
        _logger.LogInformation(Message);

        return petrolStation;
    }
}

I was hoping someone could provide some insight for a better way of doing this.

thank you all

Answer 1

Check this tutorial: https://nblumhardt.com/2019/10/serilog-in-aspnetcore-3/

I am using this approach quit often. This will log all exceptions automatically and if you want more you can easily add it inside your controller. Biggest PRO is that you set up everything at one place and you get uniform log format. You can use log server or file to save logs.