logstash-mixin-ecs_compatibility_support 1.0.0-java
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +3 -0
- data/LICENSE +202 -0
- data/README.md +64 -0
- data/lib/logstash/plugin_mixins/ecs_compatibility_support.rb +104 -0
- data/spec/logstash/plugin_mixins/ecs_compatibility_support_spec.rb +144 -0
- metadata +110 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ba10e5399ac0d62b035fb98cbb351e9e3c2cc857a25fa541a18998072e40b20c
|
4
|
+
data.tar.gz: e303a40b0d20f12de4bf57639957c59f12ca30db8e568b99136863e2246e3480
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 65f069880870f66b57b018108fad026d440d665a8fc06fc49c14aeeca1f3e8c4c93e1abfbb2227e2bb87a61a85d8c6bdf220c4efb093e4781f398f5c4334a6da
|
7
|
+
data.tar.gz: 9281a716c7101934d7803baf628b165cfed31716517eeaa8043e585710cb8ade34799b47891ef5679cfaa1342bbc79c107a52187178edf1873c50b77f125624b
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,3 @@
|
|
1
|
+
# 1.0.0
|
2
|
+
|
3
|
+
- Support Mixin for ensuring a plugin has an `ecs_compatibility` method that is configurable from an `ecs_compatibility` option that accepts the literal `disabled` or a v-prefixed integer representing a major ECS version (e.g., `v1`), using the implementation from Logstash core if available.
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright 2020 Elastic and contributors
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# ECS Compatibility Support Mixin
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/logstash-plugins/logstash-mixin-ecs_compatibility_support.svg?branch=master)](https://travis-ci.org/logstash-plugins/logstash-mixin-ecs_compatibility_support)
|
4
|
+
|
5
|
+
This gem provides an API-compatible implementation of ECS-compatiblity mode,
|
6
|
+
allowing plugins to be explicitly configured with `ecs_compatibility` in a way
|
7
|
+
that respects pipeline- and process-level settings where they are available.
|
8
|
+
It can be added as a dependency of any plugin that wishes to implement one or
|
9
|
+
more ECS-compatibility modes while still supporting older Logstash versions.
|
10
|
+
|
11
|
+
## Usage
|
12
|
+
|
13
|
+
1. Add version `~>1.0` of this gem as a runtime dependency of your Logstash plugin's `gemspec`:
|
14
|
+
|
15
|
+
~~~ ruby
|
16
|
+
Gem::Specification.new do |s|
|
17
|
+
# ...
|
18
|
+
|
19
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.0'
|
20
|
+
end
|
21
|
+
~~~
|
22
|
+
|
23
|
+
2. In your plugin code, require this library and include it into your plugin class
|
24
|
+
that already inherits `LogStash::Plugin`:
|
25
|
+
|
26
|
+
~~~ ruby
|
27
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support'
|
28
|
+
|
29
|
+
class LogStash::Inputs::Foo < Logstash::Inputs::Base
|
30
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport
|
31
|
+
|
32
|
+
# ...
|
33
|
+
end
|
34
|
+
~~~
|
35
|
+
|
36
|
+
3. Use the `ecs_compatibility` method, which will reflect the user's desired
|
37
|
+
ECS-Compatibility mode (either `:disabled` or a symbol holding a v-prefixed
|
38
|
+
integer major version of ECS, e.g., `:v1`) after the plugin has been sent
|
39
|
+
`#config_init`; your plugin does not need to know whether the user specified
|
40
|
+
the value in their plugin config or its value was provided by Logstash.
|
41
|
+
|
42
|
+
Care should be taken to handle _all_ possible values:
|
43
|
+
- all ECS major versions that are supported by the plugin
|
44
|
+
- ECS Compatibility being disabled
|
45
|
+
- helpful failure when an unsupported version is requested
|
46
|
+
|
47
|
+
~~~ ruby
|
48
|
+
def register
|
49
|
+
case ecs_compatibility
|
50
|
+
when :disabled
|
51
|
+
# ...
|
52
|
+
when :v1
|
53
|
+
# ...
|
54
|
+
else
|
55
|
+
fail(NotImplementedError, "ECS #{ecs_compatibility} is not supported by this plugin.")
|
56
|
+
end
|
57
|
+
end
|
58
|
+
~~~
|
59
|
+
|
60
|
+
## Development
|
61
|
+
|
62
|
+
This gem:
|
63
|
+
- *MUST* remain API-stable at 1.x
|
64
|
+
- *MUST NOT* introduce additional runtime dependencies
|
@@ -0,0 +1,104 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'logstash/namespace'
|
4
|
+
require 'logstash/plugin'
|
5
|
+
|
6
|
+
module LogStash
|
7
|
+
module PluginMixins
|
8
|
+
##
|
9
|
+
# This `ECSCompatibilitySupport` can be included in any `LogStash::Plugin`,
|
10
|
+
# and will ensure that the plugin provides an `ecs_compatibility` option that
|
11
|
+
# accepts the literal `disabled` or a v-prefixed integer representing a major
|
12
|
+
# version of ECS (e.g., `v1`).
|
13
|
+
#
|
14
|
+
# When included into a Logstash plugin that already has the option (e.g.,
|
15
|
+
# when run on a Logstash release that includes this option on all plugins),
|
16
|
+
# this adapter will _NOT_ override the existing implementation.
|
17
|
+
module ECSCompatibilitySupport
|
18
|
+
##
|
19
|
+
# @api internal (use: `LogStash::Plugin::include`)
|
20
|
+
# @param: a class that inherits `LogStash::Plugin`, typically one
|
21
|
+
# descending from one of the four plugin base classes (e.g.,
|
22
|
+
# `LogStash::Inputs::Base`)
|
23
|
+
# @return [void]
|
24
|
+
def self.included(base)
|
25
|
+
fail(ArgumentError, "`#{base}` must inherit LogStash::Plugin") unless base < LogStash::Plugin
|
26
|
+
|
27
|
+
# If our base does not include an `ecs_compatibility` config option,
|
28
|
+
# include the legacy adapter to ensure it gets defined.
|
29
|
+
base.send(:include, LegacyAdapter) unless base.method_defined?(:ecs_compatibility)
|
30
|
+
end
|
31
|
+
|
32
|
+
##
|
33
|
+
# This `ECSCompatibilitySupport` cannot be extended into an existing object.
|
34
|
+
# @api private
|
35
|
+
#
|
36
|
+
# @param base [Object]
|
37
|
+
# @raise [ArgumentError]
|
38
|
+
def self.extended(base)
|
39
|
+
fail(ArgumentError, "`#{self}` cannot be extended into an existing object.")
|
40
|
+
end
|
41
|
+
|
42
|
+
##
|
43
|
+
# Implements `ecs_compatibility` method backed by an `ecs_compatibility`
|
44
|
+
# config option accepting the literal `disabled` or a v-prefixed integer
|
45
|
+
# representing a major version of ECS (e.g., `v1`).
|
46
|
+
#
|
47
|
+
# @api internal
|
48
|
+
module LegacyAdapter
|
49
|
+
def self.included(base)
|
50
|
+
base.extend(ArgumentValidator)
|
51
|
+
base.config(:ecs_compatibility, :validate => :ecs_compatibility_argument, :default => 'disabled')
|
52
|
+
end
|
53
|
+
|
54
|
+
##
|
55
|
+
# Designed for use by plugins in a `case` statement, this method returns a `Symbol`
|
56
|
+
# representing the current ECS compatibility mode as configured at plugin
|
57
|
+
# initialization, or raises an exception if the mode has not yet been initialized.
|
58
|
+
#
|
59
|
+
# Plugin implementations using this method MUST provide code-paths for:
|
60
|
+
# - the major version(s) they explicitly support,
|
61
|
+
# - ECS Compatibility being disabled, AND
|
62
|
+
# - unknown versions (e.g., an else clause that raises an exception)
|
63
|
+
#
|
64
|
+
# @api public
|
65
|
+
# @return [:disabled, :v1, Symbol]
|
66
|
+
def ecs_compatibility
|
67
|
+
fail('uninitialized') if @ecs_compatibility.nil?
|
68
|
+
|
69
|
+
# NOTE: The @ecs_compatibility instance variable is an implementation detail of
|
70
|
+
# this `LegacyAdapter` and plugins MUST NOT rely in its presence or value.
|
71
|
+
@ecs_compatibility
|
72
|
+
end
|
73
|
+
|
74
|
+
##
|
75
|
+
# Intercepts calls to `validate_value(value, validator)` whose `validator` is
|
76
|
+
# the symbol :ecs_compatibility_argument.
|
77
|
+
#
|
78
|
+
# Ensures that the provided value is either:
|
79
|
+
# - the literal `disabled`; OR
|
80
|
+
# - a v-prefixed integer (e.g., `v1` )
|
81
|
+
#
|
82
|
+
# @api internal
|
83
|
+
module ArgumentValidator
|
84
|
+
V_PREFIXED_INTEGER_PATTERN = %r(\Av[1-9][0-9]?\Z).freeze
|
85
|
+
private_constant :V_PREFIXED_INTEGER_PATTERN
|
86
|
+
|
87
|
+
def validate_value(value, validator)
|
88
|
+
return super unless validator == :ecs_compatibility_argument
|
89
|
+
|
90
|
+
value = deep_replace(value)
|
91
|
+
value = hash_or_array(value)
|
92
|
+
|
93
|
+
if value.size == 1
|
94
|
+
return true, :disabled if value.first.to_s == 'disabled'
|
95
|
+
return true, value.first.to_sym if value.first.to_s =~ V_PREFIXED_INTEGER_PATTERN
|
96
|
+
end
|
97
|
+
|
98
|
+
return false, "Expected a v-prefixed integer major-version number (e.g., `v1`) or the literal `disabled`, got #{value.inspect}"
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,144 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'rspec/its'
|
4
|
+
|
5
|
+
require "logstash-core"
|
6
|
+
|
7
|
+
require 'logstash/inputs/base'
|
8
|
+
require 'logstash/filters/base'
|
9
|
+
require 'logstash/codecs/base'
|
10
|
+
require 'logstash/outputs/base'
|
11
|
+
|
12
|
+
require "logstash/plugin_mixins/ecs_compatibility_support"
|
13
|
+
|
14
|
+
describe LogStash::PluginMixins::ECSCompatibilitySupport do
|
15
|
+
let(:ecs_compatibility_support) { described_class }
|
16
|
+
|
17
|
+
context 'included into a class' do
|
18
|
+
context 'that does not inherit from `LogStash::Plugin`' do
|
19
|
+
let(:plugin_class) { Class.new }
|
20
|
+
it 'fails with an ArgumentError' do
|
21
|
+
expect do
|
22
|
+
plugin_class.send(:include, ecs_compatibility_support)
|
23
|
+
end.to raise_error(ArgumentError, /LogStash::Plugin/)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
[
|
28
|
+
LogStash::Inputs::Base,
|
29
|
+
LogStash::Filters::Base,
|
30
|
+
LogStash::Codecs::Base,
|
31
|
+
LogStash::Outputs::Base
|
32
|
+
].each do |base_class|
|
33
|
+
context "that inherits from `#{base_class}`" do
|
34
|
+
native_support_for_ecs_compatibility = base_class.method_defined?(:ecs_compatibility)
|
35
|
+
|
36
|
+
let(:plugin_base_class) { base_class }
|
37
|
+
|
38
|
+
subject(:plugin_class) do
|
39
|
+
Class.new(plugin_base_class) do
|
40
|
+
config_name 'test'
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
context 'the result' do
|
45
|
+
before(:each) do
|
46
|
+
plugin_class.send(:include, ecs_compatibility_support)
|
47
|
+
end
|
48
|
+
|
49
|
+
it 'supports an `ecs_compatibility` config option' do
|
50
|
+
expect(plugin_class.get_config).to include('ecs_compatibility')
|
51
|
+
end
|
52
|
+
|
53
|
+
it 'defines an `ecs_compatibility` method' do
|
54
|
+
expect(plugin_class.method_defined?(:ecs_compatibility)).to be true
|
55
|
+
end
|
56
|
+
|
57
|
+
# depending on which version of Logstash is running, we either expect
|
58
|
+
# to include or to _NOT_ include the legacy adapter.
|
59
|
+
if native_support_for_ecs_compatibility
|
60
|
+
context 'since base class provides ECS ecs_compatibility config' do
|
61
|
+
its(:ancestors) { is_expected.to_not include(ecs_compatibility_support::LegacyAdapter) }
|
62
|
+
end
|
63
|
+
else
|
64
|
+
context 'since base class does not provide ECS ecs_compatibility config' do
|
65
|
+
its(:ancestors) { is_expected.to include(ecs_compatibility_support::LegacyAdapter) }
|
66
|
+
end
|
67
|
+
|
68
|
+
# TODO: Remove once ECS Compatibility config is included in one or
|
69
|
+
# more Logstash release branches. This speculative spec is meant
|
70
|
+
# to prove that this implementation will not override an existing
|
71
|
+
# implementation.
|
72
|
+
context 'if base class were to include ecs_compatibility config' do
|
73
|
+
let(:plugin_base_class) do
|
74
|
+
Class.new(super()) do
|
75
|
+
config :ecs_compatibility
|
76
|
+
def ecs_compatibility
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
before(:each) do
|
81
|
+
expect(plugin_base_class.method_defined?(:ecs_compatibility)).to be true
|
82
|
+
end
|
83
|
+
its(:ancestors) { is_expected.to_not include(ecs_compatibility_support::LegacyAdapter) }
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# The four plugin base classes override their own `#initialize` to also
|
88
|
+
# send `#config_init`, so we can count on the options being normalized
|
89
|
+
# and available.
|
90
|
+
context 'when initialized' do
|
91
|
+
let(:plugin_options) { Hash.new }
|
92
|
+
subject(:instance) { plugin_class.new(plugin_options) }
|
93
|
+
|
94
|
+
context 'with `ecs_compatibility => v1`' do
|
95
|
+
let(:plugin_options) { super().merge('ecs_compatibility' => 'v1') }
|
96
|
+
its(:ecs_compatibility) { should equal :v1 }
|
97
|
+
end
|
98
|
+
|
99
|
+
context 'with `ecs_compatibility => disabled`' do
|
100
|
+
let(:plugin_options) { super().merge('ecs_compatibility' => 'disabled') }
|
101
|
+
its(:ecs_compatibility) { should equal :disabled }
|
102
|
+
end
|
103
|
+
|
104
|
+
context 'with an invalid value for `ecs_compatibility`' do
|
105
|
+
shared_examples 'invalid value' do |invalid_value|
|
106
|
+
before { allow(plugin_class).to receive(:logger).and_return(logger_stub) }
|
107
|
+
let(:logger_stub) { double('Logger').as_null_object }
|
108
|
+
|
109
|
+
let(:plugin_options) { super().merge('ecs_compatibility' => invalid_value) }
|
110
|
+
|
111
|
+
it 'fails to initialize and emits a helpful log message' do
|
112
|
+
# we cannot rely on internal details of the error that is emitted such as its exact message,
|
113
|
+
# but we can expect the given value to be included in a message logged at ERROR-level.
|
114
|
+
expect { plugin_class.new(plugin_options) }.to raise_error(LogStash::ConfigurationError)
|
115
|
+
expect(logger_stub).to have_received(:error).with(/\b#{Regexp.escape(invalid_value.to_s)}\b/)
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
context('a random string') do
|
120
|
+
include_examples 'invalid value', 'bananas'
|
121
|
+
end
|
122
|
+
|
123
|
+
context('nil') do
|
124
|
+
include_examples 'invalid value', nil
|
125
|
+
end
|
126
|
+
|
127
|
+
context('an integer') do
|
128
|
+
include_examples 'invalid value', 17
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
# we only specify default behaviour in cases where native support is _NOT_ provided.
|
133
|
+
unless native_support_for_ecs_compatibility
|
134
|
+
context 'without an `ecs_compatibility` directive' do
|
135
|
+
its(:ecs_compatibility) { should equal :disabled }
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
metadata
ADDED
@@ -0,0 +1,110 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: logstash-mixin-ecs_compatibility_support
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: java
|
6
|
+
authors:
|
7
|
+
- Elastic
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-07-09 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - ">="
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: 5.0.0
|
19
|
+
name: logstash-core
|
20
|
+
prerelease: false
|
21
|
+
type: :runtime
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 5.0.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - "~>"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '3.9'
|
33
|
+
name: rspec
|
34
|
+
prerelease: false
|
35
|
+
type: :development
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '3.9'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.3'
|
47
|
+
name: rspec-its
|
48
|
+
prerelease: false
|
49
|
+
type: :development
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.3'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '0'
|
61
|
+
name: logstash-codec-plain
|
62
|
+
prerelease: false
|
63
|
+
type: :development
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: This gem is meant to be a dependency of any Logstash plugin that wishes
|
70
|
+
to use the ECS-Compatibility mode introduced in Logstash 7.x while maintaining backward-compatibility
|
71
|
+
with earlier Logstash releases. When used on older Logstash versions, this adapter
|
72
|
+
provides an implementation of ECS-Compatibility mode that can be controlled at the
|
73
|
+
plugin instance level.
|
74
|
+
email: info@elastic.co
|
75
|
+
executables: []
|
76
|
+
extensions: []
|
77
|
+
extra_rdoc_files: []
|
78
|
+
files:
|
79
|
+
- CHANGELOG.md
|
80
|
+
- LICENSE
|
81
|
+
- README.md
|
82
|
+
- lib/logstash/plugin_mixins/ecs_compatibility_support.rb
|
83
|
+
- spec/logstash/plugin_mixins/ecs_compatibility_support_spec.rb
|
84
|
+
homepage: https://github.com/logstash-plugins/logstash-mixin-ecs_compatibility_support
|
85
|
+
licenses:
|
86
|
+
- Apache-2.0
|
87
|
+
metadata: {}
|
88
|
+
post_install_message:
|
89
|
+
rdoc_options: []
|
90
|
+
require_paths:
|
91
|
+
- lib
|
92
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - ">="
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
requirements: []
|
103
|
+
rubyforge_project:
|
104
|
+
rubygems_version: 2.6.11
|
105
|
+
signing_key:
|
106
|
+
specification_version: 4
|
107
|
+
summary: Support for the ECS-Compatibility mode introduced in Logstash 7.x, for plugins
|
108
|
+
wishing to use this API on older Logstashes
|
109
|
+
test_files:
|
110
|
+
- spec/logstash/plugin_mixins/ecs_compatibility_support_spec.rb
|