logstruct 0.2.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/lib/log_struct/bounded_input.rb +101 -0
  4. data/lib/log_struct/concerns/configuration.rb +9 -9
  5. data/lib/log_struct/concerns/error_handling.rb +10 -0
  6. data/lib/log_struct/config_struct/filters.rb +24 -13
  7. data/lib/log_struct/config_struct/limits.rb +1 -1
  8. data/lib/log_struct/enums/level.rb +1 -1
  9. data/lib/log_struct/enums/log_field.rb +0 -3
  10. data/lib/log_struct/formatter.rb +38 -23
  11. data/lib/log_struct/hash_utils.rb +11 -4
  12. data/lib/log_struct/integrations/action_mailer/event_logging.rb +1 -0
  13. data/lib/log_struct/integrations/action_mailer/metadata_collection.rb +1 -0
  14. data/lib/log_struct/integrations/active_record.rb +1 -1
  15. data/lib/log_struct/integrations/ahoy.rb +4 -3
  16. data/lib/log_struct/integrations/carrierwave.rb +4 -6
  17. data/lib/log_struct/integrations/dotenv.rb +2 -1
  18. data/lib/log_struct/integrations/good_job.rb +2 -1
  19. data/lib/log_struct/integrations/host_authorization.rb +3 -6
  20. data/lib/log_struct/integrations/lograge.rb +23 -32
  21. data/lib/log_struct/integrations/puma.rb +1 -1
  22. data/lib/log_struct/integrations/rack_error_handler/error_lines.rb +1 -4
  23. data/lib/log_struct/integrations/shrine.rb +1 -1
  24. data/lib/log_struct/log/action_mailer/delivered.rb +19 -7
  25. data/lib/log_struct/log/action_mailer/delivery.rb +19 -7
  26. data/lib/log_struct/log/action_mailer/error.rb +19 -7
  27. data/lib/log_struct/log/action_mailer.rb +1 -0
  28. data/lib/log_struct/log/active_job/discard.rb +7 -5
  29. data/lib/log_struct/log/active_job/enqueue.rb +7 -5
  30. data/lib/log_struct/log/active_job/error.rb +7 -5
  31. data/lib/log_struct/log/active_job/finish.rb +7 -5
  32. data/lib/log_struct/log/active_job/retry.rb +7 -5
  33. data/lib/log_struct/log/active_job/retry_stopped.rb +7 -5
  34. data/lib/log_struct/log/active_job/schedule.rb +7 -5
  35. data/lib/log_struct/log/active_job/start.rb +7 -5
  36. data/lib/log_struct/log/active_job.rb +1 -0
  37. data/lib/log_struct/log/active_model_serializers.rb +7 -5
  38. data/lib/log_struct/log/active_storage/delete.rb +7 -5
  39. data/lib/log_struct/log/active_storage/download.rb +7 -5
  40. data/lib/log_struct/log/active_storage/exist.rb +7 -5
  41. data/lib/log_struct/log/active_storage/metadata.rb +7 -5
  42. data/lib/log_struct/log/active_storage/upload.rb +7 -5
  43. data/lib/log_struct/log/active_storage/url.rb +7 -5
  44. data/lib/log_struct/log/active_storage.rb +1 -0
  45. data/lib/log_struct/log/ahoy.rb +7 -5
  46. data/lib/log_struct/log/carrierwave/delete.rb +7 -9
  47. data/lib/log_struct/log/carrierwave/download.rb +7 -11
  48. data/lib/log_struct/log/carrierwave/upload.rb +7 -11
  49. data/lib/log_struct/log/carrierwave.rb +3 -8
  50. data/lib/log_struct/log/dotenv/load.rb +7 -5
  51. data/lib/log_struct/log/dotenv/restore.rb +7 -5
  52. data/lib/log_struct/log/dotenv/save.rb +7 -5
  53. data/lib/log_struct/log/dotenv/update.rb +7 -5
  54. data/lib/log_struct/log/error.rb +24 -14
  55. data/lib/log_struct/log/good_job/error.rb +7 -5
  56. data/lib/log_struct/log/good_job/log.rb +7 -5
  57. data/lib/log_struct/log/good_job.rb +1 -0
  58. data/lib/log_struct/log/plain.rb +19 -7
  59. data/lib/log_struct/log/puma/error.rb +19 -7
  60. data/lib/log_struct/log/puma/shutdown.rb +19 -7
  61. data/lib/log_struct/log/puma/start.rb +19 -7
  62. data/lib/log_struct/log/request.rb +24 -14
  63. data/lib/log_struct/log/security/blocked_host.rb +24 -14
  64. data/lib/log_struct/log/security/csrf_violation.rb +24 -14
  65. data/lib/log_struct/log/security/ip_spoof.rb +24 -14
  66. data/lib/log_struct/log/security.rb +1 -0
  67. data/lib/log_struct/log/shrine/delete.rb +7 -5
  68. data/lib/log_struct/log/shrine/download.rb +7 -5
  69. data/lib/log_struct/log/shrine/exist.rb +7 -5
  70. data/lib/log_struct/log/shrine/metadata.rb +7 -5
  71. data/lib/log_struct/log/shrine/upload.rb +7 -5
  72. data/lib/log_struct/log/sidekiq/error.rb +19 -7
  73. data/lib/log_struct/log/sidekiq/log.rb +19 -7
  74. data/lib/log_struct/log/sql.rb +19 -7
  75. data/lib/log_struct/monkey_patches/active_support/tagged_logging/formatter.rb +1 -0
  76. data/lib/log_struct/multi_error_reporter.rb +1 -1
  77. data/lib/log_struct/param_filters.rb +7 -26
  78. data/lib/log_struct/params_errors.rb +7 -10
  79. data/lib/log_struct/rails_boot_banner_silencer.rb +1 -0
  80. data/lib/log_struct/semantic_logger/concerns/log_methods.rb +1 -0
  81. data/lib/log_struct/semantic_logger/formatter.rb +1 -1
  82. data/lib/log_struct/semantic_logger/logger.rb +1 -1
  83. data/lib/log_struct/semantic_logger/setup.rb +1 -4
  84. data/lib/log_struct/shared/merge_additional_data_fields.rb +21 -5
  85. data/lib/log_struct/string_scrubber.rb +1 -1
  86. data/lib/log_struct/version.rb +1 -1
  87. data/logstruct.gemspec +1 -1
  88. metadata +4 -3
