Использование Graylog и NLog для сбора логов от приложений на C#. Личный опыт

using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection; using System.Runtime.InteropServices; using System.Text; using Newtonsoft.Json; using NLog; using NLog.Config; using NLog.Layouts; using NLog.Targets; using NLog.Targets.GraylogHttp;  namespace BIMLIB.Converter { 	public static class BimlibLogger 	{ 		private static readonly ApplicationSettings _settings = BimlibSettingsManager.Instance.AppSettings; 		private static Lazy<LogFactory> _instance = null; 		private static LoggingConfiguration _logConfig = null;  		private static Lazy<LogFactory> Instance 		{ 			get 			{ 				return _instance ?? (_instance = new Lazy<LogFactory>(BuildLogFactory)); 			} 		}  		public static Logger GetLogger() 		{ 			return Instance.Value.GetCurrentClassLogger(); 		}  		private static LogFactory BuildLogFactory() 		{ 			LoggingConfiguration config = _logConfig ?? new LoggingConfiguration(); 			// Не самый обязательный параметр конфигурации. Но так симпатичнее. 			string headerStr = _settings.LogHeader; 			// Это только выглядит странным. По факту в заголовке может быть что-то сложное, напрмер: https://github.com/drewnoakes/figgle 			Layout header = headerStr;  			// Каждое из этих полей хорошо описано: https://nlog-project.org/config/?tab=layout-renderers 			// Итог рендеринга такой последовательности полей: 			// - для простого сообщения: 2020-04-24 19:13:51.1620 [BIMLIB.Converter.MainClass.Main] -> I : Service starting... 			// - для ошибки: 2020-04-22 09:55:33.1132 [BIMLIB.Converter.Converter.ClearFile] -> E : mscorlib 			//{ 			//	"Type":"System.IO.FileNotFoundException", "Message":"Файл 'D:\\path\\to\\file\\file_name.ifc' не найден.", "FileName":"D:\\path\\to\\file\\file_name.ifc", "Data":{ 			//	}, "TargetSite":"Void WinIOError(Int32, System.String)", "StackTrace":"   в System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)\r\n   в System.IO.FileInfo.get_Length()\r\n   в BIMLIB.Converter.Converter.ClearFile(String path)", "Source":"mscorlib", "HResult":-2147024894}  			Layout layout = "${longdate} [${callsite:className=true:includeNamespace=true:fileName=false:includeSourcePath=false:methodName=true:cleanNamesOfAnonymousDelegates=true:cleanNamesOfAsyncContinuations=true}] -> ${level:format=FirstCharacter} : ${message}${onexception:inner=${newline}${exception:format=@}}";  			#region Targets ----------------------------  			#region FileTarget ----------------------------  			FileTarget fileTarget = FileTarget(header, layout); 			config.AddTarget(fileTarget); 			config.AddRuleForAllLevels(fileTarget);  			#endregion  			#region ConsoleTarget ----------------------------  			ColoredConsoleTarget consoleTarget = ConsoleTarget(header, layout); 			config.AddTarget(consoleTarget); 			config.AddRuleForAllLevels(consoleTarget);  			#endregion  			#region DebuggerTarget ----------------------------  			DebuggerTarget debugTarget = DebuggerTarget(header, layout); 			config.AddTarget(debugTarget); 			config.AddRuleForAllLevels(debugTarget);  			#endregion  			#region GelfTarget ----------------------------  			// Это такая простенькая защита от набивания Graylog лишними логами, пока приложение не боевое 			if (_settings.Statistics) 			{ 				GraylogHttpTarget gelfTarget = GelfTarget(headerStr); 				config.AddTarget(gelfTarget); 				config.AddRuleForAllLevels(gelfTarget); 			}  			#endregion  			#endregion  			LogFactory logFactory = new LogFactory 			{ 				Configuration = config 			};  			try 			{ 				//Не изящно, но расставляем минимальный и максимальный уровень логирования во все правила логирования 				config.LoggingRules.ToList().ForEach(r => r.SetLoggingLevels(LogLevel.AllLevels.Min(), LogLevel.AllLevels.Max()));  				_logConfig = config; 			} 			catch (Exception ex) 			{ 				//Логгера ещё нет, поэтому пока только суда и можно вывести сообщения 				Debug.Write(ex); 			}  			return logFactory; 		}  		#region Target Methods  		private static FileTarget FileTarget(Layout header, Layout layout) 		{ 			#region FileTarget ----------------------------  			FileTarget fileTarget = new FileTarget("log_file_target") 			{ 				ArchiveAboveSize = 1048576, 				ArchiveDateFormat = "yyyy.MM.dd_HH.mm.ss", 				ArchiveEvery = FileArchivePeriod.Day, 				ArchiveFileName = GetApplicationLogAndArchivePath(false), 				ArchiveNumbering = ArchiveNumberingMode.Date, 				ArchiveOldFileOnStartup = false, 				AutoFlush = true, 				ConcurrentWrites = true, 				DeleteOldFileOnStartup = false, 				EnableArchiveFileCompression = true, 				EnableFileDelete = true, 				Encoding = Encoding.UTF8, 				FileName = GetApplicationLogAndArchivePath(true), 				Header = header, 				Layout = layout, 				MaxArchiveFiles = 100, 				OpenFileCacheTimeout = 30, 				OpenFileFlushTimeout = 30, 				OptimizeBufferReuse = true 			};  			#endregion  			return fileTarget; 		}  		private static ColoredConsoleTarget ConsoleTarget(Layout header, Layout layout) 		{ 			#region ConsoleTarget ----------------------------  			ColoredConsoleTarget consoleTarget = new ColoredConsoleTarget("log_console_target") 			{ 				Encoding = Encoding.UTF8, 				EnableAnsiOutput = false,  				UseDefaultRowHighlightingRules = true,  				Layout = layout, 				Header = header 			};  			ConsoleWordHighlightingRule dateHighLightRule = new ConsoleWordHighlightingRule 			{ 				Regex = @"^(?=\d).+(?=\s\[)", 				ForegroundColor = ConsoleOutputColor.Yellow 			};  			ConsoleWordHighlightingRule methodsHighLightRule = new ConsoleWordHighlightingRule 			{ 				Regex = @"(?<=\[).+(?=\])", 				ForegroundColor = ConsoleOutputColor.Blue 			};  			ConsoleWordHighlightingRule levelHighLightRule = new ConsoleWordHighlightingRule 			{ 				Regex = @"(?<=>).+(?=\s:)", 				ForegroundColor = ConsoleOutputColor.Red 			};  			ConsoleWordHighlightingRule messageHighLightRule = new ConsoleWordHighlightingRule 			{ 				Regex = @"(?<=\s:\s).+", 				ForegroundColor = ConsoleOutputColor.Green 			};  			consoleTarget.WordHighlightingRules.Add(dateHighLightRule); 			consoleTarget.WordHighlightingRules.Add(methodsHighLightRule); 			consoleTarget.WordHighlightingRules.Add(levelHighLightRule); 			consoleTarget.WordHighlightingRules.Add(messageHighLightRule);  			#endregion  			return consoleTarget; 		}  		private static DebuggerTarget DebuggerTarget(Layout header, Layout layout) 		{ 			#region DebuggerTarget ----------------------------  			DebuggerTarget debugTarget = new DebuggerTarget("log_debug_target") 			{ 				Layout = layout, 				Header = header 			};  			#endregion  			return debugTarget; 		}  		private static GraylogHttpTarget GelfTarget(string header) 		{ 			#region GelfTarget ----------------------------  			Layout gelfCommonLayout = "${message}";  			IList<TargetPropertyWithContext> gelfParameterInfos = 				new List<TargetPropertyWithContext>() 				{ 					// Все эти дополнительные параметры описаны: https://nlog-project.org/config/?tab=layout-renderers 					new TargetPropertyWithContext()  { Name = "appdomain", Layout = "${appdomain}" }, 					new TargetPropertyWithContext()  { Name = "assembly-version", Layout = "${assembly-version}" }, 					new TargetPropertyWithContext()  { Name = "activityid", Layout = "${activityid}" }, 					new TargetPropertyWithContext()  { Name = "callsite", Layout = "${callsite}" }, 					new TargetPropertyWithContext()  { Name = "callsite-linenumber", Layout = "${callsite-linenumber}" }, 					new TargetPropertyWithContext()  { Name = "environment-user", Layout = "${environment-user:userName=true:domain=true}" }, 					new TargetPropertyWithContext()  { Name = "exeption_json_data", Layout = "${onexception:inner=${exception:format=@}}" }, 					new TargetPropertyWithContext()  { Name = "frameWorkInfo", Layout = $"{RuntimeInformation.FrameworkDescription} ({RuntimeInformation.ProcessArchitecture})" }, 					new TargetPropertyWithContext()  { Name = "guid", Layout = "${guid:format=N}" }, 					new TargetPropertyWithContext()  { Name = "hostname", Layout = "${hostname}" }, 					new TargetPropertyWithContext()  { Name = "identity", Layout = "${identity:authType=true:separator=\n:name=true:isAuthenticated=true}" }, 					new TargetPropertyWithContext()  { Name = "level_name", Layout = "${level:format=Name}" }, 					new TargetPropertyWithContext()  { Name = "local-ip", Layout = "${local-ip:addressFamily=InterNetwork}" }, 					new TargetPropertyWithContext()  { Name = "logger", Layout = "${logger:shortName=false}" }, 					new TargetPropertyWithContext()  { Name = "machinename", Layout = "${machinename}" }, 					new TargetPropertyWithContext()  { Name = "osInfo", Layout = $"{RuntimeInformation.OSDescription} ({RuntimeInformation.OSArchitecture})" }, 					new TargetPropertyWithContext()  { Name = "processid", Layout = "${processid}" }, 					new TargetPropertyWithContext()  { Name = "processinfo_MainWindowHandle", Layout = "${processinfo:property=MainWindowHandle}" }, 					new TargetPropertyWithContext()  { Name = "processinfo_PagedMemorySize", Layout = "${processinfo:property=PagedMemorySize}" }, 					new TargetPropertyWithContext()  { Name = "processname", Layout = "${processname:fullName=true}" }, 					new TargetPropertyWithContext()  { Name = "processtime", Layout = "${processtime:invariant=false}" }, 					new TargetPropertyWithContext()  { Name = "sequenceid", Layout = "${sequenceid}" }, 					new TargetPropertyWithContext()  { Name = "stacktrace", Layout = "${stacktrace:format=Raw:topFrames=3:skipFrames=0:separator=
}" }, 					new TargetPropertyWithContext()  { Name = "threadid", Layout = "${threadid}" }, 					new TargetPropertyWithContext()  { Name = "threadname", Layout = "${threadname}" }, 					new TargetPropertyWithContext()  { Name = "timestamp", Layout = $"{DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()}" }, 					new TargetPropertyWithContext()  { Name = "timestamp_local", Layout = @"${date:universalTime=false:format=yyyy-MM-dd HH\:mm\:ss zzz}" }, 					new TargetPropertyWithContext()  { Name = "windows-identity", Layout = "${windows-identity:userName=true:domain=true}" } 				};  			GraylogHttpTarget gelfUdpTarget = new GraylogHttpTarget 			{ 				AddNLogLevelName = true, 				Facility = header, 				GraylogServer = _settings.LogServerAddress, 				IncludeCallSite = true, 				IncludeCallSiteStackTrace = true, 				IncludeEventProperties = true, 				Layout = gelfCommonLayout, 				Name = "GelfHttp", 				OptimizeBufferReuse = true 			};  			foreach (TargetPropertyWithContext gelfParameterInfo in gelfParameterInfos) 			{ 				gelfUdpTarget.ContextProperties.Add(gelfParameterInfo); 			}  			#endregion  			return gelfUdpTarget; 		}  		#endregion  		private static string GetApplicationLogAndArchivePath(bool isLog) 		{ 			string addition;  			if (!isLog) 			{ 				addition = ".{#}.zip"; 			} 			else 			{ 				addition = ".log"; 			}  			try 			{ 				if (!Directory.Exists(_settings.LogsFolder)) 				{ 					Directory.CreateDirectory(_settings.LogsFolder); 				}  				return Path.Combine(_settings.LogsFolder, _settings.ProductName + addition); 			} 			catch (Exception ex) 			{ 				Debug.Write(ex); 				return string.Empty; 			} 		} } 

using NLog; ...  public static class Downloader 	{ 		... 		private static readonly Logger log = BimlibLogger.GetLogger(); 		... 		public static string GetFileToConvert(ConverterRequest.Inputitem inputItem) 		{ 			... 			try 			{ 				... 				log.Debug($"Downloaded file: {downloadedFile}, size: {new FileInfo(downloadedFile).Length / 1e6}Mb"); 			} 			catch (Exception ex) 			{ 				log.Error(ex, ex.Source); 				return ...; 			} 		} 	} 

version: '2' services:   # MongoDB: https://hub.docker.com/_/mongo/   mongodb:     image: mongo:4     restart: always     volumes:     - mongo_data:/data/db:rw     - /etc/localtime:/etc/localtime     # Elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docker.html   elasticsearch:     image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.8.2     restart: always     volumes:     - es_data:/usr/share/elasticsearch/data:rw     - /etc/localtime:/etc/localtime     environment:       - http.host=0.0.0.0       - transport.host=localhost       - network.host=0.0.0.0       - "ES_JAVA_OPTS=-Xms512m -Xmx512m"     ulimits:       memlock:         soft: -1         hard: -1     mem_limit: 1g   # Graylog: https://hub.docker.com/r/graylog/graylog/   # Graylog: I want to have the lastest   graylog:     image: graylog/graylog:3.2     restart: always     volumes:     - graylog_data:/usr/share/graylog/data/journal:rw     - /etc/localtime:/etc/localtime # Бонус: оповещения в Телеграм. Наверняка и про это как-нибудь расскажу     - /home/MYUSER/graylog-data/plugin/graylog-plugin-telegram-notification-2.3.0.jar:/usr/share/graylog/plugin/graylog-plugin-telegram-notification-2.3.0.jar     environment:       # CHANGE ME (must be at least 16 characters)!       - GRAYLOG_PASSWORD_SECRET=somepasswordpepper       # Password: MYPASSWORD       - GRAYLOG_ROOT_PASSWORD_SHA2=SHA2MYPASSWORDPLEASEINANYONLINESERVICE       - GRAYLOG_HTTP_BIND_ADDRESS=0.0.0.0:9999       - GRAYLOG_WEB_LISTEN_URI=http://my.ex.ipa.dr:9999/       - GRAYLOG_HTTP_EXTERNAL_URI=http://my.ex.ipa.dr:9999/       - GRAYLOG_HTTP_PUBLISH_URI=http://my.ex.ipa.dr:9999/       - GRAYLOG_ROOT_TIMEZONE=Europe/Moscow       - GRAYLOG_PLUGIN_DIR=plugin     links:       - mongodb:mongo       - elasticsearch     depends_on:       - mongodb       - elasticsearch     ports:       - 5044:5044       # Graylog web interface and REST API       - 9999:9999       # Syslog TCP       - 1514:1514       # Syslog UDP       - 1514:1514/udp       # GELF TCP       - 12201:12201       # GELF UDP       - 12201:12201/udp       #Volumes volumes:   mongo_data:     driver: local   es_data:     driver: local   graylog_data:     driver: local 

Graylog nodes accept data via inputs. Launch or terminate as many inputs as you want here.

Организовав проброс с my.web.adress.domain на порт 12201 своей докер-машины, можно получить доступный отовсюду сбощик логов. Но это факультатив и не всем нужно…

// Метод-бонус. Применяется, когда нужно в Graylog переправить много свойств какого-либо объекта. 		// На входе среди параметров objWithProps - целевой объект для считывания с него свойств и конвертации их в json (что почти GELF)... 		public static LogEventInfo GetLogEventWithProperties(LogLevel logLevel, string logName, string message, object objWithProps) 		{ 			// Можно передать некое текстовое название, а можно и без него обойтись 			if (string.IsNullOrEmpty(message)) 			{ 				message = objWithProps?.GetType()?.Name ?? "custom_json_data"; 			}  			LogEventInfo e = new LogEventInfo(logLevel, logName, message);  			object logEventProperty = null; 			// Здесь много работы для Newtonsoft.Json: https://www.newtonsoft.com/json 			JsonSerializerSettings jsonSerializerSettings = new JsonSerializerSettings 			{ 				ReferenceLoopHandling = ReferenceLoopHandling.Serialize, 				PreserveReferencesHandling = PreserveReferencesHandling.Objects, 				NullValueHandling = NullValueHandling.Include 			};  			try 			{ 				// С "простыми" объектами (классами) это проходит легко... 				logEventProperty = JsonConvert.SerializeObject(objWithProps, Formatting.Indented, jsonSerializerSettings); 			} 			catch (Exception ex) 			{ 				Debug.Write(ex);  				try 				{ 					// ...но, если не проходит: считываем свойства, которые этому поддаются, ... 					IEnumerable<PropertyInfo> objProps = objWithProps?.GetType()?.GetProperties()?.Where(p => p?.GetGetMethod()?.GetParameters()?.Length == 0);  					if (objProps?.Any() == true) 					{ 						// ...аккуратно складываем в словарь,... 						Dictionary<string, string> objPropsDict = 							objProps 							.ToDictionary( 								x => x?.Name, 								x => 								{ 									string rezVal = string.Empty; 									try 									{ 										rezVal = x?.GetValue(objWithProps, null)?.ToString(); 									} 									catch (Exception ex0) 									{ 										Debug.Write(ex0); 									} 									return rezVal; 								} 							)? 							.OrderBy(x => x.Key)? 							.ToDictionary(obj => obj.Key, obj => obj.Value); 						// ...и снова работаем Newtonsoft.Json 						logEventProperty = JsonConvert.SerializeObject(objPropsDict, Formatting.Indented, jsonSerializerSettings); 					} 				} 				catch (Exception ex1) 				{ 					Debug.Write(ex1); 				} 			} 			// На выходе json-строка, которую Graylog легко превратит в поля сообщения лога. 			e.Properties["custom_json_data"] = logEventProperty; 			return e; 		} 

log.Debug(BimlibLogger.GetLogEventWithProperties(LogLevel.Debug, log.Name, $"Got the task", message));

Тот же exception, разбитый на поля.