logstash-codec-csv 1.0.0 → 1.1.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 +4 -0
- data/LICENSE +199 -10
- data/docs/index.asciidoc +43 -1
- data/lib/logstash/codecs/csv.rb +38 -11
- data/logstash-codec-csv.gemspec +4 -1
- data/spec/codecs/csv_spec.rb +148 -110
- metadata +47 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b0ee61a8601e503967b9682792838e941d543a8513eea39e16d427dae4539154
|
4
|
+
data.tar.gz: dd950c0a24b7ad601ed0fba1cf3344e9cd460a59af3151eca02cb16b2f885d01
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d085d074262a43fcc4f68d5b8dc83b41c8a56625b8f15429c786c85e92916256b719ca5511650dbed860d765148b386a6a84f68f9dd038d60533d9d2b47489b
|
7
|
+
data.tar.gz: e908a388ad958441e3fd8c5452bc8b2b078e75353a02c2988198ab14b9b829c8dc95d4e0fcee5fcbc42ef75a39521575b654701c54999e64eb1326c2afa5597b
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,9 @@
|
|
1
|
+
## 1.1.0
|
2
|
+
- Feat: added target => namespace support + ECS compatibility [#7](https://github.com/logstash-plugins/logstash-codec-csv/pull/7)
|
3
|
+
|
1
4
|
## 1.0.0
|
2
5
|
- Fixed dependencies to work with logstash v6 and up. Overhauled to match features of the CSV Filter. Improved spec coverage [#4](https://github.com/logstash-plugins/logstash-codec-csv/pull/4)
|
6
|
+
|
3
7
|
## 0.1.5
|
4
8
|
- Fixed asciidoc formatting for example [#3](https://github.com/logstash-plugins/logstash-codec-csv/pull/3)
|
5
9
|
|
data/LICENSE
CHANGED
@@ -1,13 +1,202 @@
|
|
1
|
-
Copyright (c) 2012-2018 Elasticsearch <http://www.elasticsearch.org>
|
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/docs/index.asciidoc
CHANGED
@@ -22,8 +22,15 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
22
22
|
|
23
23
|
The csv codec takes CSV data, parses it and passes it along.
|
24
24
|
|
25
|
+
[id="plugins-{type}s-{plugin}-ecs"]
|
26
|
+
==== Compatibility with the Elastic Common Schema (ECS)
|
27
|
+
|
28
|
+
The plugin behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn't set.
|
29
|
+
|
30
|
+
TIP: Set the `target` option to avoid potential schema conflicts.
|
31
|
+
|
25
32
|
[id="plugins-{type}s-{plugin}-options"]
|
26
|
-
==== Csv Codec
|
33
|
+
==== Csv Codec configuration options
|
27
34
|
|
28
35
|
[cols="<,<,<",options="header",]
|
29
36
|
|=======================================================================
|
@@ -33,10 +40,12 @@ The csv codec takes CSV data, parses it and passes it along.
|
|
33
40
|
| <<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
|
34
41
|
| <<plugins-{type}s-{plugin}-columns>> |<<array,array>>|No
|
35
42
|
| <<plugins-{type}s-{plugin}-convert>> |<<hash,hash>>|No
|
43
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
|
36
44
|
| <<plugins-{type}s-{plugin}-include_headers>> |<<boolean,boolean>>|No
|
37
45
|
| <<plugins-{type}s-{plugin}-quote_char>> |<<string,string>>|No
|
38
46
|
| <<plugins-{type}s-{plugin}-separator>> |<<string,string>>|No
|
39
47
|
| <<plugins-{type}s-{plugin}-skip_empty_columns>> |<<boolean,boolean>>|No
|
48
|
+
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|
40
49
|
|=======================================================================
|
41
50
|
|
42
51
|
|
@@ -102,6 +111,19 @@ Possible conversions are: `integer`, `float`, `date`, `date_time`, `boolean`
|
|
102
111
|
}
|
103
112
|
}
|
104
113
|
|
114
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
115
|
+
===== `ecs_compatibility`
|
116
|
+
|
117
|
+
* Value type is <<string,string>>
|
118
|
+
* Supported values are:
|
119
|
+
** `disabled`: CSV data added at root level
|
120
|
+
** `v1`,`v8`: Elastic Common Schema compliant behavior (`[event][original]` is also added)
|
121
|
+
* Default value depends on which version of Logstash is running:
|
122
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
123
|
+
** Otherwise, the default value is `disabled`
|
124
|
+
|
125
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
126
|
+
|
105
127
|
[id="plugins-{type}s-{plugin}-include_headers"]
|
106
128
|
===== `include_headers`
|
107
129
|
|
@@ -140,4 +162,24 @@ Optional.
|
|
140
162
|
Define whether empty columns should be skipped.
|
141
163
|
Defaults to false. If set to true, columns containing no value will not be included.
|
142
164
|
|
165
|
+
[id="plugins-{type}s-{plugin}-target"]
|
166
|
+
===== `target`
|
167
|
+
|
168
|
+
* Value type is <<string,string>>
|
169
|
+
* There is no default value for this setting.
|
170
|
+
|
171
|
+
Define the target field for placing the row values. If this setting is not
|
172
|
+
set, the CSV data will be stored at the root (top level) of the event.
|
173
|
+
|
174
|
+
For example, if you want data to be put under the `document` field:
|
175
|
+
[source,ruby]
|
176
|
+
input {
|
177
|
+
file {
|
178
|
+
codec => csv {
|
179
|
+
autodetect_column_names => true
|
180
|
+
target => "[document]"
|
181
|
+
}
|
182
|
+
}
|
183
|
+
}
|
184
|
+
|
143
185
|
|
data/lib/logstash/codecs/csv.rb
CHANGED
@@ -1,10 +1,25 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
require "logstash/codecs/base"
|
3
3
|
require "logstash/util/charset"
|
4
|
+
require "logstash/event"
|
5
|
+
|
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'
|
11
|
+
|
4
12
|
require "csv"
|
5
13
|
|
6
14
|
class LogStash::Codecs::CSV < LogStash::Codecs::Base
|
7
15
|
|
16
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
|
17
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
|
18
|
+
|
19
|
+
extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
|
20
|
+
|
21
|
+
include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
|
22
|
+
|
8
23
|
config_name "csv"
|
9
24
|
|
10
25
|
# When decoding:
|
@@ -58,6 +73,12 @@ class LogStash::Codecs::CSV < LogStash::Codecs::Base
|
|
58
73
|
# "CP1252".
|
59
74
|
config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
|
60
75
|
|
76
|
+
# Defines a target field for placing decoded fields.
|
77
|
+
# If this setting is omitted, data gets stored at the root (top level) of the event.
|
78
|
+
#
|
79
|
+
# NOTE: the target is only relevant while decoding data into a new event.
|
80
|
+
config :target, :validate => :field_reference
|
81
|
+
|
61
82
|
CONVERTERS = {
|
62
83
|
:integer => lambda do |value|
|
63
84
|
CSV::Converters[:integer].call(value)
|
@@ -87,10 +108,16 @@ class LogStash::Codecs::CSV < LogStash::Codecs::Base
|
|
87
108
|
CONVERTERS.default = lambda {|v| v}
|
88
109
|
CONVERTERS.freeze
|
89
110
|
|
90
|
-
def
|
111
|
+
def initialize(*params)
|
112
|
+
super
|
113
|
+
|
114
|
+
@original_field = ecs_select[disabled: nil, v1: '[event][original]']
|
115
|
+
|
91
116
|
@converter = LogStash::Util::Charset.new(@charset)
|
92
117
|
@converter.logger = @logger
|
118
|
+
end
|
93
119
|
|
120
|
+
def register
|
94
121
|
# validate conversion types to be the valid ones.
|
95
122
|
bad_types = @convert.values.select do |type|
|
96
123
|
!CONVERTERS.has_key?(type.to_sym)
|
@@ -98,12 +125,10 @@ class LogStash::Codecs::CSV < LogStash::Codecs::Base
|
|
98
125
|
raise(LogStash::ConfigurationError, "Invalid conversion types: #{bad_types.join(', ')}") unless bad_types.empty?
|
99
126
|
|
100
127
|
# @convert_symbols contains the symbolized types to avoid symbol conversion in the transform method
|
101
|
-
@convert_symbols = @convert.each_with_object({}){|(k, v), result| result[k] = v.to_sym}
|
128
|
+
@convert_symbols = @convert.each_with_object({}) { |(k, v), result| result[k] = v.to_sym }
|
102
129
|
|
103
130
|
# if the zero byte character is entered in the config, set the value
|
104
|
-
if
|
105
|
-
@quote_char = "\x00"
|
106
|
-
end
|
131
|
+
@quote_char = "\x00" if @quote_char == "\\x00"
|
107
132
|
|
108
133
|
@logger.debug? && @logger.debug("CSV parsing options", :col_sep => @separator, :quote_char => @quote_char)
|
109
134
|
end
|
@@ -120,19 +145,21 @@ class LogStash::Codecs::CSV < LogStash::Codecs::Base
|
|
120
145
|
end
|
121
146
|
|
122
147
|
decoded = {}
|
123
|
-
values.
|
124
|
-
unless (@skip_empty_columns && (
|
148
|
+
values.each_with_index do |value, i|
|
149
|
+
unless (@skip_empty_columns && (value.nil? || value.empty?))
|
125
150
|
unless ignore_field?(i)
|
126
151
|
field_name = @columns[i] || "column#{i + 1}"
|
127
|
-
decoded[field_name] = transform(field_name,
|
152
|
+
decoded[field_name] = transform(field_name, value)
|
128
153
|
end
|
129
154
|
end
|
130
155
|
end
|
131
156
|
|
132
|
-
|
157
|
+
event = targeted_event_factory.new_event(decoded)
|
158
|
+
event.set(@original_field, data.dup.freeze) if @original_field
|
159
|
+
yield event
|
133
160
|
rescue CSV::MalformedCSVError => e
|
134
|
-
@logger.error("CSV parse failure. Falling back to plain-text", :
|
135
|
-
yield
|
161
|
+
@logger.error("CSV parse failure. Falling back to plain-text", :exception => e.class, :message => e.message, :data => data)
|
162
|
+
yield event_factory.new_event("message" => data, "tags" => ["_csvparsefailure"])
|
136
163
|
end
|
137
164
|
end
|
138
165
|
|
data/logstash-codec-csv.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-codec-csv'
|
4
|
-
s.version = '1.
|
4
|
+
s.version = '1.1.0'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "The csv codec take CSV data, parses it and passes it away"
|
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"
|
@@ -21,6 +21,9 @@ Gem::Specification.new do |s|
|
|
21
21
|
|
22
22
|
# Gem dependencies
|
23
23
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
24
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
|
25
|
+
s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0'
|
26
|
+
s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
|
24
27
|
|
25
28
|
s.add_development_dependency 'logstash-devutils'
|
26
29
|
end
|
data/spec/codecs/csv_spec.rb
CHANGED
@@ -1,8 +1,10 @@
|
|
1
1
|
# encoding: utf-8
|
2
|
+
require "logstash/devutils/rspec/spec_helper"
|
2
3
|
require "logstash/codecs/csv"
|
3
|
-
require "logstash/event"
|
4
4
|
|
5
|
-
|
5
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
|
6
|
+
|
7
|
+
describe LogStash::Codecs::CSV, :ecs_compatibility_support do
|
6
8
|
|
7
9
|
subject(:codec) { LogStash::Codecs::CSV.new(config) }
|
8
10
|
let(:config) { Hash.new }
|
@@ -12,181 +14,217 @@ describe LogStash::Codecs::CSV do
|
|
12
14
|
end
|
13
15
|
|
14
16
|
describe "decode" do
|
17
|
+
|
15
18
|
let(:data) { "big,bird,sesame street" }
|
16
19
|
|
17
|
-
|
18
|
-
codec.decode(data) do |event|
|
19
|
-
expect(event.get("column1")).to eq("big")
|
20
|
-
expect(event.get("column2")).to eq("bird")
|
21
|
-
expect(event.get("column3")).to eq("sesame street")
|
22
|
-
end
|
23
|
-
end
|
20
|
+
ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
|
24
21
|
|
25
|
-
|
26
|
-
let(:doc) { "big,bird,sesame street" }
|
27
|
-
let(:config) do
|
28
|
-
{ "columns" => ["first", "last", "address" ] }
|
29
|
-
end
|
22
|
+
let(:config) { super().merge('ecs_compatibility' => ecs_select.active_mode.to_s) }
|
30
23
|
|
31
|
-
it "
|
24
|
+
it "return an event from CSV data" do
|
25
|
+
event_count = 0
|
32
26
|
codec.decode(data) do |event|
|
33
|
-
|
34
|
-
expect(event.get("
|
35
|
-
expect(event.get("
|
27
|
+
event_count += 1
|
28
|
+
expect(event.get("column1")).to eq("big")
|
29
|
+
expect(event.get("column2")).to eq("bird")
|
30
|
+
expect(event.get("column3")).to eq("sesame street")
|
36
31
|
end
|
32
|
+
expect( event_count ).to eql 1
|
37
33
|
end
|
38
34
|
|
39
|
-
|
40
|
-
|
41
|
-
let(:data) { "val1,,val3" }
|
42
|
-
|
35
|
+
describe "given column names" do
|
36
|
+
let(:doc) { "big,bird,sesame street" }
|
43
37
|
let(:config) do
|
44
|
-
{ "
|
45
|
-
"columns" => ["custom1", "custom2", "custom3"] }
|
38
|
+
{ "columns" => ["first", "last", "address" ] }
|
46
39
|
end
|
47
40
|
|
48
41
|
it "extract all the values" do
|
49
42
|
codec.decode(data) do |event|
|
50
|
-
expect(event.get("
|
51
|
-
expect(event.
|
52
|
-
expect(event.get("
|
43
|
+
expect(event.get("first")).to eq("big")
|
44
|
+
expect(event.get("last")).to eq("bird")
|
45
|
+
expect(event.get("address")).to eq("sesame street")
|
53
46
|
end
|
54
47
|
end
|
55
|
-
end
|
56
48
|
|
57
|
-
|
49
|
+
context "parse csv skipping empty columns" do
|
58
50
|
|
59
|
-
|
60
|
-
let(:config) do
|
61
|
-
{ "autogenerate_column_names" => false,
|
62
|
-
"columns" => ["custom1", "custom2"] }
|
63
|
-
end
|
51
|
+
let(:data) { "val1,,val3" }
|
64
52
|
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
expect(event.get("custom2")).to eq("val2")
|
69
|
-
expect(event.get("column3")).to be_falsey
|
53
|
+
let(:config) do
|
54
|
+
{ "skip_empty_columns" => true,
|
55
|
+
"columns" => ["custom1", "custom2", "custom3"] }
|
70
56
|
end
|
71
|
-
end
|
72
|
-
end
|
73
57
|
|
74
|
-
|
58
|
+
it "extract all the values" do
|
59
|
+
codec.decode(data) do |event|
|
60
|
+
expect(event.get("custom1")).to eq("val1")
|
61
|
+
expect(event.to_hash).not_to include("custom2")
|
62
|
+
expect(event.get("custom3")).to eq("val3")
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
75
66
|
|
76
|
-
|
77
|
-
let(:data) { "big,bird;sesame street" }
|
67
|
+
context "parse csv without autogeneration of names" do
|
78
68
|
|
79
|
-
|
80
|
-
|
81
|
-
|
69
|
+
let(:data) { "val1,val2,val3" }
|
70
|
+
let(:config) do
|
71
|
+
{ "autogenerate_column_names" => false,
|
72
|
+
"columns" => ["custom1", "custom2"] }
|
73
|
+
end
|
82
74
|
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
75
|
+
it "extract all the values" do
|
76
|
+
codec.decode(data) do |event|
|
77
|
+
expect(event.get("custom1")).to eq("val1")
|
78
|
+
expect(event.get("custom2")).to eq("val2")
|
79
|
+
expect(event.get("column3")).to be_falsey
|
80
|
+
end
|
81
|
+
end
|
87
82
|
end
|
88
|
-
end
|
89
|
-
end
|
90
83
|
|
91
|
-
describe "quote char" do
|
92
|
-
let(:data) { "big,bird,'sesame street'" }
|
93
|
-
|
94
|
-
let(:config) do
|
95
|
-
{ "quote_char" => "'"}
|
96
84
|
end
|
97
85
|
|
98
|
-
|
99
|
-
|
100
|
-
expect(event.get("column1")).to eq("big")
|
101
|
-
expect(event.get("column2")).to eq("bird")
|
102
|
-
expect(event.get("column3")).to eq("sesame street")
|
103
|
-
end
|
104
|
-
end
|
86
|
+
describe "custom separator" do
|
87
|
+
let(:data) { "big,bird;sesame street" }
|
105
88
|
|
106
|
-
|
107
|
-
|
108
|
-
|
89
|
+
let(:config) do
|
90
|
+
{ "separator" => ";" }
|
91
|
+
end
|
109
92
|
|
110
93
|
it "return an event from CSV data" do
|
111
94
|
codec.decode(data) do |event|
|
112
|
-
expect(event.get("column1")).to eq("big")
|
113
|
-
expect(event.get("column2")).to eq("
|
114
|
-
expect(event.get("column3")).to eq("sesame, street")
|
95
|
+
expect(event.get("column1")).to eq("big,bird")
|
96
|
+
expect(event.get("column2")).to eq("sesame street")
|
115
97
|
end
|
116
98
|
end
|
117
99
|
end
|
118
100
|
|
119
|
-
|
120
|
-
let(:data) {
|
101
|
+
describe "quote char" do
|
102
|
+
let(:data) { "big,bird,'sesame street'" }
|
103
|
+
|
121
104
|
let(:config) do
|
122
|
-
{ "quote_char" => "
|
105
|
+
{ "quote_char" => "'"}
|
123
106
|
end
|
124
107
|
|
125
108
|
it "return an event from CSV data" do
|
126
109
|
codec.decode(data) do |event|
|
127
110
|
expect(event.get("column1")).to eq("big")
|
128
111
|
expect(event.get("column2")).to eq("bird")
|
129
|
-
expect(event.get("column3")).to eq(
|
112
|
+
expect(event.get("column3")).to eq("sesame street")
|
130
113
|
end
|
131
114
|
end
|
132
|
-
end
|
133
|
-
end
|
134
115
|
|
135
|
-
|
116
|
+
context "using the default one" do
|
117
|
+
let(:data) { 'big,bird,"sesame, street"' }
|
118
|
+
let(:config) { Hash.new }
|
136
119
|
|
137
|
-
|
138
|
-
|
139
|
-
|
120
|
+
it "return an event from CSV data" do
|
121
|
+
codec.decode(data) do |event|
|
122
|
+
expect(event.get("column1")).to eq("big")
|
123
|
+
expect(event.get("column2")).to eq("bird")
|
124
|
+
expect(event.get("column3")).to eq("sesame, street")
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
140
128
|
|
141
|
-
|
142
|
-
|
143
|
-
|
129
|
+
context "using a null" do
|
130
|
+
let(:data) { 'big,bird,"sesame" street' }
|
131
|
+
let(:config) do
|
132
|
+
{ "quote_char" => "\x00" }
|
133
|
+
end
|
144
134
|
|
145
|
-
|
146
|
-
|
135
|
+
it "return an event from CSV data" do
|
136
|
+
codec.decode(data) do |event|
|
137
|
+
expect(event.get("column1")).to eq("big")
|
138
|
+
expect(event.get("column2")).to eq("bird")
|
139
|
+
expect(event.get("column3")).to eq('"sesame" street')
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
147
143
|
end
|
148
144
|
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
expect(event.get("animal")).to eq("bird")
|
154
|
-
expect(event.get("movie")).to eq("sesame street")
|
145
|
+
describe "having headers" do
|
146
|
+
|
147
|
+
let(:data) do
|
148
|
+
[ "size,animal,movie", "big,bird,sesame street"]
|
155
149
|
end
|
156
|
-
end
|
157
|
-
end
|
158
150
|
|
159
|
-
|
151
|
+
let(:new_data) do
|
152
|
+
[ "host,country,city", "example.com,germany,berlin"]
|
153
|
+
end
|
160
154
|
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
let(:data) { "1234,bird,false" }
|
155
|
+
let(:config) do
|
156
|
+
{ "autodetect_column_names" => true }
|
157
|
+
end
|
165
158
|
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
159
|
+
it "include header information when requested" do
|
160
|
+
codec.decode(data[0]) # Read the headers
|
161
|
+
codec.decode(data[1]) do |event|
|
162
|
+
expect(event.get("size")).to eq("big")
|
163
|
+
expect(event.get("animal")).to eq("bird")
|
164
|
+
expect(event.get("movie")).to eq("sesame street")
|
165
|
+
end
|
171
166
|
end
|
172
167
|
end
|
173
168
|
|
174
|
-
|
169
|
+
describe "using field conversion" do
|
175
170
|
|
176
171
|
let(:config) do
|
177
|
-
{ "convert" => { "
|
178
|
-
"columns" => ["custom1", "custom2", "custom3"] }
|
172
|
+
{ "convert" => { "column1" => "integer", "column3" => "boolean" } }
|
179
173
|
end
|
174
|
+
let(:data) { "1234,bird,false" }
|
180
175
|
|
181
176
|
it "get converted values to the expected type" do
|
182
177
|
codec.decode(data) do |event|
|
183
|
-
expect(event.get("
|
184
|
-
expect(event.get("
|
185
|
-
expect(event.get("
|
178
|
+
expect(event.get("column1")).to eq(1234)
|
179
|
+
expect(event.get("column2")).to eq("bird")
|
180
|
+
expect(event.get("column3")).to eq(false)
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
context "when using column names" do
|
185
|
+
|
186
|
+
let(:config) do
|
187
|
+
{ "convert" => { "custom1" => "integer", "custom3" => "boolean" },
|
188
|
+
"columns" => ["custom1", "custom2", "custom3"] }
|
189
|
+
end
|
190
|
+
|
191
|
+
it "get converted values to the expected type" do
|
192
|
+
codec.decode(data) do |event|
|
193
|
+
expect(event.get("custom1")).to eq(1234)
|
194
|
+
expect(event.get("custom2")).to eq("bird")
|
195
|
+
expect(event.get("custom3")).to eq(false)
|
196
|
+
end
|
197
|
+
end
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
context "with target" do
|
202
|
+
|
203
|
+
let(:config) { super().merge('target' => '[csv-root]') }
|
204
|
+
|
205
|
+
it "return an event from CSV data" do
|
206
|
+
event_count = 0
|
207
|
+
codec.decode(data) do |event|
|
208
|
+
event_count += 1
|
209
|
+
expect( event.include?("column1") ).to be false
|
210
|
+
expect( event.get("csv-root") ).to eql('column1' => 'big', 'column2' => 'bird', 'column3' => "sesame street")
|
211
|
+
end
|
212
|
+
expect( event_count ).to eql 1
|
213
|
+
end
|
214
|
+
|
215
|
+
it 'set event.original in ECS mode' do
|
216
|
+
codec.decode(data) do |event|
|
217
|
+
if ecs_select.active_mode == :disabled
|
218
|
+
expect( event.get("[event][original]") ).to be nil
|
219
|
+
else
|
220
|
+
expect( event.get("[event][original]") ).to eql data
|
221
|
+
end
|
186
222
|
end
|
187
223
|
end
|
224
|
+
|
188
225
|
end
|
189
226
|
end
|
227
|
+
|
190
228
|
end
|
191
229
|
|
192
230
|
describe "encode" do
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-codec-csv
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Elasticsearch
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-07-28 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,48 @@ 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
|
+
name: logstash-mixin-event_support
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '1.0'
|
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-validator_support
|
68
|
+
type: :runtime
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '1.0'
|
33
75
|
- !ruby/object:Gem::Dependency
|
34
76
|
requirement: !ruby/object:Gem::Requirement
|
35
77
|
requirements:
|
@@ -37,8 +79,8 @@ dependencies:
|
|
37
79
|
- !ruby/object:Gem::Version
|
38
80
|
version: '0'
|
39
81
|
name: logstash-devutils
|
40
|
-
prerelease: false
|
41
82
|
type: :development
|
83
|
+
prerelease: false
|
42
84
|
version_requirements: !ruby/object:Gem::Requirement
|
43
85
|
requirements:
|
44
86
|
- - ">="
|
@@ -82,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
82
124
|
- !ruby/object:Gem::Version
|
83
125
|
version: '0'
|
84
126
|
requirements: []
|
85
|
-
|
86
|
-
rubygems_version: 2.6.13
|
127
|
+
rubygems_version: 3.0.6
|
87
128
|
signing_key:
|
88
129
|
specification_version: 4
|
89
130
|
summary: The csv codec take CSV data, parses it and passes it away
|