@@ -23,11 +23,15 @@ module LogStruct
23
23
  class Start < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+
26
30
  # Shared/common fields
27
- const :source, Source::Puma, default: Source::Puma
28
- const :event, Event, default: Event::Start
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
31
+ const :source, Source::Puma, default: Source::Puma, override: true
32
+ const :event, Event, default: Event::Start, override: true
33
+ const :timestamp, Time, factory: -> { Time.now }, override: true
34
+ const :level, Level, default: Level::Info, override: true
31
35
 
32
36
  # Event-specific fields
33
37
  const :mode, T.nilable(String), default: nil
@@ -41,12 +45,20 @@ module LogStruct
41
45
  const :listening_addresses, T.nilable(T::Array[String]), default: nil
42
46
 
43
47
  # Additional data
44
- include LogStruct::Log::Interfaces::AdditionalDataField
45
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
48
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
46
49
  include LogStruct::Log::Shared::MergeAdditionalDataFields
47
50
 
51
+ FIELD_KEYS = T.let(
52
+ [LogField::Mode, LogField::PumaVersion, LogField::PumaCodename, LogField::RubyVersion, LogField::MinThreads, LogField::MaxThreads, LogField::Environment, LogField::ProcessId, LogField::ListeningAddresses].to_set(&:serialize).freeze,
53
+ T::Set[Symbol]
54
+ )
55
+
56
+ sig { override.returns(T::Set[Symbol]) }
57
+ def field_keys
58
+ FIELD_KEYS
59
+ end
60
+
48
61
  # Serialize shared fields
