Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Us/#96733 add orleans log tags #260

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Us/#96733 add orleans log tags #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f3ad0fd
#96733 add orlens log params to unencrypted tags
Nov 11, 2019
72c0ff2
#96733 check max tag count
Nov 17, 2019
a110930
Merge branch 'develop' into us/#96733_AddOrleansLogTags
Nov 18, 2019
6936f31
Merge branch 'develop' into us/#96733_AddOrleansLogTags
Jan 22, 2020
e001e83
Merge pull request #283 from gigya/us/#98496_https_between_microservices
yonatan-d-sap Feb 2, 2020
d1e6053
Merge branch 'develop' into us/#96733_AddOrleansLogTags
Feb 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 145 additions & 112 deletions Gigya.Microdot.Orleans.Hosting/Logging/OrleansLogAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,113 +1,146 @@
#region Copyright
// Copyright 2017 Gigya Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#endregion

using System;
using System.Diagnostics;
using Gigya.Microdot.Interfaces.Logging;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions.Internal;

namespace Gigya.Microdot.Orleans.Hosting.Logging
{
public class OrleansLogAdapter : ILogger
{
private readonly OrleansLogEnrichment _logEnrichment;
private readonly ILog _logImplementation;
private readonly Func<OrleansConfig> _orleansConfigFunc;
private readonly string _categoryUnderline;

public OrleansLogAdapter(string category, Func<string, ILog> logImplementation, OrleansLogEnrichment logEnrichment, Func<OrleansConfig> orleansConfigFunc)
{
_categoryUnderline = category?.Replace(".", "_"); // The element in config, contains '_' for every '.' in class name
_logEnrichment = logEnrichment;
_orleansConfigFunc = orleansConfigFunc;
_logImplementation = logImplementation(category);
}

public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
{
string eventHeuristicName = null;
if (eventId.Name == null)
{
_logEnrichment.HeuristicEventIdToName.TryGetValue(eventId.Id, out eventHeuristicName);
}

var logMessage = formatter(state, exception);

Action<LogDelegate> action = _ => _(logMessage, exception: exception, unencryptedTags: new { eventId.Id, eventId.Name, IsOrleansLog = true, eventHeuristicName });
var level = TraceEventType.Critical;
switch (logLevel)
{
case LogLevel.Trace:
level = TraceEventType.Verbose;
break;
case LogLevel.Debug:
level = TraceEventType.Verbose;
break;
case LogLevel.Information:
level = TraceEventType.Information;
break;
case LogLevel.Warning:
level = TraceEventType.Warning;
break;
case LogLevel.Error:
level = TraceEventType.Error;
break;
case LogLevel.Critical:
level = TraceEventType.Critical;
break;
case LogLevel.None:
return;
}
_logImplementation.Write(level, action);

}

public bool IsEnabled(LogLevel logLevel)
{
// #ORLEANS2 [Done] We paid attention to massive GC when deactivation of huge amount of grains
// as orleans code concatenates grain ids for the log entry
// see more details in https://github.com/dotnet/orleans/issues/5851

var config = _orleansConfigFunc();

// Configure the log level according to the category.
if(_categoryUnderline != null && config.CategoryLogLevels.Count >0)
if (config.CategoryLogLevels.TryGetValue(_categoryUnderline, out var configLogLevel))
{
return logLevel >= configLogLevel.LogLevel;
}

return logLevel >= config.DefaultCategoryLogLevel;
}

public IDisposable BeginScope<TState>(TState state)
{
return NullScope.Instance;
}

public void Write(TraceEventType level, Action<LogDelegate> log, string file = "", int line = 0, string method = null)
{
_logImplementation.Write(level, log, file, line, method);
}
}
#region Copyright
// Copyright 2017 Gigya Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#endregion

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Dynamic;
using System.Linq;
using Gigya.Microdot.Interfaces.Logging;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions.Internal;
using Microsoft.Extensions.Logging.Internal;

namespace Gigya.Microdot.Orleans.Hosting.Logging
{
public class OrleansLogAdapter : ILogger
{
private readonly int _maxNumberOfTags = 20;
private readonly string[] _logKeysToIgnore = { "{OriginalFormat}" };
private readonly OrleansLogEnrichment _logEnrichment;
private readonly ILog _logImplementation;
private readonly Func<OrleansConfig> _orleansConfigFunc;
private readonly string _categoryUnderline;

public OrleansLogAdapter(string category, Func<string, ILog> logImplementation, OrleansLogEnrichment logEnrichment, Func<OrleansConfig> orleansConfigFunc)
{
_categoryUnderline = category?.Replace(".", "_"); // The element in config, contains '_' for every '.' in class name
_logEnrichment = logEnrichment;
_orleansConfigFunc = orleansConfigFunc;
_logImplementation = logImplementation(category);
}

public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
{
string eventHeuristicName = null;
if (eventId.Name == null)
{
_logEnrichment.HeuristicEventIdToName.TryGetValue(eventId.Id, out eventHeuristicName);
}

var logMessage = formatter(state, exception);

var unencryptedTags = new Dictionary<string, object>
{
{"eventId.Id", eventId.Id},
{"eventId.Name", eventId.Name},
{"IsOrleansLog", true},
{"eventHeuristicName", eventHeuristicName}
};

int numberOfTags = unencryptedTags.Count;

if (state is FormattedLogValues values)
{
for (var i = 0; i < values.Count && i < _maxNumberOfTags - numberOfTags; i++)
{
var value = values[i];
if (!_logKeysToIgnore.Contains(value.Key))
{
unencryptedTags[value.Key] = value.Value;
}
}
}

var level = TraceEventType.Critical;
switch (logLevel)
{
case LogLevel.Trace:
level = TraceEventType.Verbose;
break;
case LogLevel.Debug:
level = TraceEventType.Verbose;
break;
case LogLevel.Information:
level = TraceEventType.Information;
break;
case LogLevel.Warning:
level = TraceEventType.Warning;
break;
case LogLevel.Error:
level = TraceEventType.Error;
break;
case LogLevel.Critical:
level = TraceEventType.Critical;
break;
case LogLevel.None:
return;
}
_logImplementation.Write(level, LogDelegateAction);

void LogDelegateAction(LogDelegate logDelegate)
{
logDelegate(logMessage, exception: exception, unencryptedTags: unencryptedTags);
}

}


public bool IsEnabled(LogLevel logLevel)
{
// #ORLEANS2 [Done] We paid attention to massive GC when deactivation of huge amount of grains
// as orleans code concatenates grain ids for the log entry
// see more details in https://github.com/dotnet/orleans/issues/5851

var config = _orleansConfigFunc();

// Configure the log level according to the category.
if(_categoryUnderline != null && config.CategoryLogLevels.Count >0)
if (config.CategoryLogLevels.TryGetValue(_categoryUnderline, out var configLogLevel))
{
return logLevel >= configLogLevel.LogLevel;
}

return logLevel >= config.DefaultCategoryLogLevel;
}

public IDisposable BeginScope<TState>(TState state)
{
return NullScope.Instance;
}

public void Write(TraceEventType level, Action<LogDelegate> log, string file = "", int line = 0, string method = null)
{
_logImplementation.Write(level, log, file, line, method);
}
}
}
Loading