logstash-logger-p 0.26.1 → 0.26.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0af078c9b5dc553164e46b5e986c708da29009e9a0d2ab6758d35d425de06e0c
4
- data.tar.gz: 4b4670f1fe573ff5428e9c13d8cf7c629f4cedc0efa65a3c7a88843b057c98b1
3
+ metadata.gz: 7bd3fc9d2f97f7416ae9cbeec547392c3dddf1d2c957a6e55dc3b4c20b04fe3c
4
+ data.tar.gz: 42c6678f9ebe97692236ff39ad10f775ace1080d8297747bdfd815fd75451d00
5
5
  SHA512:
6
- metadata.gz: 7988e92fba5e1796d1df02675267ee7f0eb2edd655582a9de063459e6de0c0bf3f57a5b2b840cf333ec93d86e9a4c2db2041a18661d5c34e8891355ff581d775
7
- data.tar.gz: fd5b7a9f3c56ff6230c8ff9a083e70187e7f09e2109496dd5e035bda8122409647182b91ca99dd6249371499adf7636329f2eb699a3e3778d7f17e6181a82994
6
+ metadata.gz: 64fd41f533747d3eb6c694b520df81a409a77ec121e85e92eb177da66734e15c6f25aa6940de7744194e47fa9d01f8e0b6f60cbbafa3257571cd6175e2db5297
7
+ data.tar.gz: b6d1d67e3bf684e796e7f4691a16693e262c6be6fa0dc7b3655f25303dc89b333fe8ecb92149f4fff1805be9925ccff076ff801b3f5bedae29139425fab97caa
data/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## 0.26.2
2
+
3
+ - Fix: Loggers, including `MultiLogger`, respond to `push_tags`, `pop_tags`
4
+ and `current_tags`. Rails 7.2+ `Rails::Rack::Logger` applies
5
+ `config.log_tags` only through `push_tags`, so request tags were silently
6
+ dropped from every log line.
7
+
1
8
  ## 0.26.1
2
9
 
3
10
  - Fix: Support for SSL with the TCP device without an SSL context in Ruby
@@ -66,6 +66,23 @@ module LogStashLogger
66
66
  end
67
67
  private :tag_loggers
68
68
 
69
+ def push_tags(*tags)
70
+ tag_stack_loggers.map { |logger| logger.push_tags(*tags) }.first || []
71
+ end
72
+
73
+ def pop_tags(size = 1)
74
+ tag_stack_loggers.map { |logger| logger.pop_tags(size) }.first || []
75
+ end
76
+
77
+ def current_tags
78
+ tag_stack_loggers.flat_map(&:current_tags).uniq
79
+ end
80
+
81
+ def tag_stack_loggers
82
+ @loggers.select { |logger| logger.respond_to?(:push_tags) }
83
+ end
84
+ private :tag_stack_loggers
85
+
69
86
  # Any method not defined on standard Logger class, just send it on to anyone who will listen
70
87
  def method_missing(name, *args, &block)
71
88
  @loggers.each do |logger|
@@ -5,6 +5,18 @@ module LogStashLogger
5
5
  formatter.tagged(*tags) { yield self }
6
6
  end
7
7
 
8
+ def push_tags(*tags)
9
+ formatter.push_tags(*tags)
10
+ end
11
+
12
+ def pop_tags(size = 1)
13
+ formatter.pop_tags(size)
14
+ end
15
+
16
+ def current_tags
17
+ formatter.current_tags
18
+ end
19
+
8
20
  def flush
9
21
  formatter.clear_tags!
10
22
  super if defined?(super)
@@ -1,3 +1,3 @@
1
1
  module LogStashLogger
2
- VERSION = "0.26.1"
2
+ VERSION = "0.26.2"
3
3
  end
@@ -56,4 +56,30 @@ describe LogStashLogger::MultiLogger do
56
56
  logger.info 'test'
57
57
  end
58
58
  end