49
- include LogStruct::Log::Interfaces::CommonFields
50
62
  include LogStruct::Log::Shared::SerializeCommon
51
63
 
52
64
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -22,17 +22,22 @@ module LogStruct
22
22
  class Request < T::Struct
23
23
  extend T::Sig
24
24
 
25
+ # A prop marked `override` needs the method it implements to exist already
26
+ include LogStruct::Log::Interfaces::CommonFields
27
+ include LogStruct::Log::Interfaces::AdditionalDataField
28
+ include LogStruct::Log::Interfaces::RequestFields
29
+
25
30
  # Shared/common fields
26
- const :source, Source::Rails, default: Source::Rails
27
- const :event, Event, default: Event::Request
28
- const :timestamp, Time, factory: -> { Time.now }
29
- const :level, Level, default: Level::Info
31
+ const :source, Source::Rails, default: Source::Rails, override: true
32
+ const :event, Event, default: Event::Request, override: true
33
+ const :timestamp, Time, factory: -> { Time.now }, override: true
34
+ const :level, Level, default: Level::Info, override: true
30
35
 
31
- const :path, T.nilable(String), default: nil
32
- const :http_method, T.nilable(String), default: nil
33
- const :source_ip, T.nilable(String), default: nil
34
- const :user_agent, T.nilable(String), default: nil
35
- const :referer, T.nilable(String), default: nil
36
+ const :path, T.nilable(String), default: nil, override: true
37
+ const :http_method, T.nilable(String), default: nil, override: true
38
+ const :source_ip, T.nilable(String), default: nil, override: true
39
+ const :user_agent, T.nilable(String), default: nil, override: true
40
+ const :referer, T.nilable(String), default: nil, override: true
36
41
 
37
42
  # Event-specific fields
38
43
  const :format, T.nilable(Symbol), default: nil
@@ -48,15 +53,20 @@ module LogStruct
48
53
  const :accept, T.nilable(String), default: nil
49
54
 
50
55
  # Additional data
51
- include LogStruct::Log::Interfaces::AdditionalDataField
52
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
56
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
53
57
  include LogStruct::Log::Shared::MergeAdditionalDataFields
54
58
 
55
- # Request fields (optional)
56
- include LogStruct::Log::Interfaces::RequestFields
59
+ FIELD_KEYS = T.let(
60
+ [LogField::Path, LogField::HttpMethod, LogField::SourceIp, LogField::UserAgent, LogField::Referer, LogField::Format, LogField::Controller, LogField::Action, LogField::Status, LogField::DurationMs, LogField::View, LogField::Database, LogField::Params, LogField::Host, LogField::ContentType, LogField::Accept].to_set(&:serialize).freeze,
61
+ T::Set[Symbol]
62
+ )
63
+
64
+ sig { override.returns(T::Set[Symbol]) }
65
+ def field_keys
66
+ FIELD_KEYS
67
+ end
57
68
 
58
69
  # Serialize shared fields
59
- include LogStruct::Log::Interfaces::CommonFields
60
70
  include LogStruct::Log::Shared::SerializeCommon
61
71
  include LogStruct::Log::Shared::AddRequestFields
62
72
 
@@ -23,17 +23,22 @@ module LogStruct
23
23
  class BlockedHost < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+ include LogStruct::Log::Interfaces::RequestFields
30
+
26
31
  # Shared/common fields
27
- const :source, Source::Security, default: Source::Security
28
- const :event, Event, default: Event::BlockedHost
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
32
+ const :source, Source::Security, default: Source::Security, override: true
33
+ const :event, Event, default: Event::BlockedHost, override: true
34
+ const :timestamp, Time, factory: -> { Time.now }, override: true
35
+ const :level, Level, default: Level::Info, override: true
31
36
 
