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

enable logging config #581

Merged
merged 1 commit into from
Mar 26, 2024
Merged

enable logging config #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/SkyApm.Abstractions/Config/InstrumentConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ namespace SkyApm.Config
[Config("SkyWalking")]
public class InstrumentConfig
{
public string Enable { get; set; }

public string Namespace { get; set; }

[Obsolete("Use ServiceName.")]
Expand Down
25 changes: 23 additions & 2 deletions src/SkyApm.Agent.Hosting/Extensions/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
*
*/

using System;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using SkyApm.Config;
using SkyApm.Diagnostics;
Expand All @@ -32,7 +34,6 @@
using SkyApm.Utilities.Configuration;
using SkyApm.Utilities.DependencyInjection;
using SkyApm.Utilities.Logging;
using System;
using SkyApm;
using SkyApm.Agent.Hosting;
using SkyApm.Diagnostics.MSLogging;
Expand All @@ -46,10 +47,30 @@ public static class ServiceCollectionExtensions
{
public static IServiceCollection AddSkyAPM(this IServiceCollection services, Action<SkyApmExtensions> extensionsSetup = null)
{
string environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
if (environment == null || environment.Length < 1)
{
environment = "Development";
}
IConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddJsonFile("skyapm.json", true);
configurationBuilder.AddJsonFile("skyapm." + environment + ".json", true);
IConfiguration configuration = configurationBuilder.Build();
string enable = configuration?.GetSection("SkyWalking:Enable").Value ?? "false";
if (null == enable || !"true".Equals(enable.ToLower()))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enable/disable skywalking agent by config file

{
return services;
}
string serviceName = configuration?.GetSection("SkyWalking:ServiceName").Value ?? "";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get service name from config file instead of environment variable (for windows services)

if (null == serviceName || serviceName.Length < 1)
{
return services;
}
Environment.SetEnvironmentVariable("SKYWALKING__SERVICENAME", serviceName);
services.AddSkyAPMCore(extensionsSetup);
return services;
}

private static IServiceCollection AddSkyAPMCore(this IServiceCollection services, Action<SkyApmExtensions> extensionsSetup = null)
{
if (services == null)
Expand Down
39 changes: 23 additions & 16 deletions src/SkyApm.Utilities.Configuration/ConfigurationBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,29 @@ public static IConfigurationBuilder AddSkyWalkingDefaultConfig(this IConfigurati
var defaultLogFile = Path.Combine("logs", "skyapm-{Date}.log");
var defaultConfig = new Dictionary<string, string>
{
{"SkyWalking:Namespace", configuration?.GetSection("SkyWalking:Namespace").Value ?? string.Empty },
{"SkyWalking:ServiceName", configuration?.GetSection("SkyWalking:ServiceName").Value ?? "My_Service" },
{"Skywalking:ServiceInstanceName", configuration?.GetSection("SkyWalking:ServiceInstanceName").Value ?? BuildDefaultServiceInstanceName() },
{"SkyWalking:HeaderVersions:0", configuration?.GetSection("SkyWalking:HeaderVersions:0").Value ?? HeaderVersions.SW8 },
{"SkyWalking:Sampling:SamplePer3Secs", configuration?.GetSection("SkyWalking:Sampling:SamplePer3Secs").Value ?? "-1" },
{"SkyWalking:Sampling:Percentage", configuration?.GetSection("SkyWalking:Sampling:Percentage").Value ?? "-1" },
{"SkyWalking:Logging:Level", configuration?.GetSection("SkyWalking:Logging:Level").Value ?? "Information" },
{"SkyWalking:Logging:FilePath", configuration?.GetSection("SkyWalking:Logging:FilePath").Value ?? defaultLogFile },
{"SkyWalking:Transport:Interval", configuration?.GetSection("SkyWalking:Transport:Interval").Value ?? "3000" },
{"SkyWalking:Transport:ProtocolVersion", configuration?.GetSection("SkyWalking:Transport:ProtocolVersion").Value ?? ProtocolVersions.V8 },
{"SkyWalking:Transport:QueueSize", configuration?.GetSection("SkyWalking:Transport:QueueSize").Value ?? "30000" },
{"SkyWalking:Transport:BatchSize", configuration?.GetSection("SkyWalking:Transport:BatchSize").Value ?? "3000" },
{"SkyWalking:Transport:gRPC:Servers",configuration?.GetSection("SkyWalking:Transport:gRPC:Servers").Value ?? "localhost:11800" },
{"SkyWalking:Transport:gRPC:Timeout",configuration?.GetSection("SkyWalking:Transport:gRPC:Timeout").Value ?? "10000" },
{"SkyWalking:Transport:gRPC:ReportTimeout",configuration?.GetSection("SkyWalking:Transport:gRPC:ReportTimeout").Value ?? "600000" },
{"SkyWalking:Transport:gRPC:ConnectTimeout",configuration?.GetSection("SkyWalking:Transport:gRPC:ConnectTimeout").Value ?? "10000" }
{ "SkyWalking:Enable", configuration?.GetSection("SkyWalking:Enable").Value ?? "true" },
{ "SkyWalking:Namespace", configuration?.GetSection("SkyWalking:Namespace").Value ?? string.Empty },
{ "SkyWalking:ServiceName", configuration?.GetSection("SkyWalking:ServiceName").Value ?? "My_Service" },
{ "Skywalking:ServiceInstanceName", configuration?.GetSection("SkyWalking:ServiceInstanceName").Value ?? BuildDefaultServiceInstanceName() },
{ "SkyWalking:HeaderVersions:0", configuration?.GetSection("SkyWalking:HeaderVersions:0").Value ?? HeaderVersions.SW8 },
{ "SkyWalking:Sampling:SamplePer3Secs", configuration?.GetSection("SkyWalking:Sampling:SamplePer3Secs").Value ?? "-1" },
{ "SkyWalking:Sampling:Percentage", configuration?.GetSection("SkyWalking:Sampling:Percentage").Value ?? "-1" },
{ "SkyWalking:Logging:Level", configuration?.GetSection("SkyWalking:Logging:Level").Value ?? "Information" },
{ "SkyWalking:Logging:FilePath", configuration?.GetSection("SkyWalking:Logging:FilePath").Value ?? defaultLogFile },
{ "SkyWalking:Logging:FileSizeLimitBytes", configuration?.GetSection("SkyWalking:Logging:FileSizeLimitBytes").Value ?? "268435456" },
{ "SkyWalking:Logging:FlushToDiskInterval", configuration?.GetSection("SkyWalking:Logging:FlushToDiskInterval").Value ?? "1000" },
{ "SkyWalking:Logging:RollingInterval", configuration?.GetSection("SkyWalking:Logging:RollingInterval").Value ?? "Day" },
{ "SkyWalking:Logging:RollOnFileSizeLimit", configuration?.GetSection("SkyWalking:Logging:RollOnFileSizeLimit").Value ?? "false" },
{ "SkyWalking:Logging:RetainedFileCountLimit", configuration?.GetSection("SkyWalking:Logging:RetainedFileCountLimit").Value ?? "10" },
{ "SkyWalking:Logging:RetainedFileTimeLimit", configuration?.GetSection("SkyWalking:Logging:RetainedFileTimeLimit").Value ?? "864000000" },
{ "SkyWalking:Transport:Interval", configuration?.GetSection("SkyWalking:Transport:Interval").Value ?? "3000" },
{ "SkyWalking:Transport:ProtocolVersion", configuration?.GetSection("SkyWalking:Transport:ProtocolVersion").Value ?? ProtocolVersions.V8 },
{ "SkyWalking:Transport:QueueSize", configuration?.GetSection("SkyWalking:Transport:QueueSize").Value ?? "30000" },
{ "SkyWalking:Transport:BatchSize", configuration?.GetSection("SkyWalking:Transport:BatchSize").Value ?? "3000" },
{ "SkyWalking:Transport:gRPC:Servers", configuration?.GetSection("SkyWalking:Transport:gRPC:Servers").Value ?? "localhost:11800" },
{ "SkyWalking:Transport:gRPC:Timeout", configuration?.GetSection("SkyWalking:Transport:gRPC:Timeout").Value ?? "10000" },
{ "SkyWalking:Transport:gRPC:ReportTimeout", configuration?.GetSection("SkyWalking:Transport:gRPC:ReportTimeout").Value ?? "600000" },
{ "SkyWalking:Transport:gRPC:ConnectTimeout", configuration?.GetSection("SkyWalking:Transport:gRPC:ConnectTimeout").Value ?? "10000" }
};
return builder.AddInMemoryCollection(defaultConfig);
}
Expand Down
26 changes: 20 additions & 6 deletions src/SkyApm.Utilities.Logging/DefaultLoggerFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,29 @@ public DefaultLoggerFactory(IConfigAccessor configAccessor)
_loggerFactory = new MSLoggerFactory();
var instrumentationConfig = configAccessor.Get<InstrumentConfig>();

var level = EventLevel(_loggingConfig.Level);
var __level = EventLevel(_loggingConfig.Level);
long __fileSizeLimitBytes = _loggingConfig.FileSizeLimitBytes ?? 1024 * 1024 * 256;
long __flushToDiskInterval = _loggingConfig.FlushToDiskInterval ?? 1000;
string __rollingInterval = _loggingConfig.RollingInterval ?? "Day";
bool __rollOnFileSizeLimit = _loggingConfig.RollOnFileSizeLimit ?? false;
int __retainedFileCountLimit = _loggingConfig.RetainedFileCountLimit ?? 10;
long __retainedFileTimeLimit = _loggingConfig.RetainedFileTimeLimit ?? 1000 * 60 * 60 * 24 * 10;

_loggerFactory.AddSerilog(new LoggerConfiguration().MinimumLevel.Verbose().Enrich
.WithProperty("SourceContext", null).Enrich
.WithProperty(nameof(instrumentationConfig.ServiceName),
instrumentationConfig.ServiceName).Enrich
//_loggingConfig.FilePath, level, outputTemplate, null, 1073741824,31, null, false, false, TimeSpan.FromMilliseconds(500)
.FromLogContext().WriteTo.Async(o =>
o.File(_loggingConfig.FilePath, level, outputTemplate, flushToDiskInterval: TimeSpan.FromMilliseconds(500), rollingInterval: RollingInterval.Month))
.WithProperty(nameof(instrumentationConfig.ServiceName), instrumentationConfig.ServiceName).Enrich
.FromLogContext()
.WriteTo
.Async(o => o.File(
_loggingConfig.FilePath,
__level,
outputTemplate,
fileSizeLimitBytes: __fileSizeLimitBytes,
flushToDiskInterval: TimeSpan.FromMilliseconds(__flushToDiskInterval),
rollingInterval: (RollingInterval)(Enum.Parse(typeof(RollingInterval), __rollingInterval)),
rollOnFileSizeLimit: __rollOnFileSizeLimit,
retainedFileCountLimit: __retainedFileCountLimit,
retainedFileTimeLimit: TimeSpan.FromMilliseconds(__retainedFileTimeLimit)))
.CreateLogger());
}

Expand Down
20 changes: 19 additions & 1 deletion src/SkyApm.Utilities.Logging/LoggingConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,23 @@ public class LoggingConfig
public string Level { get; set; }

public string FilePath { get; set; }

public long? FileSizeLimitBytes { get; set; }

/// <summary>
/// in milliseconds
/// </summary>
public long? FlushToDiskInterval { get; set; }

public string RollingInterval { get; set; }

public bool? RollOnFileSizeLimit { get; set; }

public int? RetainedFileCountLimit { get; set; }

/// <summary>
/// in milliseconds
/// </summary>
public long? RetainedFileTimeLimit { get; set; }
}
}
}
Loading