| | | 1 | | using CShells.AspNetCore.Features; |
| | | 2 | | using CShells.FastEndpoints.Features; |
| | | 3 | | using CShells.Features; |
| | | 4 | | using Elsa.Diagnostics.StructuredLogs.Extensions; |
| | | 5 | | using Elsa.Diagnostics.StructuredLogs.Options; |
| | | 6 | | using Elsa.ShellFeatures; |
| | | 7 | | using Elsa.Platform.PackageManifest.Generator.Hints; |
| | | 8 | | using JetBrains.Annotations; |
| | | 9 | | using Microsoft.AspNetCore.Routing; |
| | | 10 | | using Microsoft.Extensions.DependencyInjection; |
| | | 11 | | using Microsoft.Extensions.Hosting; |
| | | 12 | | |
| | | 13 | | namespace Elsa.Diagnostics.StructuredLogs.ShellFeatures; |
| | | 14 | | |
| | | 15 | | /// <summary> |
| | | 16 | | /// Provides live structured log streaming over REST and SignalR. |
| | | 17 | | /// </summary> |
| | | 18 | | [ManifestFeatureCategory("Diagnostics")] |
| | | 19 | | [ShellFeature( |
| | | 20 | | DisplayName = "Structured Logs", |
| | | 21 | | Description = "Provides live structured log streaming over REST and SignalR", |
| | | 22 | | DependsOn = [typeof(ElsaFastEndpointsFeature)])] |
| | | 23 | | [UsedImplicitly] |
| | | 24 | | public class StructuredLogsFeature : IFastEndpointsShellFeature, IWebShellFeature |
| | | 25 | | { |
| | | 26 | | private const string SensitiveNamesDefaultValue = "authorization, token, password, secret, api-key, apikey, cookie, |
| | | 27 | | private const string SensitiveTextPatternsDefaultValue = "(?i)bearer\\s+[A-Za-z0-9._~+/=-]+; (?i)(password|secret|to |
| | 1 | 28 | | private static readonly StructuredLogsOptions DefaultOptions = new(); |
| | | 29 | | |
| | | 30 | | [ManifestSetting( |
| | | 31 | | DisplayName = "Recent Log Capacity", |
| | | 32 | | Description = "Maximum number of recent log events retained in memory.", |
| | | 33 | | Category = "Diagnostics", |
| | | 34 | | DefaultValue = "5000", |
| | | 35 | | RestartRequired = true)] |
| | 4 | 36 | | public int RecentLogCapacity { get; set; } = DefaultOptions.RecentLogCapacity; |
| | | 37 | | |
| | | 38 | | [ManifestSetting( |
| | | 39 | | DisplayName = "Subscriber Channel Capacity", |
| | | 40 | | Description = "Maximum number of queued log events per streaming subscriber.", |
| | | 41 | | Category = "Diagnostics", |
| | | 42 | | DefaultValue = "1000", |
| | | 43 | | RestartRequired = true)] |
| | 4 | 44 | | public int SubscriberChannelCapacity { get; set; } = DefaultOptions.SubscriberChannelCapacity; |
| | | 45 | | |
| | | 46 | | [ManifestSetting( |
| | | 47 | | DisplayName = "Maximum Recent Log Query Size", |
| | | 48 | | Description = "Maximum number of recent log events returned by a query.", |
| | | 49 | | Category = "Diagnostics", |
| | | 50 | | DefaultValue = "1000", |
| | | 51 | | RestartRequired = true)] |
| | 4 | 52 | | public int MaxRecentLogQuerySize { get; set; } = DefaultOptions.MaxRecentLogQuerySize; |
| | | 53 | | |
| | | 54 | | [ManifestSetting( |
| | | 55 | | DisplayName = "Source Heartbeat Timeout", |
| | | 56 | | Description = "Time after which a structured log source is considered inactive.", |
| | | 57 | | Category = "Diagnostics", |
| | | 58 | | DefaultValue = "00:00:30", |
| | | 59 | | RestartRequired = true)] |
| | 4 | 60 | | public TimeSpan SourceHeartbeatTimeout { get; set; } = DefaultOptions.SourceHeartbeatTimeout; |
| | | 61 | | |
| | | 62 | | [ManifestSetting( |
| | | 63 | | DisplayName = "Include Internal Structured Logs", |
| | | 64 | | Description = "Include log events produced by the structured logs subsystem itself.", |
| | | 65 | | Category = "Diagnostics", |
| | | 66 | | DefaultValue = "false", |
| | | 67 | | Advanced = true, |
| | | 68 | | RestartRequired = true)] |
| | 4 | 69 | | public bool IncludeStructuredLogsInternalLogs { get; set; } = DefaultOptions.IncludeStructuredLogsInternalLogs; |
| | | 70 | | |
| | | 71 | | [ManifestSetting( |
| | | 72 | | DisplayName = "Sensitive Names", |
| | | 73 | | Description = "Property names whose values should be redacted from structured log events.", |
| | | 74 | | Category = "Redaction", |
| | | 75 | | DefaultValue = SensitiveNamesDefaultValue, |
| | | 76 | | RestartRequired = true)] |
| | 4 | 77 | | public ICollection<string> SensitiveNames { get; set; } = [..DefaultOptions.SensitiveNames]; |
| | | 78 | | |
| | | 79 | | [ManifestSetting( |
| | | 80 | | DisplayName = "Sensitive Text Patterns", |
| | | 81 | | Description = "Text patterns whose values should be redacted from structured log events.", |
| | | 82 | | Category = "Redaction", |
| | | 83 | | DefaultValue = SensitiveTextPatternsDefaultValue, |
| | | 84 | | Advanced = true, |
| | | 85 | | RestartRequired = true)] |
| | 4 | 86 | | public ICollection<string> SensitiveTextPatterns { get; set; } = [..DefaultOptions.SensitiveTextPatterns]; |
| | | 87 | | |
| | | 88 | | public void ConfigureServices(IServiceCollection services) |
| | | 89 | | { |
| | 1 | 90 | | services.AddStructuredLogsServices(ConfigureOptions); |
| | 1 | 91 | | } |
| | | 92 | | |
| | | 93 | | public void MapEndpoints(IEndpointRouteBuilder endpoints, IHostEnvironment? environment) |
| | | 94 | | { |
| | 0 | 95 | | endpoints.MapStructuredLogsHub(); |
| | 0 | 96 | | } |
| | | 97 | | |
| | | 98 | | private void ConfigureOptions(StructuredLogsOptions options) |
| | | 99 | | { |
| | 1 | 100 | | options.RecentLogCapacity = RecentLogCapacity; |
| | 1 | 101 | | options.SubscriberChannelCapacity = SubscriberChannelCapacity; |
| | 1 | 102 | | options.MaxRecentLogQuerySize = MaxRecentLogQuerySize; |
| | 1 | 103 | | options.SourceHeartbeatTimeout = SourceHeartbeatTimeout; |
| | 1 | 104 | | options.IncludeStructuredLogsInternalLogs = IncludeStructuredLogsInternalLogs; |
| | 1 | 105 | | options.SensitiveNames = [..SensitiveNames]; |
| | 1 | 106 | | options.SensitiveTextPatterns = [..SensitiveTextPatterns]; |
| | 1 | 107 | | } |
| | | 108 | | } |