logstash-codec-avro 3.2.2-java → 3.3.1-java
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +12 -0
- data/CONTRIBUTORS +1 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +50 -0
- data/lib/logstash/codecs/avro.rb +30 -7
- data/logstash-codec-avro.gemspec +8 -4
- data/spec/codecs/avro_spec.rb +107 -69
- metadata +66 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 772c2d05da7c85d818be97b57d65587730bc7204624199b670ba1f40de35b8a6
|
|
4
|
+
data.tar.gz: 124b77e35ebc93783576228831ee427081bc9b052535abe8f20108cf962293f4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 42b7e3f92cca071b122851cd18c79735c109570ba42cd4ce82ab87bd19bd887297006d9822d7fecbc5b54e1034ba33b33ab4f98b1c0f1cbb76df4e5f6e3ce36f
|
|
7
|
+
data.tar.gz: 79771d37cc0b6dde478dff2a1f09f026ce644967aaeaf7a8e6ddaf77318d995f17301da3c681391dacd1f8bce9a5ae5e43d6ac5e14b006a93845cc87ae386300
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
## 3.3.1
|
|
2
|
+
- Pin avro gem to 1.10.x, as 1.11+ requires ruby 2.6+ [#37](https://github.com/logstash-plugins/logstash-codec-avro/pull/37)
|
|
3
|
+
|
|
4
|
+
## 3.3.0
|
|
5
|
+
- Add ECS support. Add target option and event.original [#36](https://github.com/logstash-plugins/logstash-codec-avro/pull/36)
|
|
6
|
+
|
|
7
|
+
## 3.2.4
|
|
8
|
+
- [DOC] Add clarifications on partial deserialization [#35](https://github.com/logstash-plugins/logstash-codec-avro/pull/35)
|
|
9
|
+
|
|
10
|
+
## 3.2.3
|
|
11
|
+
- Update gemspec summary
|
|
12
|
+
|
|
1
13
|
## 3.2.2
|
|
2
14
|
- Fix some documentation issues
|
|
3
15
|
|
data/CONTRIBUTORS
CHANGED
|
@@ -4,6 +4,7 @@ reports, or in general have helped logstash along its way.
|
|
|
4
4
|
Contributors:
|
|
5
5
|
* Pier-Hugues Pellerin (ph)
|
|
6
6
|
* Tal Levy (talevy)
|
|
7
|
+
* Luca Belluccini (lucabelluccini)
|
|
7
8
|
|
|
8
9
|
Note: If you've sent us patches, bug reports, or otherwise contributed to
|
|
9
10
|
Logstash, and you aren't on the list above and want to be, please let us know
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Logstash Plugin
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.com/logstash-plugins/logstash-codec-avro)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -26,6 +26,11 @@ This plugin is used to serialize Logstash events as
|
|
|
26
26
|
Avro datums, as well as deserializing Avro datums into
|
|
27
27
|
Logstash events.
|
|
28
28
|
|
|
29
|
+
[id="plugins-{type}s-{plugin}-ecs_metadata"]
|
|
30
|
+
==== Event Metadata and the Elastic Common Schema (ECS)
|
|
31
|
+
|
|
32
|
+
The plugin behaves the same regardless of ECS compatibility, except adding the original message to `[event][original]`.
|
|
33
|
+
|
|
29
34
|
==== Encoding
|
|
30
35
|
|
|
31
36
|
This codec is for serializing individual Logstash events
|
|
@@ -38,6 +43,17 @@ Logstash events into an Avro file.
|
|
|
38
43
|
This codec is for deserializing individual Avro records. It is not for reading
|
|
39
44
|
Avro files. Avro files have a unique format that must be handled upon input.
|
|
40
45
|
|
|
46
|
+
.Partial deserialization
|
|
47
|
+
[NOTE]
|
|
48
|
+
================================================================================
|
|
49
|
+
Avro format is known to support partial deserialization of arbitrary fields,
|
|
50
|
+
providing a schema containing a subset of the schema which was used to serialize
|
|
51
|
+
the data.
|
|
52
|
+
This codec *doesn't support partial deserialization of arbitrary fields*.
|
|
53
|
+
Partial deserialization _might_ work only when providing a schema which contains
|
|
54
|
+
the first `N` fields of the schema used to serialize the data (and
|
|
55
|
+
in the same order).
|
|
56
|
+
================================================================================
|
|
41
57
|
|
|
42
58
|
==== Usage
|
|
43
59
|
Example usage with Kafka input.
|
|
@@ -65,12 +81,25 @@ output {
|
|
|
65
81
|
[cols="<,<,<",options="header",]
|
|
66
82
|
|=======================================================================
|
|
67
83
|
|Setting |Input type|Required
|
|
84
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
|
|
68
85
|
| <<plugins-{type}s-{plugin}-schema_uri>> |<<string,string>>|Yes
|
|
69
86
|
| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<boolean,boolean>>|No
|
|
87
|
+
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|
|
70
88
|
|=======================================================================
|
|
71
89
|
|
|
72
90
|
|
|
73
91
|
|
|
92
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
|
93
|
+
===== `ecs_compatibility`
|
|
94
|
+
|
|
95
|
+
* Value type is <<string,string>>
|
|
96
|
+
* Supported values are:
|
|
97
|
+
** `disabled`: Avro data added at root level
|
|
98
|
+
** `v1`,`v8`: Elastic Common Schema compliant behavior (`[event][original]` is also added)
|
|
99
|
+
|
|
100
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
|
101
|
+
|
|
102
|
+
|
|
74
103
|
[id="plugins-{type}s-{plugin}-schema_uri"]
|
|
75
104
|
===== `schema_uri`
|
|
76
105
|
|
|
@@ -93,4 +122,25 @@ example:
|
|
|
93
122
|
|
|
94
123
|
tag events with `_avroparsefailure` when decode fails
|
|
95
124
|
|
|
125
|
+
[id="plugins-{type}s-{plugin}-target"]
|
|
126
|
+
===== `target`
|
|
127
|
+
|
|
128
|
+
* Value type is <<string,string>>
|
|
129
|
+
* There is no default value for this setting.
|
|
130
|
+
* This is only relevant when decode data into an event
|
|
96
131
|
|
|
132
|
+
Define the target field for placing the values. If this setting is not
|
|
133
|
+
set, the Avro data will be stored at the root (top level) of the event.
|
|
134
|
+
|
|
135
|
+
*Example*
|
|
136
|
+
[source,ruby]
|
|
137
|
+
----------------------------------
|
|
138
|
+
input {
|
|
139
|
+
kafka {
|
|
140
|
+
codec => avro {
|
|
141
|
+
schema_uri => "/tmp/schema.avsc"
|
|
142
|
+
target => "[document]"
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
----------------------------------
|
data/lib/logstash/codecs/avro.rb
CHANGED
|
@@ -6,17 +6,21 @@ require "logstash/codecs/base"
|
|
|
6
6
|
require "logstash/event"
|
|
7
7
|
require "logstash/timestamp"
|
|
8
8
|
require "logstash/util"
|
|
9
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support'
|
|
10
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/target_check'
|
|
11
|
+
require 'logstash/plugin_mixins/validator_support/field_reference_validation_adapter'
|
|
12
|
+
require 'logstash/plugin_mixins/event_support/event_factory_adapter'
|
|
9
13
|
|
|
10
14
|
# Read serialized Avro records as Logstash events
|
|
11
15
|
#
|
|
12
|
-
# This plugin is used to serialize Logstash events as
|
|
13
|
-
# Avro datums, as well as deserializing Avro datums into
|
|
16
|
+
# This plugin is used to serialize Logstash events as
|
|
17
|
+
# Avro datums, as well as deserializing Avro datums into
|
|
14
18
|
# Logstash events.
|
|
15
19
|
#
|
|
16
20
|
# ==== Encoding
|
|
17
|
-
#
|
|
18
|
-
# This codec is for serializing individual Logstash events
|
|
19
|
-
# as Avro datums that are Avro binary blobs. It does not encode
|
|
21
|
+
#
|
|
22
|
+
# This codec is for serializing individual Logstash events
|
|
23
|
+
# as Avro datums that are Avro binary blobs. It does not encode
|
|
20
24
|
# Logstash events into an Avro file.
|
|
21
25
|
#
|
|
22
26
|
#
|
|
@@ -48,6 +52,12 @@ require "logstash/util"
|
|
|
48
52
|
class LogStash::Codecs::Avro < LogStash::Codecs::Base
|
|
49
53
|
config_name "avro"
|
|
50
54
|
|
|
55
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
|
|
56
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
|
|
57
|
+
|
|
58
|
+
extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
|
|
59
|
+
|
|
60
|
+
include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
|
|
51
61
|
|
|
52
62
|
# schema path to fetch the schema from.
|
|
53
63
|
# This can be a 'http' or 'file' scheme URI
|
|
@@ -60,11 +70,22 @@ class LogStash::Codecs::Avro < LogStash::Codecs::Base
|
|
|
60
70
|
# tag events with `_avroparsefailure` when decode fails
|
|
61
71
|
config :tag_on_failure, :validate => :boolean, :default => false
|
|
62
72
|
|
|
73
|
+
# Defines a target field for placing decoded fields.
|
|
74
|
+
# If this setting is omitted, data gets stored at the root (top level) of the event.
|
|
75
|
+
#
|
|
76
|
+
# NOTE: the target is only relevant while decoding data into a new event.
|
|
77
|
+
config :target, :validate => :field_reference
|
|
78
|
+
|
|
63
79
|
def open_and_read(uri_string)
|
|
64
80
|
open(uri_string).read
|
|
65
81
|
end
|
|
66
82
|
|
|
67
83
|
public
|
|
84
|
+
def initialize(*params)
|
|
85
|
+
super
|
|
86
|
+
@original_field = ecs_select[disabled: nil, v1: '[event][original]']
|
|
87
|
+
end
|
|
88
|
+
|
|
68
89
|
def register
|
|
69
90
|
@schema = Avro::Schema.parse(open_and_read(schema_uri))
|
|
70
91
|
end
|
|
@@ -74,11 +95,13 @@ class LogStash::Codecs::Avro < LogStash::Codecs::Base
|
|
|
74
95
|
datum = StringIO.new(Base64.strict_decode64(data)) rescue StringIO.new(data)
|
|
75
96
|
decoder = Avro::IO::BinaryDecoder.new(datum)
|
|
76
97
|
datum_reader = Avro::IO::DatumReader.new(@schema)
|
|
77
|
-
|
|
98
|
+
event = targeted_event_factory.new_event(datum_reader.read(decoder))
|
|
99
|
+
event.set(@original_field, data.dup.freeze) if @original_field
|
|
100
|
+
yield event
|
|
78
101
|
rescue => e
|
|
79
102
|
if tag_on_failure
|
|
80
103
|
@logger.error("Avro parse error, original data now in message field", :error => e)
|
|
81
|
-
yield
|
|
104
|
+
yield event_factory.new_event("message" => data, "tags" => ["_avroparsefailure"])
|
|
82
105
|
else
|
|
83
106
|
raise e
|
|
84
107
|
end
|
data/logstash-codec-avro.gemspec
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-codec-avro'
|
|
4
|
-
s.version = '3.
|
|
4
|
+
s.version = '3.3.1'
|
|
5
5
|
s.platform = 'java'
|
|
6
6
|
s.licenses = ['Apache-2.0']
|
|
7
|
-
s.summary = "
|
|
7
|
+
s.summary = "Reads serialized Avro records as Logstash events"
|
|
8
8
|
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
|
|
9
9
|
s.authors = ["Elastic"]
|
|
10
10
|
s.email = 'info@elastic.co'
|
|
@@ -22,9 +22,13 @@ Gem::Specification.new do |s|
|
|
|
22
22
|
|
|
23
23
|
# Gem dependencies
|
|
24
24
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
25
|
-
|
|
26
|
-
s.add_runtime_dependency
|
|
25
|
+
s.add_runtime_dependency "avro", "~> 1.10.2" #(Apache 2.0 license)
|
|
26
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
|
|
27
|
+
s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0'
|
|
28
|
+
s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
|
|
27
29
|
|
|
28
30
|
s.add_development_dependency 'logstash-devutils'
|
|
31
|
+
s.add_development_dependency 'insist'
|
|
32
|
+
|
|
29
33
|
end
|
|
30
34
|
|
data/spec/codecs/avro_spec.rb
CHANGED
|
@@ -1,83 +1,119 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
2
|
require 'logstash/devutils/rspec/spec_helper'
|
|
3
|
+
require 'insist'
|
|
3
4
|
require 'avro'
|
|
4
5
|
require 'base64'
|
|
5
6
|
require 'logstash/codecs/avro'
|
|
6
7
|
require 'logstash/event'
|
|
8
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
|
|
7
9
|
|
|
8
|
-
describe LogStash::Codecs::Avro do
|
|
10
|
+
describe LogStash::Codecs::Avro, :ecs_compatibility_support, :aggregate_failures do
|
|
9
11
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
+
ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
|
|
13
|
+
before(:each) do
|
|
14
|
+
allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
context "non binary data" do
|
|
18
|
+
let (:avro_config) {{ 'schema_uri' => '
|
|
12
19
|
{"type": "record", "name": "Test",
|
|
13
20
|
"fields": [{"name": "foo", "type": ["null", "string"]},
|
|
14
21
|
{"name": "bar", "type": "int"}]}' }}
|
|
15
|
-
|
|
22
|
+
let (:test_event_hash) { { "foo" => "hello", "bar" => 10 } }
|
|
23
|
+
let (:test_event) {LogStash::Event.new(test_event_hash)}
|
|
16
24
|
|
|
17
|
-
|
|
18
|
-
|
|
25
|
+
subject do
|
|
26
|
+
allow_any_instance_of(LogStash::Codecs::Avro).to \
|
|
19
27
|
receive(:open_and_read).and_return(avro_config['schema_uri'])
|
|
20
|
-
|
|
21
|
-
|
|
28
|
+
next LogStash::Codecs::Avro.new(avro_config)
|
|
29
|
+
end
|
|
22
30
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
31
|
+
context "#decode" do
|
|
32
|
+
it "should return an LogStash::Event from raw and base64 encoded avro data" do
|
|
33
|
+
schema = Avro::Schema.parse(avro_config['schema_uri'])
|
|
34
|
+
dw = Avro::IO::DatumWriter.new(schema)
|
|
35
|
+
buffer = StringIO.new
|
|
36
|
+
encoder = Avro::IO::BinaryEncoder.new(buffer)
|
|
37
|
+
dw.write(test_event.to_hash, encoder)
|
|
38
|
+
|
|
39
|
+
subject.decode(Base64.strict_encode64(buffer.string)) do |event|
|
|
40
|
+
insist {event.is_a? LogStash::Event}
|
|
41
|
+
insist {event.get("foo")} == test_event.get("foo")
|
|
42
|
+
insist {event.get("bar")} == test_event.get("bar")
|
|
43
|
+
expect(event.get('[event][original]')).to eq(Base64.strict_encode64(buffer.string)) if ecs_compatibility != :disabled
|
|
44
|
+
end
|
|
45
|
+
subject.decode(buffer.string) do |event|
|
|
46
|
+
insist {event.is_a? LogStash::Event}
|
|
47
|
+
insist {event.get("foo")} == test_event.get("foo")
|
|
48
|
+
insist {event.get("bar")} == test_event.get("bar")
|
|
49
|
+
expect(event.get('[event][original]')).to eq(buffer.string) if ecs_compatibility != :disabled
|
|
50
|
+
end
|
|
40
51
|
end
|
|
41
|
-
end
|
|
42
52
|
|
|
43
|
-
|
|
44
|
-
|
|
53
|
+
it "should throw exception if decoding fails" do
|
|
54
|
+
expect {subject.decode("not avro") {|_| }}.to raise_error NoMethodError
|
|
55
|
+
end
|
|
45
56
|
end
|
|
46
|
-
end
|
|
47
57
|
|
|
48
|
-
|
|
49
|
-
|
|
58
|
+
context "#decode with tag_on_failure" do
|
|
59
|
+
let (:avro_config) {{ 'schema_uri' => '
|
|
60
|
+
{"type": "record", "name": "Test",
|
|
61
|
+
"fields": [{"name": "foo", "type": ["null", "string"]},
|
|
62
|
+
{"name": "bar", "type": "int"}]}',
|
|
63
|
+
'tag_on_failure' => true}}
|
|
50
64
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
65
|
+
it "should tag event on failure" do
|
|
66
|
+
subject.decode("not avro") do |event|
|
|
67
|
+
insist {event.is_a? LogStash::Event}
|
|
68
|
+
insist {event.get("tags")} == ["_avroparsefailure"]
|
|
69
|
+
end
|
|
55
70
|
end
|
|
56
71
|
end
|
|
57
|
-
end
|
|
58
72
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
73
|
+
context "#decode with target" do
|
|
74
|
+
let(:avro_target) { "avro_target" }
|
|
75
|
+
let (:avro_config) {{ 'schema_uri' => '
|
|
76
|
+
{"type": "record", "name": "Test",
|
|
77
|
+
"fields": [{"name": "foo", "type": ["null", "string"]},
|
|
78
|
+
{"name": "bar", "type": "int"}]}',
|
|
79
|
+
'target' => avro_target}}
|
|
80
|
+
|
|
81
|
+
it "should return an LogStash::Event with content in target" do
|
|
63
82
|
schema = Avro::Schema.parse(avro_config['schema_uri'])
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
83
|
+
dw = Avro::IO::DatumWriter.new(schema)
|
|
84
|
+
buffer = StringIO.new
|
|
85
|
+
encoder = Avro::IO::BinaryEncoder.new(buffer)
|
|
86
|
+
dw.write(test_event.to_hash, encoder)
|
|
87
|
+
|
|
88
|
+
subject.decode(buffer.string) do |event|
|
|
89
|
+
insist {event.get("[#{avro_target}][foo]")} == test_event.get("foo")
|
|
90
|
+
insist {event.get("[#{avro_target}][bar]")} == test_event.get("bar")
|
|
91
|
+
end
|
|
73
92
|
end
|
|
74
|
-
subject.encode(test_event)
|
|
75
|
-
insist {got_event}
|
|
76
93
|
end
|
|
77
94
|
|
|
78
|
-
context "
|
|
95
|
+
context "#encode" do
|
|
96
|
+
it "should return avro data from a LogStash::Event" do
|
|
97
|
+
got_event = false
|
|
98
|
+
subject.on_event do |event, data|
|
|
99
|
+
schema = Avro::Schema.parse(avro_config['schema_uri'])
|
|
100
|
+
datum = StringIO.new(Base64.strict_decode64(data))
|
|
101
|
+
decoder = Avro::IO::BinaryDecoder.new(datum)
|
|
102
|
+
datum_reader = Avro::IO::DatumReader.new(schema)
|
|
103
|
+
record = datum_reader.read(decoder)
|
|
104
|
+
|
|
105
|
+
insist {record["foo"]} == test_event.get("foo")
|
|
106
|
+
insist {record["bar"]} == test_event.get("bar")
|
|
107
|
+
insist {event.is_a? LogStash::Event}
|
|
108
|
+
got_event = true
|
|
109
|
+
end
|
|
110
|
+
subject.encode(test_event)
|
|
111
|
+
insist {got_event}
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
context "binary data" do
|
|
79
115
|
|
|
80
|
-
|
|
116
|
+
let (:avro_config) {{ 'schema_uri' => '{"namespace": "com.systems.test.data",
|
|
81
117
|
"type": "record",
|
|
82
118
|
"name": "TestRecord",
|
|
83
119
|
"fields": [
|
|
@@ -86,29 +122,31 @@ describe LogStash::Codecs::Avro do
|
|
|
86
122
|
{"name": "latitude", "type": ["double", "null"]}
|
|
87
123
|
]
|
|
88
124
|
}' }}
|
|
89
|
-
|
|
125
|
+
let (:test_event) {LogStash::Event.new({ "name" => "foo", "longitude" => 21.01234.to_f, "latitude" => 111.0123.to_f })}
|
|
90
126
|
|
|
91
|
-
|
|
92
|
-
|
|
127
|
+
subject do
|
|
128
|
+
allow_any_instance_of(LogStash::Codecs::Avro).to \
|
|
93
129
|
receive(:open_and_read).and_return(avro_config['schema_uri'])
|
|
94
|
-
|
|
95
|
-
|
|
130
|
+
next LogStash::Codecs::Avro.new(avro_config)
|
|
131
|
+
end
|
|
96
132
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
133
|
+
it "should correctly encode binary data" do
|
|
134
|
+
schema = Avro::Schema.parse(avro_config['schema_uri'])
|
|
135
|
+
dw = Avro::IO::DatumWriter.new(schema)
|
|
136
|
+
buffer = StringIO.new
|
|
137
|
+
encoder = Avro::IO::BinaryEncoder.new(buffer)
|
|
138
|
+
dw.write(test_event.to_hash, encoder)
|
|
103
139
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
140
|
+
subject.decode(Base64.strict_encode64(buffer.string)) do |event|
|
|
141
|
+
insist {event.is_a? LogStash::Event}
|
|
142
|
+
insist {event.get("name")} == test_event.get("name")
|
|
143
|
+
insist {event.get("longitude")} == test_event.get("longitude")
|
|
144
|
+
insist {event.get("latitude")} == test_event.get("latitude")
|
|
145
|
+
end
|
|
109
146
|
end
|
|
110
147
|
end
|
|
111
148
|
end
|
|
149
|
+
|
|
112
150
|
end
|
|
113
151
|
end
|
|
114
152
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-codec-avro
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.3.1
|
|
5
5
|
platform: java
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-12-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -33,12 +33,68 @@ dependencies:
|
|
|
33
33
|
- !ruby/object:Gem::Dependency
|
|
34
34
|
requirement: !ruby/object:Gem::Requirement
|
|
35
35
|
requirements:
|
|
36
|
-
- - "
|
|
36
|
+
- - "~>"
|
|
37
37
|
- !ruby/object:Gem::Version
|
|
38
|
-
version:
|
|
38
|
+
version: 1.10.2
|
|
39
39
|
name: avro
|
|
40
40
|
prerelease: false
|
|
41
41
|
type: :runtime
|
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: 1.10.2
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "~>"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: '1.3'
|
|
53
|
+
name: logstash-mixin-ecs_compatibility_support
|
|
54
|
+
prerelease: false
|
|
55
|
+
type: :runtime
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '1.3'
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
requirement: !ruby/object:Gem::Requirement
|
|
63
|
+
requirements:
|
|
64
|
+
- - "~>"
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: '1.0'
|
|
67
|
+
name: logstash-mixin-event_support
|
|
68
|
+
prerelease: false
|
|
69
|
+
type: :runtime
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - "~>"
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '1.0'
|
|
75
|
+
- !ruby/object:Gem::Dependency
|
|
76
|
+
requirement: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - "~>"
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: '1.0'
|
|
81
|
+
name: logstash-mixin-validator_support
|
|
82
|
+
prerelease: false
|
|
83
|
+
type: :runtime
|
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - "~>"
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '1.0'
|
|
89
|
+
- !ruby/object:Gem::Dependency
|
|
90
|
+
requirement: !ruby/object:Gem::Requirement
|
|
91
|
+
requirements:
|
|
92
|
+
- - ">="
|
|
93
|
+
- !ruby/object:Gem::Version
|
|
94
|
+
version: '0'
|
|
95
|
+
name: logstash-devutils
|
|
96
|
+
prerelease: false
|
|
97
|
+
type: :development
|
|
42
98
|
version_requirements: !ruby/object:Gem::Requirement
|
|
43
99
|
requirements:
|
|
44
100
|
- - ">="
|
|
@@ -50,7 +106,7 @@ dependencies:
|
|
|
50
106
|
- - ">="
|
|
51
107
|
- !ruby/object:Gem::Version
|
|
52
108
|
version: '0'
|
|
53
|
-
name:
|
|
109
|
+
name: insist
|
|
54
110
|
prerelease: false
|
|
55
111
|
type: :development
|
|
56
112
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -58,7 +114,9 @@ dependencies:
|
|
|
58
114
|
- - ">="
|
|
59
115
|
- !ruby/object:Gem::Version
|
|
60
116
|
version: '0'
|
|
61
|
-
description: This gem is a Logstash plugin required to be installed on top of the
|
|
117
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
|
118
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
119
|
+
gem is not a stand-alone program
|
|
62
120
|
email: info@elastic.co
|
|
63
121
|
executables: []
|
|
64
122
|
extensions: []
|
|
@@ -96,10 +154,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
96
154
|
- !ruby/object:Gem::Version
|
|
97
155
|
version: '0'
|
|
98
156
|
requirements: []
|
|
99
|
-
|
|
100
|
-
rubygems_version: 2.4.8
|
|
157
|
+
rubygems_version: 3.1.6
|
|
101
158
|
signing_key:
|
|
102
159
|
specification_version: 4
|
|
103
|
-
summary:
|
|
160
|
+
summary: Reads serialized Avro records as Logstash events
|
|
104
161
|
test_files:
|
|
105
162
|
- spec/codecs/avro_spec.rb
|