32
- const :path, T.nilable(String), default: nil
33
- const :http_method, T.nilable(String), default: nil
34
- const :source_ip, T.nilable(String), default: nil
35
- const :user_agent, T.nilable(String), default: nil
36
- const :referer, T.nilable(String), default: nil
37
+ const :path, T.nilable(String), default: nil, override: true
38
+ const :http_method, T.nilable(String), default: nil, override: true
39
+ const :source_ip, T.nilable(String), default: nil, override: true
40
+ const :user_agent, T.nilable(String), default: nil, override: true
41
+ const :referer, T.nilable(String), default: nil, override: true
37
42
 
38
43
  # Event-specific fields
39
44
  const :message, T.nilable(String), default: nil
@@ -42,15 +47,20 @@ module LogStruct
42
47
  const :x_forwarded_for, T.nilable(String), default: nil
43
48
 
44
49
  # Additional data
45
- include LogStruct::Log::Interfaces::AdditionalDataField
46
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
50
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
47
51
  include LogStruct::Log::Shared::MergeAdditionalDataFields
48
52
 
49
- # Request fields (optional)
50
- include LogStruct::Log::Interfaces::RequestFields
53
+ FIELD_KEYS = T.let(
54
+ [LogField::Path, LogField::HttpMethod, LogField::SourceIp, LogField::UserAgent, LogField::Referer, LogField::Message, LogField::BlockedHost, LogField::BlockedHosts, LogField::XForwardedFor].to_set(&:serialize).freeze,
55
+ T::Set[Symbol]
56
+ )
57
+
58
+ sig { override.returns(T::Set[Symbol]) }
59
+ def field_keys
60
+ FIELD_KEYS
61
+ end
51
62
 
52
63
  # Serialize shared fields
53
- include LogStruct::Log::Interfaces::CommonFields
54
64
  include LogStruct::Log::Shared::SerializeCommon
55
65
  include LogStruct::Log::Shared::AddRequestFields
56
66
 
@@ -23,31 +23,41 @@ module LogStruct
23
23
  class CSRFViolation < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+ include LogStruct::Log::Interfaces::RequestFields
30
+
26
31
  # Shared/common fields
27
- const :source, Source::Security, default: Source::Security
28
- const :event, Event, default: Event::CSRFViolation
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
32
+ const :source, Source::Security, default: Source::Security, override: true
33
+ const :event, Event, default: Event::CSRFViolation, override: true
34
+ const :timestamp, Time, factory: -> { Time.now }, override: true
35
+ const :level, Level, default: Level::Info, override: true
31
36
 
32
- const :path, T.nilable(String), default: nil
33
- const :http_method, T.nilable(String), default: nil
34
- const :source_ip, T.nilable(String), default: nil
35
- const :user_agent, T.nilable(String), default: nil
36
- const :referer, T.nilable(String), default: nil
37
+ const :path, T.nilable(String), default: nil, override: true
38
+ const :http_method, T.nilable(String), default: nil, override: true
39
+ const :source_ip, T.nilable(String), default: nil, override: true
40
+ const :user_agent, T.nilable(String), default: nil, override: true
41
+ const :referer, T.nilable(String), default: nil, override: true
37
42
 
38
43
  # Event-specific fields
39
44
  const :message, T.nilable(String), default: nil
40
45
 
41
46
  # Additional data
42
- include LogStruct::Log::Interfaces::AdditionalDataField
43
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
47
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
44
48
  include LogStruct::Log::Shared::MergeAdditionalDataFields
45
49
 
46
- # Request fields (optional)
47
- include LogStruct::Log::Interfaces::RequestFields
50
+ FIELD_KEYS = T.let(
51
+ [LogField::Path, LogField::HttpMethod, LogField::SourceIp, LogField::UserAgent, LogField::Referer, LogField::Message].to_set(&:serialize).freeze,
52
+ T::Set[Symbol]
53
+ )
54
+
55
+ sig { override.returns(T::Set[Symbol]) }
56
+ def field_keys
57
+ FIELD_KEYS
58
+ end
48
59
 
49
60
  # Serialize shared fields
50
- include LogStruct::Log::Interfaces::CommonFields
51
61
  include LogStruct::Log::Shared::SerializeCommon
