| | | 1 | | |
| | | 2 | | using System.Text; |
| | | 3 | | using Serilog.Events; |
| | | 4 | | |
| | | 5 | | namespace Kestrun.Logging; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Sanitized Serilog extensions to strip control chars (including CR/LF) |
| | | 9 | | /// from any string property values before writing the log. |
| | | 10 | | /// </summary> |
| | | 11 | | public static class LoggerExtensions |
| | | 12 | | { |
| | | 13 | | /// <summary> |
| | | 14 | | /// Writes a sanitized debug log event, removing control characters from string property values. |
| | | 15 | | /// </summary> |
| | | 16 | | /// <param name="log">The Serilog logger instance.</param> |
| | | 17 | | /// <param name="messageTemplate">The message template.</param> |
| | | 18 | | /// <param name="propertyValues">The property values for the message template.</param> |
| | | 19 | | public static void DebugSanitized(this Serilog.ILogger log, string messageTemplate, params object?[] propertyValues) |
| | | 20 | | { |
| | 71 | 21 | | if (!log.IsEnabled(LogEventLevel.Debug)) |
| | | 22 | | { |
| | 1 | 23 | | return; |
| | | 24 | | } |
| | | 25 | | |
| | 70 | 26 | | var sanitized = propertyValues.Select(SanitizeObject).ToArray(); |
| | 70 | 27 | | log.Debug(messageTemplate, sanitized); |
| | 70 | 28 | | } |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Writes a sanitized debug log event with an exception, removing control characters from string property values. |
| | | 32 | | /// </summary> |
| | | 33 | | /// <param name="log">The Serilog logger instance.</param> |
| | | 34 | | /// <param name="exception">The exception to log.</param> |
| | | 35 | | /// <param name="messageTemplate">The message template.</param> |
| | | 36 | | /// <param name="propertyValues">The property values for the message template.</param> |
| | | 37 | | public static void DebugSanitized(this Serilog.ILogger log, Exception exception, string messageTemplate, params obje |
| | | 38 | | { |
| | 1 | 39 | | if (!log.IsEnabled(LogEventLevel.Debug)) |
| | | 40 | | { |
| | 0 | 41 | | return; |
| | | 42 | | } |
| | | 43 | | |
| | 1 | 44 | | var sanitized = propertyValues.Select(SanitizeObject).ToArray(); |
| | 1 | 45 | | log.Debug(exception, messageTemplate, sanitized); |
| | 1 | 46 | | } |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Writes a sanitized error log event, removing control characters from string property values. |
| | | 50 | | /// </summary> |
| | | 51 | | /// <param name="log">The Serilog logger instance.</param> |
| | | 52 | | /// <param name="exception">The exception to log.</param> |
| | | 53 | | /// <param name="messageTemplate">The message template.</param> |
| | | 54 | | /// <param name="propertyValues">The property values for the message template.</param> |
| | | 55 | | public static void ErrorSanitized(this Serilog.ILogger log, Exception exception, string messageTemplate, params obje |
| | | 56 | | { |
| | 1 | 57 | | if (!log.IsEnabled(LogEventLevel.Error)) |
| | | 58 | | { |
| | 0 | 59 | | return; |
| | | 60 | | } |
| | | 61 | | |
| | 1 | 62 | | var sanitized = propertyValues.Select(SanitizeObject).ToArray(); |
| | 1 | 63 | | log.Error(exception, messageTemplate, sanitized); |
| | 1 | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Writes a sanitized warning log event, removing control characters from string property values. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <param name="log">The Serilog logger instance.</param> |
| | | 70 | | /// <param name="exception">The exception to log.</param> |
| | | 71 | | /// <param name="messageTemplate">The message template.</param> |
| | | 72 | | /// <param name="propertyValues">The property values for the message template.</param> |
| | | 73 | | public static void WarningSanitized(this Serilog.ILogger log, Exception exception, string messageTemplate, params ob |
| | | 74 | | { |
| | 0 | 75 | | if (!log.IsEnabled(LogEventLevel.Warning)) |
| | | 76 | | { |
| | 0 | 77 | | return; |
| | | 78 | | } |
| | | 79 | | |
| | 0 | 80 | | var sanitized = propertyValues.Select(SanitizeObject).ToArray(); |
| | 0 | 81 | | log.Warning(exception, messageTemplate, sanitized); |
| | 0 | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// Writes a sanitized warning log event, removing control characters from string property values. |
| | | 86 | | /// </summary> |
| | | 87 | | /// <param name="log">The Serilog logger instance.</param> |
| | | 88 | | /// <param name="messageTemplate">The message template.</param> |
| | | 89 | | /// <param name="propertyValues">The property values for the message template.</param> |
| | | 90 | | public static void WarningSanitized(this Serilog.ILogger log, string messageTemplate, params object?[] propertyValue |
| | | 91 | | { |
| | 6 | 92 | | if (!log.IsEnabled(LogEventLevel.Warning)) |
| | | 93 | | { |
| | 0 | 94 | | return; |
| | | 95 | | } |
| | | 96 | | |
| | 6 | 97 | | var sanitized = propertyValues.Select(SanitizeObject).ToArray(); |
| | 6 | 98 | | log.Warning(messageTemplate, sanitized); |
| | 6 | 99 | | } |
| | | 100 | | |
| | | 101 | | /// <summary> |
| | | 102 | | /// Sanitizes an object by stripping control characters if it's a string. |
| | | 103 | | /// </summary> |
| | | 104 | | /// <param name="o">The object to sanitize.</param> |
| | | 105 | | /// <returns>The sanitized object.</returns> |
| | | 106 | | private static object? SanitizeObject(object? o) => |
| | 137 | 107 | | o is string s |
| | 137 | 108 | | ? SanitizeString(s) |
| | 137 | 109 | | : o; |
| | | 110 | | |
| | | 111 | | /// <summary> |
| | | 112 | | /// Sanitizes a string by removing control characters. |
| | | 113 | | /// Strip out all control characters (0x00–0x1F, 0x7F), including CR/LF |
| | | 114 | | /// </summary> |
| | | 115 | | /// <param name="input">The string to sanitize.</param> |
| | | 116 | | /// <returns>The sanitized string.</returns> |
| | | 117 | | private static string SanitizeString(string input) |
| | | 118 | | { |
| | 63 | 119 | | var sb = new StringBuilder(input.Length).Append('"'); |
| | 1224 | 120 | | foreach (var c in input) |
| | | 121 | | { |
| | 549 | 122 | | if (char.IsControl(c)) |
| | | 123 | | { |
| | | 124 | | continue; |
| | | 125 | | } |
| | | 126 | | |
| | 543 | 127 | | _ = sb.Append(c); |
| | | 128 | | } |
| | 63 | 129 | | _ = sb.Append('"'); |
| | 63 | 130 | | return sb.ToString(); |
| | | 131 | | } |
| | | 132 | | } |