logstash-output-s3-zst 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +185 -0
- data/CONTRIBUTORS +21 -0
- data/DEVELOPER.md +15 -0
- data/Gemfile +15 -0
- data/LICENSE +202 -0
- data/NOTICE.TXT +5 -0
- data/README.md +98 -0
- data/VERSION +1 -0
- data/docs/index.asciidoc +451 -0
- data/lib/logstash/outputs/s3/file_repository.rb +177 -0
- data/lib/logstash/outputs/s3/patch.rb +22 -0
- data/lib/logstash/outputs/s3/path_validator.rb +18 -0
- data/lib/logstash/outputs/s3/size_and_time_rotation_policy.rb +24 -0
- data/lib/logstash/outputs/s3/size_rotation_policy.rb +26 -0
- data/lib/logstash/outputs/s3/temporary_file.rb +114 -0
- data/lib/logstash/outputs/s3/temporary_file_factory.rb +126 -0
- data/lib/logstash/outputs/s3/time_rotation_policy.rb +26 -0
- data/lib/logstash/outputs/s3/uploader.rb +82 -0
- data/lib/logstash/outputs/s3/writable_directory_validator.rb +17 -0
- data/lib/logstash/outputs/s3/write_bucket_permission_validator.rb +60 -0
- data/lib/logstash/outputs/s3-zst.rb +445 -0
- data/lib/tasks/build.rake +15 -0
- data/logstash-output-s3-zst.gemspec +30 -0
- data/spec/outputs/s3_spec.rb +11 -0
- data/spec/spec_helper.rb +6 -0
- metadata +200 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 01a443a989cd1305625122ea9f7a4bddfdc3fbead702d72a89eaa1e80e22486f
|
4
|
+
data.tar.gz: e0cb86ba0dfbd92c9d30810848696e9096ab6bf0cdd2d82dfc72b083e048b2b1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f527f69322e718541133279d02c329779c0cda46b8011c68772b2fc3362b46fcd9c94d0644ef59c8b649a83a6818950226945867f91264c58098cec28d2b637d
|
7
|
+
data.tar.gz: 4379a7ad68fcec3d09ee9dd6f23c2a0e865595c7fabaa2beb86e5926eb2569a6ddeea3f6334835af31ddd50e650e10d484755100ec88582d5d63452f51e7efc2
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,185 @@
|
|
1
|
+
## 4.4.1
|
2
|
+
- Fixes several closely-related race conditions that could cause plugin crashes or data-loss [#252](https://github.com/logstash-plugins/logstash-output-s3/pull/252)
|
3
|
+
- race condition in initializing a prefix could cause one or more local temp files to be abandoned and only recovered after next pipeline start
|
4
|
+
- race condition in stale watcher could cause the plugin to crash when working with a stale (empty) file that had been deleted
|
5
|
+
- race condition in stale watcher could cause a non-empty file to be deleted if bytes were written to it after it was detected as stale
|
6
|
+
|
7
|
+
## 4.4.0
|
8
|
+
- Logstash recovers corrupted gzip and uploads to S3 [#249](https://github.com/logstash-plugins/logstash-output-s3/pull/249)
|
9
|
+
|
10
|
+
## 4.3.7
|
11
|
+
- Refactor: avoid usage of CHM (JRuby 9.3.4 work-around) [#248](https://github.com/logstash-plugins/logstash-output-s3/pull/248)
|
12
|
+
|
13
|
+
## 4.3.6
|
14
|
+
- Docs: more documentation on restore + temp dir [#236](https://github.com/logstash-plugins/logstash-output-s3/pull/236)
|
15
|
+
* minor logging improvements - use the same path: naming convention
|
16
|
+
|
17
|
+
## 4.3.5
|
18
|
+
- Feat: cast true/false values for additional_settings [#241](https://github.com/logstash-plugins/logstash-output-s3/pull/241)
|
19
|
+
|
20
|
+
## 4.3.4
|
21
|
+
- [DOC] Added note about performance implications of interpolated strings in prefixes [#233](https://github.com/logstash-plugins/logstash-output-s3/pull/233)
|
22
|
+
|
23
|
+
## 4.3.3
|
24
|
+
- [DOC] Updated links to use shared attributes [#230](https://github.com/logstash-plugins/logstash-output-s3/pull/230)
|
25
|
+
|
26
|
+
## 4.3.2
|
27
|
+
- [DOC] Added note that only AWS S3 is supported. No other S3 compatible storage solutions are supported. [#223](https://github.com/logstash-plugins/logstash-output-s3/pull/223)
|
28
|
+
|
29
|
+
## 4.3.1
|
30
|
+
- [DOC] Updated setting descriptions for clarity [#219](https://github.com/logstash-plugins/logstash-output-s3/pull/219) and [#220](https://github.com/logstash-plugins/logstash-output-s3/pull/220)
|
31
|
+
|
32
|
+
## 4.3.0
|
33
|
+
- Feat: Added retry_count and retry_delay config [#218](https://github.com/logstash-plugins/logstash-output-s3/pull/218)
|
34
|
+
|
35
|
+
## 4.2.0
|
36
|
+
- Added ability to specify [ONEZONE_IA](https://aws.amazon.com/s3/storage-classes/#__) as storage_class
|
37
|
+
|
38
|
+
## 4.1.10
|
39
|
+
- Added clarification for endpoint in documentation [#198](https://github.com/logstash-plugins/logstash-output-s3/pull/198)
|
40
|
+
|
41
|
+
## 4.1.9
|
42
|
+
- Added configuration information for multiple s3 outputs to documentation [#196](https://github.com/logstash-plugins/logstash-output-s3/pull/196)
|
43
|
+
- Fixed formatting problems and typographical errors [#194](https://github.com/logstash-plugins/logstash-output-s3/pull/194), [#201](https://github.com/logstash-plugins/logstash-output-s3/pull/201), and [#204](https://github.com/logstash-plugins/logstash-output-s3/pull/204)
|
44
|
+
|
45
|
+
## 4.1.8
|
46
|
+
- Add support for setting mutipart upload threshold [#202](https://github.com/logstash-plugins/logstash-output-s3/pull/202)
|
47
|
+
|
48
|
+
## 4.1.7
|
49
|
+
- Fixed issue where on restart, 0 byte files could erroneously be uploaded to s3 [#195](https://github.com/logstash-plugins/logstash-output-s3/issues/195)
|
50
|
+
|
51
|
+
## 4.1.6
|
52
|
+
- Fixed leak of file handles that prevented temporary files from being cleaned up before pipeline restart [#190](https://github.com/logstash-plugins/logstash-output-s3/issues/190)
|
53
|
+
|
54
|
+
## 4.1.5
|
55
|
+
- Fixed bucket validation failures when bucket policy requires encryption [#191](https://github.com/logstash-plugins/logstash-output-s3/pull/191)
|
56
|
+
|
57
|
+
## 4.1.4
|
58
|
+
- [#185](https://github.com/logstash-plugins/logstash-output-s3/pull/184) Internal: Revert rake pinning to fix upstream builds
|
59
|
+
|
60
|
+
## 4.1.3
|
61
|
+
- [#181](https://github.com/logstash-plugins/logstash-output-s3/pull/181) Docs: Fix incorrect characterization of parameters as `required` in example configuration.
|
62
|
+
- [#184](https://github.com/logstash-plugins/logstash-output-s3/pull/184) Internal: Pin rake version for jruby-1.7 compatibility
|
63
|
+
|
64
|
+
## 4.1.2
|
65
|
+
- Symbolize hash keys for additional_settings hash #179
|
66
|
+
|
67
|
+
## 4.1.1
|
68
|
+
- Docs: Set the default_codec doc attribute.
|
69
|
+
|
70
|
+
## 4.1.0
|
71
|
+
- Add documentation for endpoint, role_arn and role_session_name #174
|
72
|
+
- Add option for additional settings #173
|
73
|
+
- Add more S3 bucket ACLs #158
|
74
|
+
- Handle file not found exception on S3 upload #144
|
75
|
+
- Document prefix interpolation #154
|
76
|
+
|
77
|
+
## 4.0.13
|
78
|
+
- Update gemspec summary
|
79
|
+
|
80
|
+
## 4.0.12
|
81
|
+
- Fix bug where output would fail if the s3 bucket had encryption enabled (#146, #155)
|
82
|
+
|
83
|
+
## 4.0.11
|
84
|
+
- Fixed a randomly occurring error that logged as a missing `__jcreate_meta` method
|
85
|
+
|
86
|
+
## 4.0.10
|
87
|
+
- Fix some documentation issues
|
88
|
+
|
89
|
+
## 4.0.9
|
90
|
+
- Correct issue that allows to run on Ruby 9k. #150
|
91
|
+
|
92
|
+
## 4.0.8
|
93
|
+
- Documentation changes
|
94
|
+
|
95
|
+
## 4.0.7
|
96
|
+
- Fix: `#restore_from_crash` should use the same upload options as the normal uploader. #140
|
97
|
+
- Fix: Wrongly named `canned_acl` options, renamed to "public-read", "public-read-write", "authenticated-read", from the documentation http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
|
98
|
+
|
99
|
+
## 4.0.6
|
100
|
+
- Fix: Use the right `signature_version` for the SDK v2 #129
|
101
|
+
- Fix an issue to prevent the output to upload empty file to S3 #128
|
102
|
+
- Docs: Update the doc to show the new format of the remote file #126
|
103
|
+
|
104
|
+
## 4.0.5
|
105
|
+
- Delete the file on disk after they are succesfully uploaded to S3 #122 #120
|
106
|
+
- Added logging when an exception occur in the Uploader's `on_complete` callback
|
107
|
+
|
108
|
+
## 4.0.4
|
109
|
+
- Add support for `storage_class` configuration
|
110
|
+
- Fix compatibility with Logstash 2.4
|
111
|
+
- Add support for `aws:kms` server side encryption #104
|
112
|
+
|
113
|
+
## 4.0.3
|
114
|
+
- When configuring the `canned_acl` options of the plugins the role was not applied correctly to the created object: #7
|
115
|
+
|
116
|
+
## 4.0.2
|
117
|
+
- Fixed AWS authentication when using instance profile credentials.
|
118
|
+
|
119
|
+
## 4.0.1
|
120
|
+
- Improved Error logging for S3 validation. Now specific S3 perms errors are logged
|
121
|
+
|
122
|
+
## 4.0.0
|
123
|
+
- This version is a complete rewrite over version 3.0.0 See #103
|
124
|
+
- This Plugin now uses the V2 version of the SDK, this make sure we receive the latest updates and changes.
|
125
|
+
- We now uses S3's `upload_file` instead of reading chunks, this method is more efficient and will uses the multipart with threads if the files is too big.
|
126
|
+
- You can now use the `fieldref` syntax in the prefix to dynamically changes the target with the events it receives.
|
127
|
+
- The Upload queue is now a bounded list, this options is necessary to allow back pressure to be communicated back to the pipeline but its configurable by the user.
|
128
|
+
- If the queue is full the plugin will start the upload in the current thread.
|
129
|
+
- The plugin now threadsafe and support the concurrency model `shared`
|
130
|
+
- The rotation strategy can be selected, the recommended is `size_and_time` that will check for both the configured limits (`size` and `time` are also available)
|
131
|
+
- The `restore` option will now use a separate threadpool with an unbounded queue
|
132
|
+
- The `restore` option will not block the launch of logstash and will uses less resources than the real time path
|
133
|
+
- The plugin now uses `multi_receive_encode`, this will optimize the writes to the files
|
134
|
+
- rotate operation are now batched to reduce the number of IO calls.
|
135
|
+
- Empty file will not be uploaded by any rotation rotation strategy
|
136
|
+
- We now use Concurrent-Ruby for the implementation of the java executor
|
137
|
+
- If you have finer grain permission on prefixes or want faster boot, you can disable the credentials check with `validate_credentials_on_root_bucket`
|
138
|
+
- The credentials check will no longer fails if we can't delete the file
|
139
|
+
- We now have a full suite of integration test for all the defined rotation
|
140
|
+
|
141
|
+
Fixes: #4 #81 #44 #59 #50
|
142
|
+
|
143
|
+
## 3.2.0
|
144
|
+
- Move to the new concurrency model `:single`
|
145
|
+
- use correct license identifier #99
|
146
|
+
- add support for `bucket_owner_full_control` in the canned ACL #87
|
147
|
+
- delete the test file but ignore any errors, because we actually only need to be able to write to S3. #97
|
148
|
+
|
149
|
+
## 3.1.2
|
150
|
+
- Fix improper shutdown of output worker threads
|
151
|
+
- improve exception handling
|
152
|
+
|
153
|
+
## 3.0.1
|
154
|
+
- Republish all the gems under jruby.
|
155
|
+
|
156
|
+
## 3.0.0
|
157
|
+
- Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
|
158
|
+
|
159
|
+
## 2.0.7
|
160
|
+
- Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
|
161
|
+
|
162
|
+
## 2.0.6
|
163
|
+
- New dependency requirements for logstash-core for the 5.0 release
|
164
|
+
|
165
|
+
## 2.0.5
|
166
|
+
- Support signature_version option for v4 S3 keys
|
167
|
+
|
168
|
+
## 2.0.4
|
169
|
+
- Remove the `Time.now` stub in the spec, it was conflicting with other test when running inside the default plugins test #63
|
170
|
+
- Make the spec run faster by adjusting the values of time rotation test.
|
171
|
+
|
172
|
+
## 2.0.3
|
173
|
+
- Update deps for logstash 2.0
|
174
|
+
|
175
|
+
## 2.0.2
|
176
|
+
- Fixes an issue when tags were defined #39
|
177
|
+
|
178
|
+
## 2.0.0
|
179
|
+
- Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
|
180
|
+
instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
|
181
|
+
- Dependency on logstash-core update to 2.0
|
182
|
+
|
183
|
+
## 1.0.1
|
184
|
+
- Fix a synchronization issue when doing file rotation and checking the size of the current file
|
185
|
+
- Fix an issue with synchronization when shutting down the plugin and closing the current temp file
|
data/CONTRIBUTORS
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The following is a list of people who have contributed ideas, code, bug
|
2
|
+
reports, or in general have helped logstash along its way.
|
3
|
+
|
4
|
+
Contributors:
|
5
|
+
* Chad Bean (chadbean)
|
6
|
+
* Colin Surprenant (colinsurprenant)
|
7
|
+
* Helmut Duregger (hduregger)
|
8
|
+
* Jordan Sissel (jordansissel)
|
9
|
+
* Joshua Spence (joshuaspence)
|
10
|
+
* Kurt Hurtado (kurtado)
|
11
|
+
* Mattia Peterle (MattiaBeast)
|
12
|
+
* Nick Ethier (nickethier)
|
13
|
+
* Pier-Hugues Pellerin (ph)
|
14
|
+
* Richard Pijnenburg (electrical)
|
15
|
+
* Jake Landis (jakelandis)
|
16
|
+
* Armin Braun (original-brownbear)
|
17
|
+
|
18
|
+
Note: If you've sent us patches, bug reports, or otherwise contributed to
|
19
|
+
Logstash, and you aren't on the list above and want to be, please let us know
|
20
|
+
and we'll make sure you're here. Contributions from folks like you are what make
|
21
|
+
open source awesome.
|
data/DEVELOPER.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
[Missing the other part of the readme]
|
2
|
+
|
3
|
+
## Running the tests
|
4
|
+
|
5
|
+
```
|
6
|
+
bundle install
|
7
|
+
bundle exec rspec
|
8
|
+
```
|
9
|
+
|
10
|
+
If you want to run the integration test against a real bucket you need to pass
|
11
|
+
your aws credentials to the test runner or declare it in your environment.
|
12
|
+
|
13
|
+
```
|
14
|
+
AWS_REGION=us-east-1 AWS_ACCESS_KEY_ID=123 AWS_SECRET_ACCESS_KEY=secret AWS_LOGSTASH_TEST_BUCKET=mytest bundle exec rspec spec/integration/s3_spec.rb --tag integration
|
15
|
+
```
|
data/Gemfile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
source 'https://rubygems.org'
|
2
|
+
|
3
|
+
gemspec
|
4
|
+
|
5
|
+
logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
|
6
|
+
use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
|
7
|
+
|
8
|
+
if Dir.exist?(logstash_path) && use_logstash_source
|
9
|
+
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
|
+
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
|
+
end
|
12
|
+
|
13
|
+
if RUBY_VERSION == "1.9.3"
|
14
|
+
gem 'rake', '12.2.1'
|
15
|
+
end
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright 2020 Elastic and contributors
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE.TXT
ADDED
data/README.md
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
# Logstash Plugin
|
2
|
+
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-output-s3.svg)](https://travis-ci.com/logstash-plugins/logstash-output-s3)
|
4
|
+
|
5
|
+
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
|
+
|
7
|
+
It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
|
8
|
+
|
9
|
+
## Documentation
|
10
|
+
|
11
|
+
Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
|
12
|
+
|
13
|
+
- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
|
14
|
+
- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
|
15
|
+
|
16
|
+
## Need Help?
|
17
|
+
|
18
|
+
Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
|
19
|
+
|
20
|
+
## Developing
|
21
|
+
|
22
|
+
### 1. Plugin Development and Testing
|
23
|
+
|
24
|
+
#### Code
|
25
|
+
- To get started, you'll need JRuby with the Bundler gem installed.
|
26
|
+
|
27
|
+
- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
|
28
|
+
|
29
|
+
- Install dependencies
|
30
|
+
```sh
|
31
|
+
bundle install
|
32
|
+
```
|
33
|
+
|
34
|
+
#### Test
|
35
|
+
|
36
|
+
- Update your dependencies
|
37
|
+
|
38
|
+
```sh
|
39
|
+
bundle install
|
40
|
+
```
|
41
|
+
|
42
|
+
- Run tests
|
43
|
+
|
44
|
+
```sh
|
45
|
+
bundle exec rspec
|
46
|
+
```
|
47
|
+
|
48
|
+
### 2. Running your unpublished Plugin in Logstash
|
49
|
+
|
50
|
+
#### 2.1 Run in a local Logstash clone
|
51
|
+
|
52
|
+
- Edit Logstash `Gemfile` and add the local plugin path, for example:
|
53
|
+
```ruby
|
54
|
+
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
|
55
|
+
```
|
56
|
+
- Install plugin
|
57
|
+
```sh
|
58
|
+
# Logstash 2.3 and higher
|
59
|
+
bin/logstash-plugin install --no-verify
|
60
|
+
|
61
|
+
# Prior to Logstash 2.3
|
62
|
+
bin/plugin install --no-verify
|
63
|
+
|
64
|
+
```
|
65
|
+
- Run Logstash with your plugin
|
66
|
+
```sh
|
67
|
+
bin/logstash -e 'filter {awesome {}}'
|
68
|
+
```
|
69
|
+
At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
|
70
|
+
|
71
|
+
#### 2.2 Run in an installed Logstash
|
72
|
+
|
73
|
+
You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
|
74
|
+
|
75
|
+
- Build your plugin gem
|
76
|
+
```sh
|
77
|
+
gem build logstash-filter-awesome.gemspec
|
78
|
+
```
|
79
|
+
- Install the plugin from the Logstash home
|
80
|
+
```sh
|
81
|
+
# Logstash 2.3 and higher
|
82
|
+
bin/logstash-plugin install --no-verify
|
83
|
+
|
84
|
+
# Prior to Logstash 2.3
|
85
|
+
bin/plugin install --no-verify
|
86
|
+
|
87
|
+
```
|
88
|
+
- Start Logstash and proceed to test the plugin
|
89
|
+
|
90
|
+
## Contributing
|
91
|
+
|
92
|
+
All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
|
93
|
+
|
94
|
+
Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
|
95
|
+
|
96
|
+
It is more important to the community that you are able to contribute.
|
97
|
+
|
98
|
+
For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
4.4.0
|