52
62
  include LogStruct::Log::Shared::AddRequestFields
53
63
 
@@ -23,17 +23,22 @@ module LogStruct
23
23
  class IPSpoof < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+ include LogStruct::Log::Interfaces::RequestFields
30
+
26
31
  # Shared/common fields
27
- const :source, Source::Security, default: Source::Security
28
- const :event, Event, default: Event::IPSpoof
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
32
+ const :source, Source::Security, default: Source::Security, override: true
33
+ const :event, Event, default: Event::IPSpoof, override: true
34
+ const :timestamp, Time, factory: -> { Time.now }, override: true
35
+ const :level, Level, default: Level::Info, override: true
31
36
 
32
- const :path, T.nilable(String), default: nil
33
- const :http_method, T.nilable(String), default: nil
34
- const :source_ip, T.nilable(String), default: nil
35
- const :user_agent, T.nilable(String), default: nil
36
- const :referer, T.nilable(String), default: nil
37
+ const :path, T.nilable(String), default: nil, override: true
38
+ const :http_method, T.nilable(String), default: nil, override: true
39
+ const :source_ip, T.nilable(String), default: nil, override: true
40
+ const :user_agent, T.nilable(String), default: nil, override: true
41
+ const :referer, T.nilable(String), default: nil, override: true
37
42
 
38
43
  # Event-specific fields
39
44
  const :message, T.nilable(String), default: nil
@@ -41,15 +46,20 @@ module LogStruct
41
46
  const :x_forwarded_for, T.nilable(String), default: nil
42
47
 
43
48
  # Additional data
44
- include LogStruct::Log::Interfaces::AdditionalDataField
45
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
49
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
46
50
  include LogStruct::Log::Shared::MergeAdditionalDataFields
47
51
 
48
- # Request fields (optional)
49
- include LogStruct::Log::Interfaces::RequestFields
52
+ FIELD_KEYS = T.let(
53
+ [LogField::Path, LogField::HttpMethod, LogField::SourceIp, LogField::UserAgent, LogField::Referer, LogField::Message, LogField::ClientIp, LogField::XForwardedFor].to_set(&:serialize).freeze,
54
+ T::Set[Symbol]
55
+ )
56
+
57
+ sig { override.returns(T::Set[Symbol]) }
58
+ def field_keys
59
+ FIELD_KEYS
60
+ end
50
61
 
51
62
  # Serialize shared fields
52
- include LogStruct::Log::Interfaces::CommonFields
53
63
  include LogStruct::Log::Shared::SerializeCommon
54
64
  include LogStruct::Log::Shared::AddRequestFields
55
65
 
@@ -15,6 +15,7 @@ module LogStruct
15
15
  class Security
16
16
  class BaseFields < T::Struct
17
17
  extend T::Sig
18
+
18
19
  const :path, T.nilable(String), default: nil
19
20
  const :http_method, T.nilable(String), default: nil
20
21
  const :source_ip, T.nilable(String), default: nil
@@ -23,18 +23,20 @@ module LogStruct
23
23
  class Delete < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+
26
29
  # Shared/common fields
27
- const :source, Source::Shrine, default: Source::Shrine
28
- const :event, Event, default: Event::Delete
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
30
+ const :source, Source::Shrine, default: Source::Shrine, override: true
31
+ const :event, Event, default: Event::Delete, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
31
34
 
32
35
  # Event-specific fields
33
36
  const :storage, Symbol
34
37
  const :location, String
35
38
 
36
39
  # Serialize shared fields
37
- include LogStruct::Log::Interfaces::CommonFields
38
40
  include LogStruct::Log::Shared::SerializeCommon
39
41
 
40
42
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,11 +23,14 @@ module LogStruct
23
23
  class Download < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+
26
29
  # Shared/common fields
27
- const :source, Source::Shrine, default: Source::Shrine
28
- const :event, Event, default: Event::Download
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
30
+ const :source, Source::Shrine, default: Source::Shrine, override: true
31
+ const :event, Event, default: Event::Download, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
31
34
 
