From c1f12f3ee6fbfb86a5f3ad34763288a68a254ad0 Mon Sep 17 00:00:00 2001 From: lu-xiaoshuang <121755080+lu-xiaoshuang@users.noreply.github.com> Date: Thu, 18 May 2023 12:00:00 +0800 Subject: [PATCH] fix bad names for logs of observability --- .../{ILoggerReporter.cs => ILogReporter.cs} | 4 +-- .../Transport/ISkyApmLogDispatcher.cs | 2 +- .../{LoggerRequest.cs => LogRequest.cs} | 8 ++--- .../Extensions/ServiceCollectionExtensions.cs | 2 +- .../AsyncQueueSkyApmLogDispatcher.cs | 27 +++++++++-------- .../SkyApmLogger.cs | 4 +-- .../SkyApm.Transport.Grpc.csproj | 2 +- .../V8/{LoggerReporter.cs => LogReporter.cs} | 30 +++++++++---------- 8 files changed, 40 insertions(+), 39 deletions(-) rename src/SkyApm.Abstractions/Transport/{ILoggerReporter.cs => ILogReporter.cs} (90%) rename src/SkyApm.Abstractions/Transport/{LoggerRequest.cs => LogRequest.cs} (88%) rename src/SkyApm.Transport.Grpc/V8/{LoggerReporter.cs => LogReporter.cs} (77%) diff --git a/src/SkyApm.Abstractions/Transport/ILoggerReporter.cs b/src/SkyApm.Abstractions/Transport/ILogReporter.cs similarity index 90% rename from src/SkyApm.Abstractions/Transport/ILoggerReporter.cs rename to src/SkyApm.Abstractions/Transport/ILogReporter.cs index 66fd3ba6..3ea4426e 100644 --- a/src/SkyApm.Abstractions/Transport/ILoggerReporter.cs +++ b/src/SkyApm.Abstractions/Transport/ILogReporter.cs @@ -24,9 +24,9 @@ namespace SkyApm.Transport { - public interface ILoggerReporter + public interface ILogReporter { - Task ReportAsync(IReadOnlyCollection loggerRequests, + Task ReportAsync(IReadOnlyCollection logRequests, CancellationToken cancellationToken = default(CancellationToken)); } } diff --git a/src/SkyApm.Abstractions/Transport/ISkyApmLogDispatcher.cs b/src/SkyApm.Abstractions/Transport/ISkyApmLogDispatcher.cs index 894383b4..c67cb7c0 100644 --- a/src/SkyApm.Abstractions/Transport/ISkyApmLogDispatcher.cs +++ b/src/SkyApm.Abstractions/Transport/ISkyApmLogDispatcher.cs @@ -23,7 +23,7 @@ namespace SkyApm.Transport { public interface ISkyApmLogDispatcher { - bool Dispatch(LoggerRequest loggerRequest); + bool Dispatch(LogRequest logRequest); Task Flush(CancellationToken token = default(CancellationToken)); diff --git a/src/SkyApm.Abstractions/Transport/LoggerRequest.cs b/src/SkyApm.Abstractions/Transport/LogRequest.cs similarity index 88% rename from src/SkyApm.Abstractions/Transport/LoggerRequest.cs rename to src/SkyApm.Abstractions/Transport/LogRequest.cs index 8a3bbc37..ac2640b8 100644 --- a/src/SkyApm.Abstractions/Transport/LoggerRequest.cs +++ b/src/SkyApm.Abstractions/Transport/LogRequest.cs @@ -20,20 +20,20 @@ namespace SkyApm.Transport { - public class LoggerRequest + public class LogRequest { public string Message { get; set; } public Dictionary Tags { get; set; } - public LoggerSegmentReference SegmentReference { get; set; } + public LogSegmentReference SegmentReference { get; set; } public long Date { get; set; } public string Endpoint { get; set; } } - - public class LoggerSegmentReference + + public class LogSegmentReference { public string SegmentId { get; set; } diff --git a/src/SkyApm.Agent.Hosting/Extensions/ServiceCollectionExtensions.cs b/src/SkyApm.Agent.Hosting/Extensions/ServiceCollectionExtensions.cs index 9f45a156..1f9fece1 100644 --- a/src/SkyApm.Agent.Hosting/Extensions/ServiceCollectionExtensions.cs +++ b/src/SkyApm.Agent.Hosting/Extensions/ServiceCollectionExtensions.cs @@ -118,7 +118,7 @@ private static IServiceCollection AddSampling(this IServiceCollection services) private static IServiceCollection AddGrpcTransport(this IServiceCollection services) { services.AddSingleton(); - services.AddSingleton(); + services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); diff --git a/src/SkyApm.Core/Transport/AsyncQueueSkyApmLogDispatcher.cs b/src/SkyApm.Core/Transport/AsyncQueueSkyApmLogDispatcher.cs index b29ecda6..c39261b4 100644 --- a/src/SkyApm.Core/Transport/AsyncQueueSkyApmLogDispatcher.cs +++ b/src/SkyApm.Core/Transport/AsyncQueueSkyApmLogDispatcher.cs @@ -28,42 +28,43 @@ namespace SkyApm.Transport public class AsyncQueueSkyApmLogDispatcher : ISkyApmLogDispatcher { private readonly ILogger _logger; + private readonly CancellationTokenSource _cancellation; - private readonly ConcurrentQueue _segmentQueue; + private readonly ConcurrentQueue _segmentQueue; private readonly IRuntimeEnvironment _runtimeEnvironment; - private readonly ILoggerReporter _loggerReporter; + private readonly ILogReporter _logReporter; private readonly TransportConfig _config; private int _offset; - public AsyncQueueSkyApmLogDispatcher(IConfigAccessor configAccessor, ILoggerFactory loggerFactory, ILoggerReporter loggerReporter, IRuntimeEnvironment runtimeEnvironment) + public AsyncQueueSkyApmLogDispatcher(IConfigAccessor configAccessor, ILoggerFactory loggerFactory, ILogReporter logReporter, IRuntimeEnvironment runtimeEnvironment) { _logger = loggerFactory.CreateLogger(typeof(AsyncQueueSkyApmLogDispatcher)); _config = configAccessor.Get(); _runtimeEnvironment = runtimeEnvironment; - _segmentQueue = new ConcurrentQueue(); + _segmentQueue = new ConcurrentQueue(); _cancellation = new CancellationTokenSource(); - _loggerReporter= loggerReporter; + _logReporter= logReporter; } - public bool Dispatch(LoggerRequest loggerRequest) + public bool Dispatch(LogRequest logRequest) { - if (!_runtimeEnvironment.Initialized || loggerRequest == null) + if (!_runtimeEnvironment.Initialized || logRequest == null) return false; // todo performance optimization for ConcurrentQueue if (_config.QueueSize < _offset || _cancellation.IsCancellationRequested) return false; - _segmentQueue.Enqueue(loggerRequest); + _segmentQueue.Enqueue(logRequest); Interlocked.Increment(ref _offset); - _logger.Debug($"Dispatch trace segment. [SegmentId]={loggerRequest.SegmentReference?.SegmentId}."); + _logger.Debug($"Dispatch trace segment. [SegmentId]={logRequest.SegmentReference?.SegmentId}."); return true; } @@ -71,17 +72,17 @@ public Task Flush(CancellationToken token = default) { var limit = _config.BatchSize; var index = 0; - var loggers = new List(limit); + var logs = new List(limit); while (index++ < limit && _segmentQueue.TryDequeue(out var request)) { - loggers.Add(request); + logs.Add(request); Interlocked.Decrement(ref _offset); } // send async - if (loggers.Count > 0) + if (logs.Count > 0) { - _loggerReporter.ReportAsync(loggers, token); + _logReporter.ReportAsync(logs, token); } return Task.CompletedTask; diff --git a/src/SkyApm.Diagnostics.MSLogging/SkyApmLogger.cs b/src/SkyApm.Diagnostics.MSLogging/SkyApmLogger.cs index 848d05dd..220a52f0 100644 --- a/src/SkyApm.Diagnostics.MSLogging/SkyApmLogger.cs +++ b/src/SkyApm.Diagnostics.MSLogging/SkyApmLogger.cs @@ -71,13 +71,13 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except message += "\r\n" + (exception.HasInnerExceptions() ? exception.ToDemystifiedString(_tracingConfig.ExceptionMaxDepth) : exception.ToString()); } SegmentContext segmentContext = _segmentContextAccessor.Context; - var logContext = new LoggerRequest() + var logContext = new LogRequest() { Message = message ?? string.Empty, Tags = tags, SegmentReference = segmentContext == null ? null - : new LoggerSegmentReference() + : new LogSegmentReference() { TraceId = segmentContext.TraceId, SegmentId = segmentContext.SegmentId, diff --git a/src/SkyApm.Transport.Grpc/SkyApm.Transport.Grpc.csproj b/src/SkyApm.Transport.Grpc/SkyApm.Transport.Grpc.csproj index e6e87c17..c8173e4c 100644 --- a/src/SkyApm.Transport.Grpc/SkyApm.Transport.Grpc.csproj +++ b/src/SkyApm.Transport.Grpc/SkyApm.Transport.Grpc.csproj @@ -1,6 +1,6 @@  - + $(Product) gRPC data transmitter. $(PackagePrefix).Transport.Grpc diff --git a/src/SkyApm.Transport.Grpc/V8/LoggerReporter.cs b/src/SkyApm.Transport.Grpc/V8/LogReporter.cs similarity index 77% rename from src/SkyApm.Transport.Grpc/V8/LoggerReporter.cs rename to src/SkyApm.Transport.Grpc/V8/LogReporter.cs index 86757938..2ee058ba 100644 --- a/src/SkyApm.Transport.Grpc/V8/LoggerReporter.cs +++ b/src/SkyApm.Transport.Grpc/V8/LogReporter.cs @@ -30,23 +30,23 @@ namespace SkyApm.Transport.Grpc { - public class LoggerReporter : ILoggerReporter + public class LogReporter : ILogReporter { private readonly ConnectionManager _connectionManager; private readonly ILogger _logger; private readonly GrpcConfig _grpcConfig; private readonly InstrumentConfig _instrumentConfig; - public LoggerReporter(ConnectionManager connectionManager, IConfigAccessor configAccessor, + public LogReporter(ConnectionManager connectionManager, IConfigAccessor configAccessor, ILoggerFactory loggerFactory) { _connectionManager = connectionManager; _grpcConfig = configAccessor.Get(); _instrumentConfig = configAccessor.Get(); - _logger = loggerFactory.CreateLogger(typeof(SegmentReporter)); + _logger = loggerFactory.CreateLogger(typeof(LogReporter)); } - public async Task ReportAsync(IReadOnlyCollection loggerRequests, + public async Task ReportAsync(IReadOnlyCollection logRequests, CancellationToken cancellationToken = default) { if (!_connectionManager.Ready) @@ -62,33 +62,33 @@ public async Task ReportAsync(IReadOnlyCollection loggerRequests, using (var asyncClientStreamingCall = client.collect(_grpcConfig.GetMeta(), _grpcConfig.GetReportTimeout(), cancellationToken)) { - foreach (var loggerRequest in loggerRequests) + foreach (var logRequest in logRequests) { var logBody = new LogData() { - Timestamp = loggerRequest.Date, + Timestamp = logRequest.Date, Service = _instrumentConfig.ServiceName, ServiceInstance = _instrumentConfig.ServiceInstanceName, - Endpoint = loggerRequest.Endpoint, + Endpoint = logRequest.Endpoint, Body = new LogDataBody() { Type = "text", Text = new TextLog() { - Text = loggerRequest.Message, + Text = logRequest.Message, }, }, Tags = new LogTags(), }; - if (loggerRequest.SegmentReference != null) + if (logRequest.SegmentReference != null) { logBody.TraceContext = new TraceContext() { - TraceId = loggerRequest.SegmentReference.TraceId, - TraceSegmentId = loggerRequest.SegmentReference.SegmentId, + TraceId = logRequest.SegmentReference.TraceId, + TraceSegmentId = logRequest.SegmentReference.SegmentId, }; } - foreach (var tag in loggerRequest.Tags) + foreach (var tag in logRequest.Tags) { logBody.Tags.Data.Add(new KeyStringValuePair() { @@ -103,17 +103,17 @@ public async Task ReportAsync(IReadOnlyCollection loggerRequests, await asyncClientStreamingCall.ResponseAsync; stopwatch.Stop(); - _logger.Information($"Report {loggerRequests.Count} logs. cost: {stopwatch.Elapsed}s"); + _logger.Information($"Report {logRequests.Count} logs. cost: {stopwatch.Elapsed}s"); } } catch (IOException ex) { - _logger.Error("Report trace segment fail.", ex); + _logger.Error("Report log fail.", ex); _connectionManager.Failure(ex); } catch (Exception ex) { - _logger.Error("Report trace segment fail.", ex); + _logger.Error("Report log fail.", ex); } } }