logstash-codec-json_lines 3.0.6 → 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/CHANGELOG.md +7 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +33 -0
- data/lib/logstash/codecs/json_lines.rb +34 -20
- data/logstash-codec-json_lines.gemspec +8 -3
- data/spec/codecs/json_lines_spec.rb +43 -15
- metadata +68 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d755546df11b55f67fe5d75b1062988fc8acf5f04883c0843d4dc4b67ee6e110
|
|
4
|
+
data.tar.gz: a3377cb9ba69e200724f4552db30541a67dd0a5174126158ce172a99e573e0d8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a2d11e5da18e6ab3b478122a06e4bb247f864e5921888a9e4dd8d52a963a1389a2d2b9f9812f09dcef8284006a71b97be86b62961d25d0007b3c4aee4109e199
|
|
7
|
+
data.tar.gz: fbbb593297ad8fc1090f98da984c1e894ec0013b84aa1eb5fdae767e2ac89093366a1e8ecddbef6c304d65cf134ca3d3961fa40b7aabf01b1991453d613660ca
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## 3.2.0
|
|
2
|
+
- Add decode_size_limit_bytes option to limit the maximum size of each JSON line that can be parsed.[#43](https://github.com/logstash-plugins/logstash-codec-json_lines/pull/43)
|
|
3
|
+
|
|
4
|
+
## 3.1.0
|
|
5
|
+
- Feat: event `target => namespace` support (ECS) [#41](https://github.com/logstash-plugins/logstash-codec-json_lines/pull/41)
|
|
6
|
+
- Refactor: dropped support for old Logstash versions (< 6.0)
|
|
7
|
+
|
|
1
8
|
## 3.0.6
|
|
2
9
|
- Support flush method, see https://github.com/logstash-plugins/logstash-codec-json_lines/pull/35
|
|
3
10
|
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012-2018 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-json_lines)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -36,6 +36,8 @@ Therefore this codec cannot work with line oriented inputs.
|
|
|
36
36
|
|Setting |Input type|Required
|
|
37
37
|
| <<plugins-{type}s-{plugin}-charset>> |<<string,string>>, one of `["ASCII-8BIT", "UTF-8", "US-ASCII", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB2312", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-31J", "Windows-1250", "Windows-1251", "Windows-1252", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "IBM037", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "EUC-JIS-2004", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "ebcdic-cp-us", "eucJP", "euc-jp-ms", "EUC-JISX0213", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "ISO8859-2", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP932", "csWindows31J", "SJIS", "PCK", "CP1250", "CP1251", "CP1252", "external", "locale"]`|No
|
|
38
38
|
| <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
|
|
39
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
|
|
40
|
+
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|
|
39
41
|
|=======================================================================
|
|
40
42
|
|
|
41
43
|
|
|
@@ -64,4 +66,35 @@ For nxlog users, you'll want to set this to `CP1252`
|
|
|
64
66
|
|
|
65
67
|
Change the delimiter that separates lines
|
|
66
68
|
|
|
69
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
|
70
|
+
===== `ecs_compatibility`
|
|
71
|
+
|
|
72
|
+
* Value type is <<string,string>>
|
|
73
|
+
* Supported values are:
|
|
74
|
+
** `disabled`: does not use ECS-compatible field names
|
|
75
|
+
** `v1`, `v8`: Elastic Common Schema compliant behavior (warns when `target` isn't set)
|
|
76
|
+
* Default value depends on which version of Logstash is running:
|
|
77
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
|
78
|
+
** Otherwise, the default value is `disabled`
|
|
79
|
+
|
|
80
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
|
81
|
+
|
|
82
|
+
[id="plugins-{type}s-{plugin}-target"]
|
|
83
|
+
===== `target`
|
|
84
|
+
|
|
85
|
+
* Value type is <<string,string>>
|
|
86
|
+
* There is no default value for this setting.
|
|
87
|
+
|
|
88
|
+
Define the target field for placing the parsed data. If this setting is not
|
|
89
|
+
set, the JSON data will be stored at the root (top level) of the event.
|
|
90
|
+
|
|
91
|
+
For example, if you want data to be put under the `document` field:
|
|
92
|
+
[source,ruby]
|
|
93
|
+
input {
|
|
94
|
+
http {
|
|
95
|
+
codec => json_lines {
|
|
96
|
+
target => "[document]"
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
67
100
|
|
|
@@ -3,6 +3,11 @@ require "logstash/codecs/base"
|
|
|
3
3
|
require "logstash/util/charset"
|
|
4
4
|
require "logstash/util/buftok"
|
|
5
5
|
require "logstash/json"
|
|
6
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support'
|
|
7
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/target_check'
|
|
8
|
+
require 'logstash/plugin_mixins/validator_support/field_reference_validation_adapter'
|
|
9
|
+
require 'logstash/plugin_mixins/event_support/event_factory_adapter'
|
|
10
|
+
require 'logstash/plugin_mixins/event_support/from_json_helper'
|
|
6
11
|
|
|
7
12
|
# This codec will decode streamed JSON that is newline delimited.
|
|
8
13
|
# Encoding will emit a single JSON string ending in a `@delimiter`
|
|
@@ -12,6 +17,15 @@ require "logstash/json"
|
|
|
12
17
|
# terminated lines. The file input will produce a line string without a newline.
|
|
13
18
|
# Therefore this codec cannot work with line oriented inputs.
|
|
14
19
|
class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
|
|
20
|
+
|
|
21
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport
|
|
22
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
|
|
23
|
+
|
|
24
|
+
extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
|
|
25
|
+
|
|
26
|
+
include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
|
|
27
|
+
include LogStash::PluginMixins::EventSupport::FromJsonHelper
|
|
28
|
+
|
|
15
29
|
config_name "json_lines"
|
|
16
30
|
|
|
17
31
|
# The character encoding used in this codec. Examples include `UTF-8` and
|
|
@@ -28,17 +42,27 @@ class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
|
|
|
28
42
|
# Change the delimiter that separates lines
|
|
29
43
|
config :delimiter, :validate => :string, :default => "\n"
|
|
30
44
|
|
|
45
|
+
# Maximum number of bytes for a single line before a fatal exception is raised
|
|
46
|
+
# which will stop Logsash.
|
|
47
|
+
# The default is 20MB which is quite large for a JSON document
|
|
48
|
+
config :decode_size_limit_bytes, :validate => :number, :default => 20 * (1024 * 1024) # 20MB
|
|
49
|
+
|
|
50
|
+
# Defines a target field for placing decoded fields.
|
|
51
|
+
# If this setting is omitted, data gets stored at the root (top level) of the event.
|
|
52
|
+
# The target is only relevant while decoding data into a new event.
|
|
53
|
+
config :target, :validate => :field_reference
|
|
54
|
+
|
|
31
55
|
public
|
|
32
56
|
|
|
33
57
|
def register
|
|
34
|
-
@buffer = FileWatch::BufferedTokenizer.new(@delimiter)
|
|
58
|
+
@buffer = FileWatch::BufferedTokenizer.new(@delimiter, @decode_size_limit_bytes)
|
|
35
59
|
@converter = LogStash::Util::Charset.new(@charset)
|
|
36
60
|
@converter.logger = @logger
|
|
37
61
|
end
|
|
38
62
|
|
|
39
63
|
def decode(data, &block)
|
|
40
64
|
@buffer.extract(data).each do |line|
|
|
41
|
-
|
|
65
|
+
parse_json(@converter.convert(line), &block)
|
|
42
66
|
end
|
|
43
67
|
end
|
|
44
68
|
|
|
@@ -51,31 +75,21 @@ class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
|
|
|
51
75
|
def flush(&block)
|
|
52
76
|
remainder = @buffer.flush
|
|
53
77
|
if !remainder.empty?
|
|
54
|
-
|
|
78
|
+
parse_json(@converter.convert(remainder), &block)
|
|
55
79
|
end
|
|
56
80
|
end
|
|
57
81
|
|
|
58
82
|
private
|
|
59
83
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
yield LogStash::Event.new("message" => json, "tags" => ["_jsonparsefailure"])
|
|
84
|
+
def parse_json(json)
|
|
85
|
+
events_from_json(json, targeted_event_factory).each { |event| yield event }
|
|
86
|
+
rescue => e
|
|
87
|
+
@logger.warn("JSON parse error, original data now in message field", message: e.message, exception: e.class, data: json)
|
|
88
|
+
yield parse_json_error_event(json)
|
|
66
89
|
end
|
|
67
90
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
# ignore empty/blank lines which LogStash::Json#load returns as nil
|
|
71
|
-
o = LogStash::Json.load(json)
|
|
72
|
-
yield(LogStash::Event.new(o)) if o
|
|
73
|
-
rescue LogStash::Json::ParserError => e
|
|
74
|
-
@logger.warn("JSON parse error, original data now in message field", :error => e, :data => json)
|
|
75
|
-
yield LogStash::Event.new("message" => json, "tags" => ["_jsonparsefailure"])
|
|
91
|
+
def parse_json_error_event(json)
|
|
92
|
+
event_factory.new_event("message" => json, "tags" => ["_jsonparsefailure"])
|
|
76
93
|
end
|
|
77
94
|
|
|
78
|
-
# keep compatibility with all v2.x distributions. only in 2.3 will the Event#from_json method be introduced
|
|
79
|
-
# and we need to keep compatibility for all v2 releases.
|
|
80
|
-
alias_method :parse, LogStash::Event.respond_to?(:from_json) ? :from_json_parse : :legacy_parse
|
|
81
95
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-codec-json_lines'
|
|
4
|
-
s.version = '3.0
|
|
4
|
+
s.version = '3.2.0'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
6
|
s.summary = "Reads and writes newline-delimited JSON"
|
|
7
7
|
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"
|
|
@@ -19,11 +19,16 @@ Gem::Specification.new do |s|
|
|
|
19
19
|
# Special flag to let us know this is actually a logstash plugin
|
|
20
20
|
s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
|
|
21
21
|
|
|
22
|
+
s.required_ruby_version = '>= 2.3' # Event.from_json exists at least since LS 5.6
|
|
23
|
+
|
|
22
24
|
# Gem dependencies
|
|
23
25
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
26
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
|
|
27
|
+
s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0', '>= 1.0.1'
|
|
28
|
+
s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
|
|
24
29
|
|
|
25
|
-
s.
|
|
26
|
-
|
|
30
|
+
s.add_development_dependency 'logstash-codec-line', '>= 2.1.0'
|
|
27
31
|
s.add_development_dependency 'logstash-devutils'
|
|
32
|
+
s.add_development_dependency 'insist'
|
|
28
33
|
end
|
|
29
34
|
|
|
@@ -4,8 +4,9 @@ require "logstash/codecs/json_lines"
|
|
|
4
4
|
require "logstash/event"
|
|
5
5
|
require "logstash/json"
|
|
6
6
|
require "insist"
|
|
7
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
|
|
7
8
|
|
|
8
|
-
describe LogStash::Codecs::JSONLines do
|
|
9
|
+
describe LogStash::Codecs::JSONLines, :ecs_compatibility_support do
|
|
9
10
|
|
|
10
11
|
let(:codec_options) { {} }
|
|
11
12
|
|
|
@@ -117,6 +118,22 @@ describe LogStash::Codecs::JSONLines do
|
|
|
117
118
|
end
|
|
118
119
|
end
|
|
119
120
|
|
|
121
|
+
describe "decode_size_limits_bytes" do
|
|
122
|
+
let(:maximum_payload) { "a" * subject.decode_size_limit_bytes }
|
|
123
|
+
|
|
124
|
+
it "should not raise an error if the number of bytes is not exceeded" do
|
|
125
|
+
expect {
|
|
126
|
+
subject.decode(maximum_payload)
|
|
127
|
+
}.not_to raise_error
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
it "should raise an error if the max bytes are exceeded" do
|
|
131
|
+
expect {
|
|
132
|
+
subject.decode(maximum_payload << "z")
|
|
133
|
+
}.to raise_error(java.lang.IllegalStateException, "input buffer full")
|
|
134
|
+
end
|
|
135
|
+
end
|
|
136
|
+
|
|
120
137
|
end
|
|
121
138
|
|
|
122
139
|
context "#encode" do
|
|
@@ -185,29 +202,40 @@ describe LogStash::Codecs::JSONLines do
|
|
|
185
202
|
end
|
|
186
203
|
end
|
|
187
204
|
|
|
188
|
-
|
|
205
|
+
ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do
|
|
189
206
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
207
|
+
before(:each) do
|
|
208
|
+
allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
context 'with target' do
|
|
212
|
+
let(:input) do
|
|
213
|
+
%{{"field": "value1"}
|
|
214
|
+
{"field": 2.0}
|
|
215
|
+
}
|
|
195
216
|
end
|
|
196
217
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
218
|
+
let(:codec_options) { super().merge "target" => 'foo' }
|
|
219
|
+
|
|
220
|
+
let(:collector) { Array.new }
|
|
221
|
+
|
|
222
|
+
it 'should generate two events' do
|
|
223
|
+
subject.decode(input) do |event|
|
|
224
|
+
collector.push(event)
|
|
203
225
|
end
|
|
226
|
+
expect(collector.size).to eq(2)
|
|
227
|
+
expect(collector[0].include?('field')).to be false
|
|
228
|
+
expect(collector[0].get('foo')).to eql 'field' => 'value1'
|
|
229
|
+
expect(collector[1].include?('field')).to be false
|
|
230
|
+
expect(collector[1].get('foo')).to eql 'field' => 2.0
|
|
204
231
|
end
|
|
205
232
|
end
|
|
233
|
+
|
|
234
|
+
end
|
|
235
|
+
|
|
206
236
|
end
|
|
207
237
|
|
|
208
238
|
context "default parser choice" do
|
|
209
|
-
# here we cannot force the use of the Event#from_json since if this test is run in the
|
|
210
|
-
# legacy context (no Java Event) it will fail but if in the new context, it will be picked up.
|
|
211
239
|
it_behaves_like :codec do
|
|
212
240
|
subject do
|
|
213
241
|
# register method is called in the constructor
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-codec-json_lines
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0
|
|
4
|
+
version: 3.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-08-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -20,8 +20,8 @@ dependencies:
|
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
21
|
version: '2.99'
|
|
22
22
|
name: logstash-core-plugin-api
|
|
23
|
-
prerelease: false
|
|
24
23
|
type: :runtime
|
|
24
|
+
prerelease: false
|
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
@@ -30,6 +30,54 @@ dependencies:
|
|
|
30
30
|
- - "<="
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: '2.99'
|
|
33
|
+
- !ruby/object:Gem::Dependency
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - "~>"
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '1.3'
|
|
39
|
+
name: logstash-mixin-ecs_compatibility_support
|
|
40
|
+
type: :runtime
|
|
41
|
+
prerelease: false
|
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '1.3'
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "~>"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: '1.0'
|
|
53
|
+
- - ">="
|
|
54
|
+
- !ruby/object:Gem::Version
|
|
55
|
+
version: 1.0.1
|
|
56
|
+
name: logstash-mixin-event_support
|
|
57
|
+
type: :runtime
|
|
58
|
+
prerelease: false
|
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
60
|
+
requirements:
|
|
61
|
+
- - "~>"
|
|
62
|
+
- !ruby/object:Gem::Version
|
|
63
|
+
version: '1.0'
|
|
64
|
+
- - ">="
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: 1.0.1
|
|
67
|
+
- !ruby/object:Gem::Dependency
|
|
68
|
+
requirement: !ruby/object:Gem::Requirement
|
|
69
|
+
requirements:
|
|
70
|
+
- - "~>"
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: '1.0'
|
|
73
|
+
name: logstash-mixin-validator_support
|
|
74
|
+
type: :runtime
|
|
75
|
+
prerelease: false
|
|
76
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - "~>"
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: '1.0'
|
|
33
81
|
- !ruby/object:Gem::Dependency
|
|
34
82
|
requirement: !ruby/object:Gem::Requirement
|
|
35
83
|
requirements:
|
|
@@ -37,8 +85,8 @@ dependencies:
|
|
|
37
85
|
- !ruby/object:Gem::Version
|
|
38
86
|
version: 2.1.0
|
|
39
87
|
name: logstash-codec-line
|
|
88
|
+
type: :development
|
|
40
89
|
prerelease: false
|
|
41
|
-
type: :runtime
|
|
42
90
|
version_requirements: !ruby/object:Gem::Requirement
|
|
43
91
|
requirements:
|
|
44
92
|
- - ">="
|
|
@@ -51,8 +99,22 @@ dependencies:
|
|
|
51
99
|
- !ruby/object:Gem::Version
|
|
52
100
|
version: '0'
|
|
53
101
|
name: logstash-devutils
|
|
102
|
+
type: :development
|
|
54
103
|
prerelease: false
|
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
105
|
+
requirements:
|
|
106
|
+
- - ">="
|
|
107
|
+
- !ruby/object:Gem::Version
|
|
108
|
+
version: '0'
|
|
109
|
+
- !ruby/object:Gem::Dependency
|
|
110
|
+
requirement: !ruby/object:Gem::Requirement
|
|
111
|
+
requirements:
|
|
112
|
+
- - ">="
|
|
113
|
+
- !ruby/object:Gem::Version
|
|
114
|
+
version: '0'
|
|
115
|
+
name: insist
|
|
55
116
|
type: :development
|
|
117
|
+
prerelease: false
|
|
56
118
|
version_requirements: !ruby/object:Gem::Requirement
|
|
57
119
|
requirements:
|
|
58
120
|
- - ">="
|
|
@@ -90,15 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
90
152
|
requirements:
|
|
91
153
|
- - ">="
|
|
92
154
|
- !ruby/object:Gem::Version
|
|
93
|
-
version: '
|
|
155
|
+
version: '2.3'
|
|
94
156
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
95
157
|
requirements:
|
|
96
158
|
- - ">="
|
|
97
159
|
- !ruby/object:Gem::Version
|
|
98
160
|
version: '0'
|
|
99
161
|
requirements: []
|
|
100
|
-
|
|
101
|
-
rubygems_version: 2.6.13
|
|
162
|
+
rubygems_version: 3.3.26
|
|
102
163
|
signing_key:
|
|
103
164
|
specification_version: 4
|
|
104
165
|
summary: Reads and writes newline-delimited JSON
|