32
35
  # Event-specific fields
33
36
  const :storage, Symbol
@@ -35,7 +38,6 @@ module LogStruct
35
38
  const :download_options, T.nilable(T::Hash[Symbol, T.untyped]), default: nil
36
39
 
37
40
  # Serialize shared fields
38
- include LogStruct::Log::Interfaces::CommonFields
39
41
  include LogStruct::Log::Shared::SerializeCommon
40
42
 
41
43
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,18 +23,20 @@ module LogStruct
23
23
  class Exist < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+
26
29
  # Shared/common fields
27
- const :source, Source::Shrine, default: Source::Shrine
28
- const :event, Event, default: Event::Exist
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
30
+ const :source, Source::Shrine, default: Source::Shrine, override: true
31
+ const :event, Event, default: Event::Exist, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
31
34
 
32
35
  # Event-specific fields
33
36
  const :storage, Symbol
34
37
  const :location, String
35
38
 
36
39
  # Serialize shared fields
37
- include LogStruct::Log::Interfaces::CommonFields
38
40
  include LogStruct::Log::Shared::SerializeCommon
39
41
 
40
42
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,18 +23,20 @@ module LogStruct
23
23
  class Metadata < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+
26
29
  # Shared/common fields
27
- const :source, Source::Shrine, default: Source::Shrine
28
- const :event, Event, default: Event::Metadata
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
30
+ const :source, Source::Shrine, default: Source::Shrine, override: true
31
+ const :event, Event, default: Event::Metadata, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
31
34
 
32
35
  # Event-specific fields
33
36
  const :storage, Symbol
34
37
  const :duration_ms, T.nilable(Float), default: nil
35
38
 
36
39
  # Serialize shared fields
37
- include LogStruct::Log::Interfaces::CommonFields
38
40
  include LogStruct::Log::Shared::SerializeCommon
39
41
 
40
42
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,11 +23,14 @@ module LogStruct
23
23
  class Upload < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+
26
29
  # Shared/common fields
27
- const :source, Source::Shrine, default: Source::Shrine
28
- const :event, Event, default: Event::Upload
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
30
+ const :source, Source::Shrine, default: Source::Shrine, override: true
31
+ const :event, Event, default: Event::Upload, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
31
34
 
32
35
  # Event-specific fields
33
36
  const :storage, Symbol
@@ -40,7 +43,6 @@ module LogStruct
40
43
  const :duration_ms, T.nilable(Float), default: nil
41
44
 
42
45
  # Serialize shared fields
43
- include LogStruct::Log::Interfaces::CommonFields
44
46
  include LogStruct::Log::Shared::SerializeCommon
45
47
 
46
48
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,11 +23,15 @@ module LogStruct
23
23
  class Error < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+
26
30
  # Shared/common fields
27
- const :source, Source::Sidekiq, default: Source::Sidekiq
28
- const :event, Event, default: Event::Error
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
31
+ const :source, Source::Sidekiq, default: Source::Sidekiq, override: true
32
+ const :event, Event, default: Event::Error, override: true
33
+ const :timestamp, Time, factory: -> { Time.now }, override: true
34
+ const :level, Level, default: Level::Info, override: true
31
35
 
32
36
  # Event-specific fields
33
37
  const :error_class, T.class_of(Exception)
@@ -38,12 +42,20 @@ module LogStruct
38
42
  const :retry_count, T.nilable(Integer), default: nil
39
43
 
40
44
  # Additional data
41
- include LogStruct::Log::Interfaces::AdditionalDataField
42
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
45
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
43
46
  include LogStruct::Log::Shared::MergeAdditionalDataFields
44
47
 
48
+ FIELD_KEYS = T.let(
49
+ [LogField::ErrorClass, LogField::Message, LogField::Backtrace, LogField::ErrorContext, LogField::QueueName, LogField::RetryCount].to_set(&:serialize).freeze,
50
+ T::Set[Symbol]
51
+ )
52
+
53
+ sig { override.returns(T::Set[Symbol]) }
54
+ def field_keys
55
+ FIELD_KEYS
56
+ end
57
+
45
58
  # Serialize shared fields