59
+
60
+ it "puts pushed tags on every logger's events until they are popped" do
61
+ first_io = StringIO.new
62
+ second_io = StringIO.new
63
+ logger = LogStashLogger.new(type: :multi_logger, outputs: [{ type: :io, io: first_io }, { type: :io, io: second_io }])
64
+
65
+ pushed_count = logger.push_tags('tag').size
66
+ logger.info('tagged')
67
+ logger.pop_tags(pushed_count)
68
+ logger.info('untagged')
69
+
70
+ [first_io, second_io].each do |io|
71
+ events = io.string.lines.map { |line| JSON.parse(line) }
72
+ expect(events.map { |event| event['tags'] }).to eq([['tag'], nil])
73
+ end
74
+ end
75
+
76
+ it "exposes the current tags" do
77
+ logger = LogStashLogger.new(type: :multi_logger, outputs: [{ type: :io, io: StringIO.new }, { type: :io, io: StringIO.new }])
78
+
79
+ pushed_count = logger.push_tags('tag').size
80
+ current_tags = logger.current_tags
81
+ logger.pop_tags(pushed_count)
82
+
83
+ expect(current_tags).to eq(['tag'])
84
+ end
59
85
  end
data/spec/rails_spec.rb CHANGED
@@ -88,4 +88,45 @@ describe LogStashLogger do
88
88
  end
89
89
  end
90
90
  end
91
+
92
+ describe "request tagging" do
93
+ it "tags log lines written during a request with config.log_tags" do
94
+ io = StringIO.new
95
+ allow(Rails).to receive(:logger).and_return(LogStashLogger.new(type: :io, io: io))
96
+ request_app = lambda do |_env|
97
+ Rails.logger.info('inside request')
98
+ [200, {}, ['ok']]
99
+ end
100
+
101
+ _status, _headers, body = Rails::Rack::Logger.new(request_app, ['request-tag']).call(Rack::MockRequest.env_for('/'))
102
+ body.close
103
+ Rails.logger.info('after request')
104
+
105
+ events = io.string.lines.map { |line| JSON.parse(line) }
106
+ expect(events.map { |event| [event['message'], event['tags']] }).to include(
107
+ ['inside request', ['request-tag']],
108
+ ['after request', nil]
109
+ )
110
+ end
111
+
112
+ it "tags log lines written during a request through a multi logger" do
113
+ io = StringIO.new
114
+ logger = LogStashLogger.new(type: :multi_logger, outputs: [{ type: :io, io: io }, { type: :io, io: StringIO.new }])
115
+ allow(Rails).to receive(:logger).and_return(logger)
116
+ request_app = lambda do |_env|
117
+ Rails.logger.info('inside request')
118
+ [200, {}, ['ok']]
119
+ end
120
+
121
+ _status, _headers, body = Rails::Rack::Logger.new(request_app, ['request-tag']).call(Rack::MockRequest.env_for('/'))
122
+ body.close
123
+ Rails.logger.info('after request')
124
+
125
+ events = io.string.lines.map { |line| JSON.parse(line) }
126
+ expect(events.map { |event| [event['message'], event['tags']] }).to include(
127
+ ['inside request', ['request-tag']],
128
+ ['after request', nil]
129
+ )
130
+ end
131
+ end
91
132
  end
@@ -28,5 +28,28 @@ describe LogStashLogger do
28
28
 
29
29
  logger.info(message)
30
30
  end
31
+
32
+ it "puts pushed tags on events until they are popped" do
33
+ io = StringIO.new
34
+ logger = LogStashLogger.new(type: :io, io: io)
35
+
36
+ logger.push_tags('bar', 'baz')
37
+ logger.info('tagged')
38
+ logger.pop_tags(2)
39
+ logger.info('untagged')
40
+
41
+ events = io.string.lines.map { |line| JSON.parse(line) }
42
+ expect(events.map { |event| event['tags'] }).to eq([%w[bar baz], nil])
43
+ end
44
+
45
+ it "exposes the current tags" do
46
+ logger = LogStashLogger.new(type: :io, io: StringIO.new)
47
+
48
+ logger.push_tags('bar')
49
+ current_tags = logger.current_tags.dup
50
+ logger.pop_tags
51
+
52
+ expect(current_tags).to eq(['bar'])
53
+ end
31
54
  end
32
55
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-logger-p
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.1
4
+ version: 0.26.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Butler
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-26 00:00:00.000000000 Z
11
+ date: 2026-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: logstash-event
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
296
296
  - !ruby/object:Gem::Version
297
297
  version: '0'
298
298
  requirements: []
299
- rubygems_version: 3.2.3
299
+ rubygems_version: 3.4.10
300
300
  signing_key:
301
301
  specification_version: 4
302
302
  summary: LogStash Logger for ruby