tk/Ocelot
1
0
Fork 0
mirror of https://github.com/nsnail/Ocelot.git synced 2025-06-19 12:58:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add LogError(string) to logger

Browse Source 
Added LogError(string) to interface as sometimes there isn't an exception
to be logged. Additionally, split Logger and LoggerFactory implementations
into seperate files just for tidiness.

Additonally added some very basic unit tests to the HttpDataRepository as
a bit of regression safety and to prove that Get never returns a null.

Slightly refactored the logic within AspDotNetLogger under
GetMessageWithOcelotRequestId so that the if statement is a little easier
to read. Attempted to remove the requestId == null, however this broke
numerous tests as the mocks don't set the behviour for dataReposioty
getting the requestId
This commit is contained in:
Marc Denman
2017-03-14 11:52:44 +00:00
parent c01f778bf9
commit 0ad41aa3fa
5 changed files with 152 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/Ocelot/Logging/AspDotNetLogger.cs Normal file
View File

@ -0,0 +1,49 @@
using System;
using Microsoft.Extensions.Logging;
using Ocelot.Infrastructure.RequestData;
namespace Ocelot.Logging
{
public class AspDotNetLogger : IOcelotLogger
{
private readonly ILogger _logger;
private readonly IRequestScopedDataRepository _scopedDataRepository;
public AspDotNetLogger(ILogger logger, IRequestScopedDataRepository scopedDataRepository)
{
_logger = logger;
_scopedDataRepository = scopedDataRepository;
}
public void LogTrace(string message, params object[] args)
{
_logger.LogTrace(GetMessageWithOcelotRequestId(message), args);
}
public void LogDebug(string message, params object[] args)
{
_logger.LogDebug(GetMessageWithOcelotRequestId(message), args);
}
public void LogError(string message, Exception exception)
{
_logger.LogError(GetMessageWithOcelotRequestId(message), exception);
}
public void LogError(string message, params object[] args)
{
_logger.LogError(GetMessageWithOcelotRequestId(message), args);
}
private string GetMessageWithOcelotRequestId(string message)
{
var requestId = _scopedDataRepository.Get<string>("RequestId");
if (requestId == null || requestId.IsError)
{
return $"{message} : OcelotRequestId - not set";
}
return $"{message} : OcelotRequestId - {requestId.Data}";
}
}
}

23
src/Ocelot/Logging/AspDotNetLoggerFactory.cs Normal file
View File

@ -0,0 +1,23 @@
using Microsoft.Extensions.Logging;
using Ocelot.Infrastructure.RequestData;
namespace Ocelot.Logging
{
public class AspDotNetLoggerFactory : IOcelotLoggerFactory
{
private readonly ILoggerFactory _loggerFactory;
private readonly IRequestScopedDataRepository _scopedDataRepository;
public AspDotNetLoggerFactory(ILoggerFactory loggerFactory, IRequestScopedDataRepository scopedDataRepository)
{
_loggerFactory = loggerFactory;
_scopedDataRepository = scopedDataRepository;
}
public IOcelotLogger CreateLogger<T>()
{
var logger = _loggerFactory.CreateLogger<T>();
return new AspDotNetLogger(logger, _scopedDataRepository);
}
}
}

64
src/Ocelot/Logging/IOcelotLoggerFactory.cs
View File

@ -1,6 +1,4 @@
using System;
using Microsoft.Extensions.Logging;
using Ocelot.Infrastructure.RequestData;
namespace Ocelot.Logging
{
@ -8,68 +6,14 @@ namespace Ocelot.Logging
{
IOcelotLogger CreateLogger<T>();
}
public class AspDotNetLoggerFactory : IOcelotLoggerFactory
{
private readonly ILoggerFactory _loggerFactory;
private readonly IRequestScopedDataRepository _scopedDataRepository;
public AspDotNetLoggerFactory(ILoggerFactory loggerFactory, IRequestScopedDataRepository scopedDataRepository)
{
_loggerFactory = loggerFactory;
_scopedDataRepository = scopedDataRepository;
}
public IOcelotLogger CreateLogger<T>()
{
var logger = _loggerFactory.CreateLogger<T>();
return new AspDotNetLogger(logger, _scopedDataRepository);
}
}
/// <summary>
/// Thin wrapper around the DotNet core logging framework, used to allow the scopedDataRepository to be injected giving access to the Ocelot RequestId
/// </summary>
public interface IOcelotLogger
{
void LogTrace(string message, params object[] args);
void LogDebug(string message, params object[] args);
void LogError(string message, Exception exception);
}
public class AspDotNetLogger : IOcelotLogger
{
private readonly ILogger _logger;
private readonly IRequestScopedDataRepository _scopedDataRepository;
public AspDotNetLogger(ILogger logger, IRequestScopedDataRepository scopedDataRepository)
{
_logger = logger;
_scopedDataRepository = scopedDataRepository;
}
public void LogTrace(string message, params object[] args)
{
_logger.LogTrace(GetMessageWithOcelotRequestId(message), args);
}
public void LogDebug(string message, params object[] args)
{
_logger.LogDebug(GetMessageWithOcelotRequestId(message), args);
}
public void LogError(string message, Exception exception)
{
_logger.LogError(GetMessageWithOcelotRequestId(message), exception);
}
private string GetMessageWithOcelotRequestId(string message)
{
var requestId = _scopedDataRepository.Get<string>("RequestId");
if (requestId != null && !requestId.IsError)
{
return $"{message} : OcelotRequestId - {requestId.Data}";
}
return $"{message} : OcelotRequestId - not set";
}
void LogError(string message, params object[] args);
}
}

6
src/Ocelot/Responder/Middleware/ResponderMiddleware.cs
View File

@ -35,16 +35,16 @@ namespace Ocelot.Responder.Middleware
public async Task Invoke(HttpContext context)
{
_logger.LogTrace($"entered {MiddlwareName}");
_logger.LogDebug($"invoking next middleware from {MiddlwareName}");
_logger.LogTrace($"invoking next middleware from {MiddlwareName}");
await _next.Invoke(context);
_logger.LogDebug($"returned to {MiddlwareName} after next middleware completed");
_logger.LogTrace($"returned to {MiddlwareName} after next middleware completed");
if (PipelineError)
{
var errors = PipelineErrors;
_logger.LogDebug($"{errors.Count} pipeline errors found in {MiddlwareName}. Setting error response status code");
_logger.LogError($"{errors.Count} pipeline errors found in {MiddlwareName}. Setting error response status code");
SetErrorResponse(context, errors);
}