46
- include LogStruct::Log::Interfaces::CommonFields
47
59
  include LogStruct::Log::Shared::SerializeCommon
48
60
 
49
61
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -23,11 +23,15 @@ module LogStruct
23
23
  class Log < T::Struct
24
24
  extend T::Sig
25
25
 
26
+ # A prop marked `override` needs the method it implements to exist already
27
+ include LogStruct::Log::Interfaces::CommonFields
28
+ include LogStruct::Log::Interfaces::AdditionalDataField
29
+
26
30
  # Shared/common fields
27
- const :source, Source::Sidekiq, default: Source::Sidekiq
28
- const :event, Event, default: Event::Log
29
- const :timestamp, Time, factory: -> { Time.now }
30
- const :level, Level, default: Level::Info
31
+ const :source, Source::Sidekiq, default: Source::Sidekiq, override: true
32
+ const :event, Event, default: Event::Log, override: true
33
+ const :timestamp, Time, factory: -> { Time.now }, override: true
34
+ const :level, Level, default: Level::Info, override: true
31
35
 
32
36
  # Event-specific fields
33
37
  const :message, T.nilable(String), default: nil
@@ -36,12 +40,20 @@ module LogStruct
36
40
  const :thread_id, T.nilable(T.any(Integer, String)), default: nil
37
41
 
38
42
  # Additional data
39
- include LogStruct::Log::Interfaces::AdditionalDataField
40
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
43
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
41
44
  include LogStruct::Log::Shared::MergeAdditionalDataFields
42
45
 
46
+ FIELD_KEYS = T.let(
47
+ [LogField::Message, LogField::Context, LogField::ProcessId, LogField::ThreadId].to_set(&:serialize).freeze,
48
+ T::Set[Symbol]
49
+ )
50
+
51
+ sig { override.returns(T::Set[Symbol]) }
52
+ def field_keys
53
+ FIELD_KEYS
54
+ end
55
+
43
56
  # Serialize shared fields
44
- include LogStruct::Log::Interfaces::CommonFields
45
57
  include LogStruct::Log::Shared::SerializeCommon
46
58
 
47
59
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -22,11 +22,15 @@ module LogStruct
22
22
  class SQL < T::Struct
23
23
  extend T::Sig
24
24
 
25
+ # A prop marked `override` needs the method it implements to exist already
26
+ include LogStruct::Log::Interfaces::CommonFields
27
+ include LogStruct::Log::Interfaces::AdditionalDataField
28
+
25
29
  # Shared/common fields
26
- const :source, Source::App, default: Source::App
27
- const :event, Event, default: Event::Database
28
- const :timestamp, Time, factory: -> { Time.now }
29
- const :level, Level, default: Level::Info
30
+ const :source, Source::App, default: Source::App, override: true
31
+ const :event, Event, default: Event::Database, override: true
32
+ const :timestamp, Time, factory: -> { Time.now }, override: true
33
+ const :level, Level, default: Level::Info, override: true
30
34
 
31
35
  # Event-specific fields
32
36
  const :message, String
@@ -43,12 +47,20 @@ module LogStruct
43
47
  const :table_names, T.nilable(T::Array[String]), default: nil
44
48
 
45
49
  # Additional data
46
- include LogStruct::Log::Interfaces::AdditionalDataField
47
- const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
50
+ const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil, override: true
48
51
  include LogStruct::Log::Shared::MergeAdditionalDataFields
49
52
 
53
+ FIELD_KEYS = T.let(
54
+ [LogField::Message, LogField::Sql, LogField::Name, LogField::DurationMs, LogField::RowCount, LogField::Adapter, LogField::BindParams, LogField::DatabaseName, LogField::ConnectionPoolSize, LogField::ActiveConnections, LogField::OperationType, LogField::TableNames].to_set(&:serialize).freeze,
55
+ T::Set[Symbol]
56
+ )
57
+
58
+ sig { override.returns(T::Set[Symbol]) }
59
+ def field_keys
60
+ FIELD_KEYS
61
+ end
62
+
50
63
  # Serialize shared fields
