logstash-output-csv 3.0.8 → 3.0.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/lib/logstash/outputs/csv.rb +2 -2
- data/logstash-output-csv.gemspec +1 -3
- data/spec/outputs/csv_spec.rb +121 -268
- metadata +3 -32
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0ff16b853ea563deea07a1e78f6ad9b6f677c77bf3857a9c79efc5aba8951b60
|
4
|
+
data.tar.gz: 6e2285954e7e79beb4c2d7f539355e6a03f019cfcf659c420d795c4db4f6a2ed
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 617febffa7ab5a19acaf626e3979e7a54e2dd9901b19e4e627b1df37643ce79c5f1fecc2b81937e7fd217422c8f37d160a8be2201ff7e6c266de01f26c6c645c
|
7
|
+
data.tar.gz: 38d6ec6b6bb82b01cf9656f5532e7c1784118c439c9ee5d385d1bead7393a10024d1489fb500b30b4d70290d0a4b4c65afa66fa3b8f23b494f742c92613ac610
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
## 3.0.10
|
2
|
+
- Extend `spreadsheet_safe` prefix guard to '-', '+', and '@' [#27](https://github.com/logstash-plugins/logstash-output-csv/pull/27)
|
3
|
+
|
4
|
+
## 3.0.9
|
5
|
+
- Fix: updates syntax to JRuby 9.4 [#25](https://github.com/logstash-plugins/logstash-output-csv/pull/25)
|
6
|
+
|
1
7
|
## 3.0.8
|
2
8
|
- Docs: Correct typos [#19](https://github.com/logstash-plugins/logstash-output-csv/pull/19)
|
3
9
|
- Docs: Fix formatting after code sample [#22](https://github.com/logstash-plugins/logstash-output-csv/pull/22)
|
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
|
-
[![Travis Build Status](https://travis-ci.
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-output-csv.svg)](https://travis-ci.com/logstash-plugins/logstash-output-csv)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
data/lib/logstash/outputs/csv.rb
CHANGED
@@ -56,7 +56,7 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
|
|
56
56
|
|
57
57
|
def event_to_csv(event)
|
58
58
|
csv_values = @fields.map {|name| get_value(name, event)}
|
59
|
-
csv_values.to_csv(
|
59
|
+
csv_values.to_csv(**@csv_options)
|
60
60
|
end
|
61
61
|
|
62
62
|
def get_value(name, event)
|
@@ -66,6 +66,6 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
|
|
66
66
|
|
67
67
|
private
|
68
68
|
def escape_csv(val)
|
69
|
-
(spreadsheet_safe && val.is_a?(String) && val.start_with?(
|
69
|
+
(spreadsheet_safe && val.is_a?(String) && val.start_with?(/[=+\-@]/)) ? "'#{val}" : val
|
70
70
|
end
|
71
71
|
end # class LogStash::Outputs::CSV
|
data/logstash-output-csv.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-output-csv'
|
4
|
-
s.version = '3.0.
|
4
|
+
s.version = '3.0.10'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Writes events to disk in a delimited format"
|
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"
|
@@ -22,8 +22,6 @@ Gem::Specification.new do |s|
|
|
22
22
|
# Gem dependencies
|
23
23
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
24
24
|
|
25
|
-
s.add_runtime_dependency 'logstash-input-generator'
|
26
25
|
s.add_runtime_dependency 'logstash-output-file'
|
27
|
-
s.add_runtime_dependency 'logstash-filter-json'
|
28
26
|
s.add_development_dependency 'logstash-devutils'
|
29
27
|
end
|
data/spec/outputs/csv_spec.rb
CHANGED
@@ -5,314 +5,167 @@ require "logstash/outputs/csv"
|
|
5
5
|
|
6
6
|
describe LogStash::Outputs::CSV do
|
7
7
|
|
8
|
+
subject { described_class.new(options) }
|
8
9
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
input {
|
13
|
-
generator {
|
14
|
-
add_field => ["foo","bar"]
|
15
|
-
count => 1
|
16
|
-
}
|
17
|
-
}
|
18
|
-
output {
|
19
|
-
csv {
|
20
|
-
path => "#{tmpfile.path}"
|
21
|
-
fields => "foo"
|
22
|
-
}
|
23
|
-
}
|
24
|
-
CONFIG
|
10
|
+
let(:tmpfile) { Tempfile.new('logstash-spec-output-csv').path }
|
11
|
+
let(:output) { File.readlines(tmpfile) }
|
12
|
+
let(:csv_output) { CSV.read(tmpfile) }
|
25
13
|
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
insist {lines[0]} == "bar\n"
|
30
|
-
end
|
14
|
+
before(:each) do
|
15
|
+
subject.register
|
16
|
+
subject.multi_receive(events)
|
31
17
|
end
|
32
18
|
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
count => 2
|
40
|
-
}
|
41
|
-
}
|
42
|
-
output {
|
43
|
-
csv {
|
44
|
-
path => "#{tmpfile.path}"
|
45
|
-
fields => ["foo", "baz"]
|
46
|
-
}
|
47
|
-
}
|
48
|
-
CONFIG
|
49
|
-
|
50
|
-
agent do
|
51
|
-
lines = File.readlines(tmpfile.path)
|
52
|
-
insist {lines.count} == 2
|
53
|
-
insist {lines[0]} == "bar,quux\n"
|
54
|
-
insist {lines[1]} == "bar,quux\n"
|
19
|
+
context "when configured with a single field" do
|
20
|
+
let(:events) { [ LogStash::Event.new("foo" => "bar") ] }
|
21
|
+
let(:options) { { "path" => tmpfile, "fields" => "foo" } }
|
22
|
+
it "writes a single field to a csv file" do
|
23
|
+
expect(output.count).to eq(1)
|
24
|
+
expect(output.first).to eq("bar\n")
|
55
25
|
end
|
56
26
|
end
|
57
27
|
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
fields => ["foo", "not_there", "baz"]
|
71
|
-
}
|
72
|
-
}
|
73
|
-
CONFIG
|
74
|
-
|
75
|
-
agent do
|
76
|
-
lines = File.readlines(tmpfile.path)
|
77
|
-
insist {lines.count} == 1
|
78
|
-
insist {lines[0]} == "bar,,quux\n"
|
28
|
+
context "when receiving multiple events with multiple fields" do
|
29
|
+
let(:events) do
|
30
|
+
[ LogStash::Event.new("foo" => "bar", "baz" => "quux"),
|
31
|
+
LogStash::Event.new("foo" => "bar", "baz" => "quux") ]
|
32
|
+
end
|
33
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
|
34
|
+
it "writes a line per event " do
|
35
|
+
expect(output.count).to eq(2)
|
36
|
+
end
|
37
|
+
it "writes configured fields for each line" do
|
38
|
+
expect(output[0]).to eq("bar,quux\n")
|
39
|
+
expect(output[1]).to eq("bar,quux\n")
|
79
40
|
end
|
80
41
|
end
|
81
42
|
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
add_field => ["foo","one,two", "baz", "quux"]
|
88
|
-
count => 1
|
89
|
-
}
|
90
|
-
}
|
91
|
-
output {
|
92
|
-
csv {
|
93
|
-
path => "#{tmpfile.path}"
|
94
|
-
fields => ["foo", "baz"]
|
95
|
-
}
|
96
|
-
}
|
97
|
-
CONFIG
|
43
|
+
context "with missing event fields" do
|
44
|
+
let(:events) do
|
45
|
+
[ LogStash::Event.new("foo" => "bar", "baz" => "quux") ]
|
46
|
+
end
|
47
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "not_there", "baz"] } }
|
98
48
|
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
insist {lines[0]} == "\"one,two\",quux\n"
|
49
|
+
it "skips on the resulting line" do
|
50
|
+
expect(output.size).to eq(1)
|
51
|
+
expect(output[0]).to eq("bar,,quux\n")
|
103
52
|
end
|
104
53
|
end
|
105
54
|
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
}
|
115
|
-
output {
|
116
|
-
csv {
|
117
|
-
path => "#{tmpfile.path}"
|
118
|
-
fields => ["foo", "baz"]
|
119
|
-
}
|
120
|
-
}
|
121
|
-
CONFIG
|
122
|
-
|
123
|
-
agent do
|
124
|
-
lines = CSV.read(tmpfile.path)
|
125
|
-
insist {lines.count} == 1
|
126
|
-
insist {lines[0][0]} == "one\ntwo"
|
55
|
+
context "when field values have commas" do
|
56
|
+
let(:events) do
|
57
|
+
[ LogStash::Event.new("foo" => "one,two", "baz" => "quux") ]
|
58
|
+
end
|
59
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
|
60
|
+
it "correctly escapes them" do
|
61
|
+
expect(output.size).to eq(1)
|
62
|
+
expect(output[0]).to eq("\"one,two\",quux\n")
|
127
63
|
end
|
128
64
|
end
|
129
65
|
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
}
|
139
|
-
filter {
|
140
|
-
json { source => "message"}
|
141
|
-
}
|
142
|
-
output {
|
143
|
-
csv {
|
144
|
-
path => "#{tmpfile.path}"
|
145
|
-
fields => ["foo", "baz"]
|
146
|
-
}
|
147
|
-
}
|
148
|
-
CONFIG
|
149
|
-
|
150
|
-
agent do
|
151
|
-
lines = CSV.read(tmpfile.path)
|
152
|
-
insist {lines.count} == 1
|
153
|
-
insist {lines[0][0]} == '{"one":"two"}'
|
66
|
+
context "when fields contain special characters" do
|
67
|
+
let(:events) do
|
68
|
+
[ LogStash::Event.new("foo" => 'one\ntwo', "baz" => "quux") ]
|
69
|
+
end
|
70
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
|
71
|
+
it "correctly escapes them" do
|
72
|
+
expect(csv_output.size).to eq(1)
|
73
|
+
expect(csv_output[0]).to eq(['one\ntwo', 'quux'])
|
154
74
|
end
|
155
75
|
end
|
156
76
|
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
message => '{"foo":{"one":"two"},"baz": "quux"}'
|
163
|
-
count => 1
|
164
|
-
}
|
165
|
-
}
|
166
|
-
filter {
|
167
|
-
json { source => "message"}
|
168
|
-
}
|
169
|
-
output {
|
170
|
-
csv {
|
171
|
-
path => "#{tmpfile.path}"
|
172
|
-
fields => ["[foo][one]", "baz"]
|
173
|
-
}
|
174
|
-
}
|
175
|
-
CONFIG
|
77
|
+
context "fields that contain objects" do
|
78
|
+
let(:events) do
|
79
|
+
[ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
|
80
|
+
end
|
81
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
|
176
82
|
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
insist {lines[0][0]} == "two"
|
181
|
-
insist {lines[0][1]} == "quux"
|
83
|
+
it "are written as json" do
|
84
|
+
expect(csv_output.size).to eq(1)
|
85
|
+
expect(csv_output[0][0]).to eq('{"one":"two"}')
|
182
86
|
end
|
183
87
|
end
|
88
|
+
context "with address nested field" do
|
89
|
+
let(:events) do
|
90
|
+
[ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
|
91
|
+
end
|
92
|
+
let(:options) { { "path" => tmpfile, "fields" => ["[foo][one]", "baz"] } }
|
184
93
|
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
generator {
|
190
|
-
message => '{"foo":{"one":"two"},"baz": "quux"}'
|
191
|
-
count => 1
|
192
|
-
}
|
193
|
-
}
|
194
|
-
filter {
|
195
|
-
json { source => "message"}
|
196
|
-
}
|
197
|
-
output {
|
198
|
-
csv {
|
199
|
-
path => "#{tmpfile.path}"
|
200
|
-
fields => ["[foo][missing]", "baz"]
|
201
|
-
}
|
202
|
-
}
|
203
|
-
CONFIG
|
204
|
-
|
205
|
-
agent do
|
206
|
-
lines = File.readlines(tmpfile.path)
|
207
|
-
insist {lines.count} == 1
|
208
|
-
insist {lines[0]} == ",quux\n"
|
94
|
+
it "are referenced using field references" do
|
95
|
+
expect(csv_output.size).to eq(1)
|
96
|
+
expect(csv_output[0][0]).to eq('two')
|
97
|
+
expect(csv_output[0][1]).to eq('quux')
|
209
98
|
end
|
210
99
|
end
|
211
100
|
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
message => '{"foo":"one","bar": "two"}'
|
218
|
-
count => 1
|
219
|
-
}
|
220
|
-
}
|
221
|
-
filter {
|
222
|
-
json { source => "message"}
|
223
|
-
}
|
224
|
-
output {
|
225
|
-
csv {
|
226
|
-
path => "#{tmpfile.path}"
|
227
|
-
fields => ["foo", "bar"]
|
228
|
-
csv_options => {"col_sep" => "|"}
|
229
|
-
}
|
230
|
-
}
|
231
|
-
CONFIG
|
101
|
+
context "missing nested field" do
|
102
|
+
let(:events) do
|
103
|
+
[ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
|
104
|
+
end
|
105
|
+
let(:options) { { "path" => tmpfile, "fields" => ["[foo][missing]", "baz"] } }
|
232
106
|
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
insist {lines[0]} == "one|two\n"
|
107
|
+
it "are blank" do
|
108
|
+
expect(output.size).to eq(1)
|
109
|
+
expect(output[0]).to eq(",quux\n")
|
237
110
|
end
|
238
111
|
end
|
239
|
-
describe "can choose line seperator" do
|
240
|
-
tmpfile = Tempfile.new('logstash-spec-output-csv')
|
241
|
-
config <<-CONFIG
|
242
|
-
input {
|
243
|
-
generator {
|
244
|
-
message => '{"foo":"one","bar": "two"}'
|
245
|
-
count => 2
|
246
|
-
}
|
247
|
-
}
|
248
|
-
filter {
|
249
|
-
json { source => "message"}
|
250
|
-
}
|
251
|
-
output {
|
252
|
-
csv {
|
253
|
-
path => "#{tmpfile.path}"
|
254
|
-
fields => ["foo", "bar"]
|
255
|
-
csv_options => {"col_sep" => "|" "row_sep" => "\t"}
|
256
|
-
}
|
257
|
-
}
|
258
|
-
CONFIG
|
259
112
|
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
113
|
+
describe "field separator" do
|
114
|
+
let(:events) do
|
115
|
+
[ LogStash::Event.new("foo" => "one", "baz" => "two") ]
|
116
|
+
end
|
117
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"], "csv_options" => {"col_sep" => "|" } } }
|
118
|
+
|
119
|
+
it "uses separator in output" do
|
120
|
+
expect(output.size).to eq(1)
|
121
|
+
expect(output[0]).to eq("one|two\n")
|
264
122
|
end
|
265
123
|
end
|
266
124
|
|
267
|
-
describe "
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
count => 1
|
274
|
-
}
|
275
|
-
}
|
276
|
-
output {
|
277
|
-
csv {
|
278
|
-
path => "#{tmpfile.path}"
|
279
|
-
fields => ["foo", "baz"]
|
280
|
-
}
|
281
|
-
}
|
282
|
-
CONFIG
|
125
|
+
describe "line seperator" do
|
126
|
+
let(:events) do
|
127
|
+
[ LogStash::Event.new("foo" => "one", "baz" => "two"),
|
128
|
+
LogStash::Event.new("foo" => "one", "baz" => "two") ]
|
129
|
+
end
|
130
|
+
let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"], "csv_options" => {"col_sep" => "|", "row_sep" => "\t" } } }
|
283
131
|
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
insist {lines[0][0]} == "1+1"
|
288
|
-
insist {lines[0][1]} == "'=1+1"
|
132
|
+
it "uses separator in output" do
|
133
|
+
expect(output.size).to eq(1)
|
134
|
+
expect(output[0]).to eq("one|two\tone|two\t")
|
289
135
|
end
|
290
136
|
end
|
291
137
|
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
138
|
+
context "with rogue values" do
|
139
|
+
let(:event_data) do
|
140
|
+
{
|
141
|
+
"f1" => "1+1",
|
142
|
+
"f2" => "=1+1",
|
143
|
+
"f3" => "+1+1",
|
144
|
+
"f4" => "-1+1",
|
145
|
+
"f5" => "@1+1"
|
300
146
|
}
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
fields => ["foo", "baz"]
|
306
|
-
}
|
307
|
-
}
|
308
|
-
CONFIG
|
147
|
+
end
|
148
|
+
let(:events) do
|
149
|
+
[ LogStash::Event.new(event_data) ]
|
150
|
+
end
|
309
151
|
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
152
|
+
let(:options) { { "path" => tmpfile, "fields" => ["f1", "f2", "f3", "f4", "f5"] } }
|
153
|
+
it "escapes them correctly" do
|
154
|
+
expect(csv_output.size).to eq(1)
|
155
|
+
expect(csv_output[0][0]).to eq("1+1")
|
156
|
+
expect(csv_output[0][1]).to eq("'=1+1")
|
157
|
+
expect(csv_output[0][2]).to eq("'+1+1")
|
158
|
+
expect(csv_output[0][3]).to eq("'-1+1")
|
159
|
+
expect(csv_output[0][4]).to eq("'@1+1")
|
315
160
|
end
|
316
|
-
end
|
317
161
|
|
162
|
+
context "when escaping is turned off" do
|
163
|
+
let(:options) { super().merge("spreadsheet_safe" => false) }
|
164
|
+
it "doesn't escapes values" do
|
165
|
+
expect(csv_output.size).to eq(1)
|
166
|
+
expect(csv_output[0][0]).to eq("1+1")
|
167
|
+
expect(csv_output[0][1]).to eq("=1+1")
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|
318
171
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-output-csv
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.10
|
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: 2023-12-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -30,20 +30,6 @@ 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: '0'
|
39
|
-
name: logstash-input-generator
|
40
|
-
prerelease: false
|
41
|
-
type: :runtime
|
42
|
-
version_requirements: !ruby/object:Gem::Requirement
|
43
|
-
requirements:
|
44
|
-
- - ">="
|
45
|
-
- !ruby/object:Gem::Version
|
46
|
-
version: '0'
|
47
33
|
- !ruby/object:Gem::Dependency
|
48
34
|
requirement: !ruby/object:Gem::Requirement
|
49
35
|
requirements:
|
@@ -58,20 +44,6 @@ dependencies:
|
|
58
44
|
- - ">="
|
59
45
|
- !ruby/object:Gem::Version
|
60
46
|
version: '0'
|
61
|
-
- !ruby/object:Gem::Dependency
|
62
|
-
requirement: !ruby/object:Gem::Requirement
|
63
|
-
requirements:
|
64
|
-
- - ">="
|
65
|
-
- !ruby/object:Gem::Version
|
66
|
-
version: '0'
|
67
|
-
name: logstash-filter-json
|
68
|
-
prerelease: false
|
69
|
-
type: :runtime
|
70
|
-
version_requirements: !ruby/object:Gem::Requirement
|
71
|
-
requirements:
|
72
|
-
- - ">="
|
73
|
-
- !ruby/object:Gem::Version
|
74
|
-
version: '0'
|
75
47
|
- !ruby/object:Gem::Dependency
|
76
48
|
requirement: !ruby/object:Gem::Requirement
|
77
49
|
requirements:
|
@@ -125,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
125
97
|
- !ruby/object:Gem::Version
|
126
98
|
version: '0'
|
127
99
|
requirements: []
|
128
|
-
|
129
|
-
rubygems_version: 2.6.13
|
100
|
+
rubygems_version: 3.2.33
|
130
101
|
signing_key:
|
131
102
|
specification_version: 4
|
132
103
|
summary: Writes events to disk in a delimited format
|