fluent-plugin-kubernetes_metadata_filter 2.5.0 → 3.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +10 -14
- data/.gitignore +0 -1
- data/.rubocop.yml +57 -0
- data/Gemfile +4 -2
- data/Gemfile.lock +76 -67
- data/README.md +9 -83
- data/Rakefile +15 -11
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/cpu.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/latency.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/loss.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/mem.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/readme.md +88 -0
- data/doc/benchmark/5m-1-2500lps-256b-baseline-01/results.html +127 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/cpu.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/latency.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/loss.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/mem.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/readme.md +97 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-01/results.html +136 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/cpu.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/latency.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/loss.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/mem.png +0 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/readme.md +97 -0
- data/doc/benchmark/5m-1-2500lps-256b-kube-01-marshal-02/results.html +136 -0
- data/fluent-plugin-kubernetes_metadata_filter.gemspec +25 -27
- data/lib/fluent/plugin/filter_kubernetes_metadata.rb +171 -192
- data/lib/fluent/plugin/kubernetes_metadata_cache_strategy.rb +25 -23
- data/lib/fluent/plugin/kubernetes_metadata_common.rb +44 -69
- data/lib/fluent/plugin/kubernetes_metadata_stats.rb +21 -5
- data/lib/fluent/plugin/kubernetes_metadata_test_api_adapter.rb +68 -0
- data/lib/fluent/plugin/kubernetes_metadata_util.rb +33 -0
- data/lib/fluent/plugin/kubernetes_metadata_watch_namespaces.rb +91 -42
- data/lib/fluent/plugin/kubernetes_metadata_watch_pods.rb +108 -47
- data/release_notes.md +42 -0
- data/test/cassettes/kubernetes_get_pod_container_init.yml +145 -0
- data/test/helper.rb +20 -2
- data/test/plugin/test_cache_stats.rb +10 -13
- data/test/plugin/test_cache_strategy.rb +158 -160
- data/test/plugin/test_filter_kubernetes_metadata.rb +340 -616
- data/test/plugin/test_watch_namespaces.rb +188 -125
- data/test/plugin/test_watch_pods.rb +282 -202
- data/test/plugin/watch_test.rb +16 -15
- metadata +77 -67
- /data/test/cassettes/{kubernetes_docker_metadata_dotted_labels.yml → kubernetes_docker_metadata_dotted_slashed_labels.yml} +0 -0
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
#
|
2
4
|
# Fluentd Kubernetes Metadata Filter Plugin - Enrich Fluentd events with
|
3
5
|
# Kubernetes metadata
|
@@ -17,166 +19,227 @@
|
|
17
19
|
# limitations under the License.
|
18
20
|
#
|
19
21
|
require_relative '../helper'
|
20
|
-
require 'ostruct'
|
21
22
|
require_relative 'watch_test'
|
22
23
|
|
23
24
|
class WatchNamespacesTestTest < WatchTest
|
25
|
+
include KubernetesMetadata::WatchNamespaces
|
26
|
+
|
27
|
+
setup do
|
28
|
+
@initial = {
|
29
|
+
kind: 'NamespaceList',
|
30
|
+
metadata: { resourceVersion: '123' },
|
31
|
+
items: [
|
32
|
+
{
|
33
|
+
metadata: {
|
34
|
+
name: 'initial',
|
35
|
+
uid: 'initial_uid'
|
36
|
+
}
|
37
|
+
},
|
38
|
+
{
|
39
|
+
metadata: {
|
40
|
+
name: 'modified',
|
41
|
+
uid: 'modified_uid'
|
42
|
+
}
|
43
|
+
}
|
44
|
+
]
|
45
|
+
}
|
46
|
+
|
47
|
+
@created = {
|
48
|
+
type: 'CREATED',
|
49
|
+
object: {
|
50
|
+
metadata: {
|
51
|
+
name: 'created',
|
52
|
+
uid: 'created_uid'
|
53
|
+
}
|
54
|
+
}
|
55
|
+
}
|
56
|
+
@modified = {
|
57
|
+
type: 'MODIFIED',
|
58
|
+
object: {
|
59
|
+
metadata: {
|
60
|
+
name: 'foo',
|
61
|
+
uid: 'modified_uid'
|
62
|
+
}
|
63
|
+
}
|
64
|
+
}
|
65
|
+
@deleted = {
|
66
|
+
type: 'DELETED',
|
67
|
+
object: {
|
68
|
+
metadata: {
|
69
|
+
name: 'deleteme',
|
70
|
+
uid: 'deleted_uid'
|
71
|
+
}
|
72
|
+
}
|
73
|
+
}
|
74
|
+
@error = {
|
75
|
+
type: 'ERROR',
|
76
|
+
object: {
|
77
|
+
message: 'some error message'
|
78
|
+
}
|
79
|
+
}
|
80
|
+
@gone = {
|
81
|
+
type: 'ERROR',
|
82
|
+
object: {
|
83
|
+
code: 410,
|
84
|
+
kind: 'Status',
|
85
|
+
message: 'too old resource version: 123 (391079)',
|
86
|
+
metadata: {
|
87
|
+
name: 'gone',
|
88
|
+
namespace: 'gone',
|
89
|
+
uid: 'gone_uid'
|
90
|
+
},
|
91
|
+
reason: 'Gone'
|
92
|
+
}
|
93
|
+
}
|
94
|
+
end
|
24
95
|
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
'metadata' => {
|
40
|
-
'name' => 'modified',
|
41
|
-
'uid' => 'modified_uid'
|
42
|
-
}
|
43
|
-
})
|
44
|
-
])
|
45
|
-
|
46
|
-
@created = OpenStruct.new(
|
47
|
-
type: 'CREATED',
|
48
|
-
object: {
|
49
|
-
'metadata' => {
|
50
|
-
'name' => 'created',
|
51
|
-
'uid' => 'created_uid'
|
52
|
-
}
|
53
|
-
}
|
54
|
-
)
|
55
|
-
@modified = OpenStruct.new(
|
56
|
-
type: 'MODIFIED',
|
57
|
-
object: {
|
58
|
-
'metadata' => {
|
59
|
-
'name' => 'foo',
|
60
|
-
'uid' => 'modified_uid'
|
61
|
-
}
|
62
|
-
}
|
63
|
-
)
|
64
|
-
@deleted = OpenStruct.new(
|
65
|
-
type: 'DELETED',
|
66
|
-
object: {
|
67
|
-
'metadata' => {
|
68
|
-
'name' => 'deleteme',
|
69
|
-
'uid' => 'deleted_uid'
|
70
|
-
}
|
71
|
-
}
|
72
|
-
)
|
73
|
-
@error = OpenStruct.new(
|
74
|
-
type: 'ERROR',
|
75
|
-
object: {
|
76
|
-
'message' => 'some error message'
|
77
|
-
}
|
78
|
-
)
|
79
|
-
end
|
80
|
-
|
81
|
-
test 'namespace list caches namespaces' do
|
82
|
-
@client.stub :get_namespaces, @initial do
|
96
|
+
test 'namespace list caches namespaces' do
|
97
|
+
@client.stub :get_namespaces, @initial do
|
98
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
99
|
+
assert_equal(true, @namespace_cache.key?('initial_uid'))
|
100
|
+
assert_equal(true, @namespace_cache.key?('modified_uid'))
|
101
|
+
assert_equal(2, @stats[:namespace_cache_host_updates])
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
test 'namespace list caches namespaces and watch updates' do
|
106
|
+
orig_env_val = ENV['K8S_NODE_NAME']
|
107
|
+
ENV['K8S_NODE_NAME'] = 'aNodeName'
|
108
|
+
@client.stub :get_namespaces, @initial do
|
109
|
+
@client.stub :watch_namespaces, [@modified] do
|
83
110
|
process_namespace_watcher_notices(start_namespace_watch)
|
84
|
-
assert_equal(true, @namespace_cache.key?('initial_uid'))
|
85
|
-
assert_equal(true, @namespace_cache.key?('modified_uid'))
|
86
111
|
assert_equal(2, @stats[:namespace_cache_host_updates])
|
112
|
+
assert_equal(1, @stats[:namespace_cache_watch_updates])
|
87
113
|
end
|
88
114
|
end
|
115
|
+
ENV['K8S_NODE_NAME'] = orig_env_val
|
116
|
+
end
|
89
117
|
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
process_namespace_watcher_notices(start_namespace_watch)
|
96
|
-
assert_equal(2, @stats[:namespace_cache_host_updates])
|
97
|
-
assert_equal(1, @stats[:namespace_cache_watch_updates])
|
98
|
-
end
|
99
|
-
end
|
100
|
-
ENV['K8S_NODE_NAME'] = orig_env_val
|
118
|
+
test 'namespace watch ignores CREATED' do
|
119
|
+
@client.stub :watch_namespaces, [@created] do
|
120
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
121
|
+
assert_equal(false, @namespace_cache.key?('created_uid'))
|
122
|
+
assert_equal(1, @stats[:namespace_cache_watch_ignored])
|
101
123
|
end
|
124
|
+
end
|
102
125
|
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
end
|
126
|
+
test 'namespace watch ignores MODIFIED when info not in cache' do
|
127
|
+
@client.stub :watch_namespaces, [@modified] do
|
128
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
129
|
+
assert_equal(false, @namespace_cache.key?('modified_uid'))
|
130
|
+
assert_equal(1, @stats[:namespace_cache_watch_misses])
|
109
131
|
end
|
132
|
+
end
|
110
133
|
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
134
|
+
test 'namespace watch updates cache when MODIFIED is received and info is cached' do
|
135
|
+
@namespace_cache['modified_uid'] = {}
|
136
|
+
@client.stub :watch_namespaces, [@modified] do
|
137
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
138
|
+
assert_equal(true, @namespace_cache.key?('modified_uid'))
|
139
|
+
assert_equal(1, @stats[:namespace_cache_watch_updates])
|
117
140
|
end
|
141
|
+
end
|
118
142
|
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
143
|
+
test 'namespace watch ignores DELETED' do
|
144
|
+
@namespace_cache['deleted_uid'] = {}
|
145
|
+
@client.stub :watch_namespaces, [@deleted] do
|
146
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
147
|
+
assert_equal(true, @namespace_cache.key?('deleted_uid'))
|
148
|
+
assert_equal(1, @stats[:namespace_cache_watch_deletes_ignored])
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
test 'namespace watch raises Fluent::UnrecoverableError when cannot re-establish connection to k8s API server' do
|
153
|
+
# Stub start_namespace_watch to simulate initial successful connection to API server
|
154
|
+
stub(self).start_namespace_watch
|
155
|
+
# Stub watch_namespaces to simluate not being able to set up watch connection to API server
|
156
|
+
stub(@client).watch_namespaces { raise }
|
157
|
+
@client.stub :get_namespaces, @initial do
|
158
|
+
assert_raise Fluent::UnrecoverableError do
|
159
|
+
set_up_namespace_thread
|
125
160
|
end
|
126
161
|
end
|
162
|
+
assert_equal(3, @stats[:namespace_watch_failures])
|
163
|
+
assert_equal(2, Thread.current[:namespace_watch_retry_count])
|
164
|
+
assert_equal(4, Thread.current[:namespace_watch_retry_backoff_interval])
|
165
|
+
assert_nil(@stats[:namespace_watch_error_type_notices])
|
166
|
+
end
|
127
167
|
|
128
|
-
|
129
|
-
|
130
|
-
@client.stub :watch_namespaces, [@
|
131
|
-
|
132
|
-
|
133
|
-
|
168
|
+
test 'namespace watch resets watch retry count when exceptions are encountered and connection to k8s API server is re-established' do
|
169
|
+
@client.stub :get_namespaces, @initial do
|
170
|
+
@client.stub :watch_namespaces, [[@created, @exception_raised]] do
|
171
|
+
# Force the infinite watch loop to exit after 3 seconds. Verifies that
|
172
|
+
# no unrecoverable error was thrown during this period of time.
|
173
|
+
assert_raise Timeout::Error.new('execution expired') do
|
174
|
+
Timeout.timeout(3) do
|
175
|
+
set_up_namespace_thread
|
176
|
+
end
|
177
|
+
end
|
178
|
+
assert_operator(@stats[:namespace_watch_failures], :>=, 3)
|
179
|
+
assert_operator(Thread.current[:namespace_watch_retry_count], :<=, 1)
|
180
|
+
assert_operator(Thread.current[:namespace_watch_retry_backoff_interval], :<=, 1)
|
134
181
|
end
|
135
182
|
end
|
183
|
+
end
|
136
184
|
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
185
|
+
test 'namespace watch resets watch retry count when error is received and connection to k8s API server is re-established' do
|
186
|
+
@client.stub :get_namespaces, @initial do
|
187
|
+
@client.stub :watch_namespaces, [@error] do
|
188
|
+
# Force the infinite watch loop to exit after 3 seconds. Verifies that
|
189
|
+
# no unrecoverable error was thrown during this period of time.
|
190
|
+
assert_raise Timeout::Error.new('execution expired') do
|
191
|
+
Timeout.timeout(3) do
|
141
192
|
set_up_namespace_thread
|
142
193
|
end
|
143
|
-
assert_equal(3, @stats[:namespace_watch_failures])
|
144
|
-
assert_equal(2, Thread.current[:namespace_watch_retry_count])
|
145
|
-
assert_equal(4, Thread.current[:namespace_watch_retry_backoff_interval])
|
146
|
-
assert_nil(@stats[:namespace_watch_error_type_notices])
|
147
194
|
end
|
195
|
+
assert_operator(@stats[:namespace_watch_failures], :>=, 3)
|
196
|
+
assert_operator(Thread.current[:namespace_watch_retry_count], :<=, 1)
|
197
|
+
assert_operator(Thread.current[:namespace_watch_retry_backoff_interval], :<=, 1)
|
148
198
|
end
|
149
199
|
end
|
200
|
+
end
|
150
201
|
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
202
|
+
test 'namespace watch continues after retries succeed' do
|
203
|
+
@client.stub :get_namespaces, @initial do
|
204
|
+
@client.stub :watch_namespaces, [@modified, @error, @modified] do
|
205
|
+
# Force the infinite watch loop to exit after 3 seconds. Verifies that
|
206
|
+
# no unrecoverable error was thrown during this period of time.
|
207
|
+
assert_raise Timeout::Error.new('execution expired') do
|
208
|
+
Timeout.timeout(3) do
|
155
209
|
set_up_namespace_thread
|
156
210
|
end
|
157
|
-
assert_equal(3, @stats[:namespace_watch_failures])
|
158
|
-
assert_equal(2, Thread.current[:namespace_watch_retry_count])
|
159
|
-
assert_equal(4, Thread.current[:namespace_watch_retry_backoff_interval])
|
160
|
-
assert_equal(3, @stats[:namespace_watch_error_type_notices])
|
161
211
|
end
|
212
|
+
assert_operator(@stats[:namespace_watch_failures], :>=, 3)
|
213
|
+
assert_operator(Thread.current[:namespace_watch_retry_count], :<=, 1)
|
214
|
+
assert_operator(Thread.current[:namespace_watch_retry_backoff_interval], :<=, 1)
|
215
|
+
assert_operator(@stats[:namespace_watch_error_type_notices], :>=, 3)
|
162
216
|
end
|
163
217
|
end
|
218
|
+
end
|
164
219
|
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
220
|
+
test 'namespace watch raises a GoneError when a 410 Gone error is received' do
|
221
|
+
@cache['gone_uid'] = {}
|
222
|
+
@client.stub :watch_namespaces, [@gone] do
|
223
|
+
assert_raise KubernetesMetadata::Common::GoneError do
|
224
|
+
process_namespace_watcher_notices(start_namespace_watch)
|
225
|
+
end
|
226
|
+
assert_equal(1, @stats[:namespace_watch_gone_notices])
|
227
|
+
end
|
228
|
+
end
|
229
|
+
|
230
|
+
test 'namespace watch retries when 410 Gone errors are encountered' do
|
231
|
+
@client.stub :get_namespaces, @initial do
|
232
|
+
@client.stub :watch_namespaces, [@created, @gone, @modified] do
|
233
|
+
# Force the infinite watch loop to exit after 3 seconds. Verifies that
|
234
|
+
# no unrecoverable error was thrown during this period of time.
|
235
|
+
assert_raise Timeout::Error.new('execution expired') do
|
236
|
+
Timeout.timeout(3) do
|
237
|
+
set_up_namespace_thread
|
174
238
|
end
|
175
|
-
assert_operator(@stats[:namespace_watch_failures], :>=, 3)
|
176
|
-
assert_operator(Thread.current[:namespace_watch_retry_count], :<=, 1)
|
177
|
-
assert_operator(Thread.current[:namespace_watch_retry_backoff_interval], :<=, 1)
|
178
|
-
assert_operator(@stats[:namespace_watch_error_type_notices], :>=, 3)
|
179
239
|
end
|
240
|
+
assert_operator(@stats[:namespace_watch_gone_errors], :>=, 3)
|
241
|
+
assert_operator(@stats[:namespace_watch_gone_notices], :>=, 3)
|
180
242
|
end
|
181
243
|
end
|
244
|
+
end
|
182
245
|
end
|