51
- include LogStruct::Log::Interfaces::CommonFields
52
64
  include LogStruct::Log::Shared::SerializeCommon
53
65
 
54
66
  sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
@@ -24,6 +24,7 @@ module ActiveSupport
24
24
  module FormatterExtension
25
25
  extend T::Sig
26
26
  extend T::Helpers
27
+
27
28
  requires_ancestor { ::ActiveSupport::TaggedLogging::Formatter }
28
29
 
29
30
  sig { params(severity: T.any(String, Symbol), time: Time, progname: T.untyped, data: T.untyped).returns(String) }
@@ -67,7 +67,7 @@ module LogStruct
67
67
  end
68
68
 
69
69
  # Set the reporter to use (user-friendly API that accepts symbols)
70
- sig { params(reporter_type: T.any(ErrorReporter, Symbol, Handlers::ErrorReporter)).returns(ReporterImpl) }
70
+ sig { params(reporter_type: T.any(ErrorReporter, Symbol, Handlers::ErrorReporter)).void }
71
71
  def reporter=(reporter_type)
72
72
  @reporter_impl = case reporter_type
73
73
  when ErrorReporter
@@ -43,7 +43,7 @@ module LogStruct
43
43
 
44
44
  matcher.matches?(normalized_key, value)
45
45
  rescue => e
46
- handle_filter_matcher_error(e, matcher.label, normalized_key)
46
+ handle_filter_matcher_error(e, matcher.label)
47
47
  # An unsuccessful filter must never expose the value it was meant to protect.
48
48
  true
49
49
  end
@@ -55,7 +55,7 @@ module LogStruct
55
55
  filters.path_matchers.any? do |matcher|
56
56
  matcher.matches?(path, value, root)
57
57
  rescue => e
58
- handle_filter_matcher_error(e, matcher.label, normalized_key)
58
+ handle_filter_matcher_error(e, matcher.label)
59
59
  true
60
60
  end
61
61
  end
@@ -94,16 +94,14 @@ module LogStruct
94
94
  filtered_string
95
95
  end
96
96
 
97
- # Summarize a filtered Hash: its first 10 keys and how many there are. No size, which would say
98
- # how long the secrets in it are.
97
+ # A filtered Hash's child keys can themselves contain secrets.
99
98
  sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
100
99
  def summarize_hash(hash)
101
100
  return {_class: "Hash", _empty: true} if hash.empty?
102
101
 
103
102
  {
104
103
  _class: Hash,
105
- _keys_count: hash.size,
106
- _keys: hash.each_key.take(10).map { |key| normalize_summary_key(StringScrubber.scrub_name(key)) }
104
+ _keys_count: hash.size
107
105
  }
108
106
  end
109
107
 
@@ -120,26 +118,9 @@ module LogStruct
120
118
 
121
119
  private
122
120
 
123
- sig { params(key: T.any(String, Symbol, Integer, T.untyped)).returns(T.any(Symbol, String)) }
124
- def normalize_summary_key(key)
125
- if key.is_a?(Symbol)
126
- key
127
- elsif key.respond_to?(:to_sym)
128
- key.to_sym
129
- else
130
- key.to_s
131
- end
132
- rescue
133
- key.to_s
134
- end
135
-
136
- sig { params(error: StandardError, label: String, key: String).void }
137
- def handle_filter_matcher_error(error, label, key)
138
- context = {
139
- matcher: label,
140
- key: key
141
- }
142
- LogStruct.handle_exception(error, source: Source::Internal, context: context)
121
+ sig { params(error: StandardError, label: String).void }
122
+ def handle_filter_matcher_error(error, label)
123
+ LogStruct.handle_value_error(error, "filter matcher failed", context: {matcher: label})
143
124
  end
144
125
  end
145
126
  end