fluent-plugin-scalyr 0.7.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b1fc25ee3a1190c067fd302c7ddb8ae3bb59264c
4
+ data.tar.gz: 28249edc864fc9d08484726d2cd5fc580359ed29
5
+ SHA512:
6
+ metadata.gz: 9d3e6e9a2ba5979e1d8dd7dc099c0bbece63fcf88f8973ce3daec668dad8777f0ac67fdb3e4b43cdac4fde3b06c3110cefbea5acf23cd181284d60e8f9738964
7
+ data.tar.gz: 5a13b702c174f555d29ff89e6a65d9f29fc5a560b6f7440d25a5d466548a3ff2e9d236431e79e56174b3255d2ef9f34ed1e124b7540f92d165d8c967c26ec461
data/AUTHORS ADDED
@@ -0,0 +1 @@
1
+ Imron Alston <imron _at_ imralsoftware.com>
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
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 [yyyy] [name of copyright owner]
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.
@@ -0,0 +1,166 @@
1
+ Scalyr output plugin for Fluentd
2
+ =========================
3
+
4
+ **Note:** Fluentd introduced breaking changes to their plugin API between
5
+ version 0.12 and 0.14.
6
+
7
+ The current master branch of the scalyr-fluentd plugin is compatible with
8
+ Fluentd version 0.14 and above (including fluentd 1.0.0). This branch is
9
+ compatible with fluentd v0.12 and earlier.
10
+
11
+ Overview
12
+ --------
13
+
14
+ The **Scalyr** output plugin buffers events from fluent and posts them to [Scalyr](http://www.scalyr.com).
15
+
16
+ Events are uploaded either periodically (e.g. every 5 seconds) or once the buffer reaches a certain size (e.g. 64k).
17
+
18
+ Fluentd may format log messages into json or some other format. If you want to send raw logs to Scalyr then in your configuration &lt;source&gt; be sure to specify
19
+
20
+ ```
21
+ format none
22
+ ```
23
+
24
+ The Scalyr output plugin assigns a unique Scalyr session id for each Fluentd &lt;match&gt; block. It is recommended that a single machine doesn't create too many simultaneous Scalyr sessions, so if possible you should try to have a single match for all logs you wish to send to Scalyr.
25
+
26
+ This can be done by specifying tags such as scalyr.apache, scalyr.maillog etc and matching on scalyr.\*
27
+
28
+ Fluentd tag names will be used for the logfile name in Scalyr.
29
+
30
+ Scalyr Parsers and Custom Fields
31
+ --------------------------------
32
+
33
+ You may also need to specify a Scalyr parser for your log message or add custom fields to each log event. This can be done using Fluentd's filter mechanism, in particular the [record_transformer filter](http://docs.fluentd.org/articles/filter_record_transformer).
34
+
35
+ For example, if you want to use Scalyr's ```accessLog``` parser for all events with the ```scalyr.access``` tag you would add the following to your fluent.conf file:
36
+
37
+ ```
38
+ <filter scalyr.access>
39
+ type record_transformer
40
+ <record>
41
+ parser accessLog
42
+ </record>
43
+ </filter>
44
+ ```
45
+
46
+ Plugin Configuration
47
+ -------------
48
+
49
+ The Scalyr output plugin has a number of sensible defaults so the minimum configuration only requires your Scalyr 'write logs' token.
50
+
51
+ ```
52
+ <match scalyr.*>
53
+ type @scalyr
54
+ api_write_token YOUR_SCALYR_WRITE_LOGS_TOKEN
55
+ </match>
56
+ ```
57
+
58
+ The following configuration options are also supported:
59
+
60
+ ```
61
+ <match scalyr.*>
62
+ type @scalyr
63
+
64
+ #scalyr specific options
65
+ api_write_token YOUR_SCALYR_WRITE_TOKEN
66
+ server_attributes {
67
+ "serverHost": "front-1",
68
+ "serverType": "frontend",
69
+ "region": "us-east-1"
70
+ }
71
+
72
+ scalyr_server https://agent.scalyr.com/
73
+ ssl_ca_bundle_path /etc/ssl/certs/ca-bundle.crt
74
+ ssl_verify_peer true
75
+ ssl_verify_depth 5
76
+ message_field message
77
+
78
+ max_request_buffer 1048576
79
+
80
+ force_message_encoding nil
81
+ replace_invalid_utf8 false
82
+
83
+ #buffered output options
84
+ retry_limit 40
85
+ retry_wait 5s
86
+ max_retry_wait 30s
87
+ flush_interval 5s
88
+ buffer_chunk_limit 100k
89
+ buffer_queue_limit 1024
90
+ num_threads 1
91
+
92
+ </match>
93
+ ```
94
+
95
+ ####Scalyr specific options
96
+
97
+ ***api_write_token*** - your Scalyr write logs token. See [here](http://www.scalyr.com/keys) for more details. This value **must** be specified.
98
+
99
+ ***server_attributes*** - a JSON hash containing custom server attributes you want to include with each log request. This value is optional and defaults to *nil*.
100
+
101
+ ***scalyr_server*** - the Scalyr server to send API requests to. This value is optional and defaults to https://agent.scalyr.com/
102
+
103
+ ***ssl_ca_bundle_path*** - a path on your server pointing to a valid certificate bundle. This value is optional and defaults to */etc/ssl/certs/ca-bundle.crt*.
104
+
105
+ **Note:** if the certificate bundle does not contain a certificate chain that verifies the Scalyr SSL certificate then all requests to Scalyr will fail unless ***ssl_verify_peer*** is set to false. If you suspect logging to Scalyr is failing due to an invalid certificate chain, you can grep through the Fluentd output for warnings that contain the message 'certificate verification failed'. The full text of such warnings will look something like this:
106
+
107
+ >2015-04-01 08:47:05 -0400 [warn]: plugin/out_scalyr.rb:85:rescue in write: SSL certificate verification failed. Please make sure your certificate bundle is configured correctly and points to a valid file. You can configure this with the ssl_ca_bundle_path configuration option. The current value of ssl_ca_bundle_path is '/etc/ssl/certs/ca-bundle.crt'
108
+
109
+ >2015-04-01 08:47:05 -0400 [warn]: plugin/out_scalyr.rb:87:rescue in write: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
110
+
111
+ >2015-04-01 08:47:05 -0400 [warn]: plugin/out_scalyr.rb:88:rescue in write: Discarding buffer chunk without retrying or logging to &lt;secondary&gt;
112
+
113
+ The cURL project maintains CA certificate bundles automatically converted from mozilla.org [here](http://curl.haxx.se/docs/caextract.html).
114
+
115
+ ***ssl_verify_peer*** - verify SSL certificates when sending requests to Scalyr. This value is optional, and defaults to *true*.
116
+
117
+ ***ssl_verify_depth*** - the depth to use when verifying certificates. This value is optional, and defaults to *5*.
118
+
119
+ ***message_field*** - Scalyr expects all log events to have a 'message' field containing the contents of a log message. If your event has the log message stored in another field, you can specify the field name here, and the plugin will rename that field to 'message' before sending the data to Scalyr. **Note:** this will override any existing 'message' field if the log record contains both a 'message' field and the field specified by this config option.
120
+
121
+ ***max_request_buffer*** - The maximum size in bytes of each request to send to Scalyr. Defaults to 1,048,576 (1MB). Fluentd chunks that generate JSON requests larger than the max_request_buffer will be split in to multiple separate requests. **Note:** If you set this value too large Scalyr may reject your requests.
122
+
123
+ ***force_message_encoding*** - Set a specific encoding for all your log messages (defaults to nil). If your log messages are not in UTF-8, this can cause problems when converting the message to JSON in order to send to the Scalyr server. You can avoid these problems by setting an encoding for your log messages so they can be correctly converted.
124
+
125
+ ***replace_invalid_utf8*** - If this value is true and ***force_message_encoding*** is set to 'UTF-8' then all invalid UTF-8 sequences in log messages will be replaced with <?>. Defaults to false. This flag has no effect if ***force_message_encoding*** is not set to 'UTF-8'.
126
+
127
+ ####BufferedOutput options (inherited from Fluent::BufferedOutput)
128
+
129
+ ***retry_limit*** - the maximum number of times to retry a failed post request before giving up. Defaults to *40*.
130
+
131
+ ***retry_wait*** - the initial time to wait before retrying a failed request. Defaults to *5 seconds*. Wait times will increase up to a maximum of ***max_retry_wait***
132
+
133
+ ***max_retry_wait*** - the maximum time to wait between retrying failed requests. Defaults to *30 seconds*. **Note:** This is not the total maximum time of all retry waits, but rather the maximum time to wait for a single retry.
134
+
135
+ ***flush_interval*** - how often to upload logs to Scalyr. Defaults to *5 seconds*.
136
+
137
+ ***buffer_chunk_limit*** - the maximum amount of log data to send to Scalyr in a single request. Defaults to *100KB*. **Note:** if you set this value too large, then Scalyr may reject your requests. Requests smaller than 1MB will typically be accepted by Scalyr, but note that the 1MB limit also includes the entire request body and all associated JSON keys and punctuation, which may be considerably larger than the raw log data.
138
+
139
+ ***buffer_queue_limit*** - the maximum number of chunks to buffer before dropping new log requests. Defaults to *1024*. Combines with ***buffer_chunk_limit*** to give you the total amount of buffer to use in the event of request failures before dropping requests.
140
+
141
+ ***num_threads*** - the number of threads to use to upload logs. This is currently fixed to 1 will cause fluentd to fail with a ConfigError if set to anything greater.
142
+
143
+ Secondary Logging
144
+ -----------------
145
+
146
+ Fluentd also supports &lt;secondary&gt; logging for all buffered output for when the primary output fails (see the Fluentd [documentation](http://docs.fluentd.org/articles/output-plugin-overview#secondary-output) for more details). This is also supported by the Scalyr output plugin.
147
+
148
+ **Note:** There are certain conditions that may cause the Scalyr plugin to discard a buffer without logging it to secondary output. This will currently happen if:
149
+ * SSL certificate verification fails when sending a request
150
+ * An errant configuration is flooding the Scalyr servers with requests, and the servers respond by dropping/ignoring the logs.
151
+
152
+ Installation
153
+ ------------
154
+
155
+ Run
156
+
157
+ ```
158
+ rake build
159
+
160
+ ```
161
+
162
+ Which builds the gem and puts it in the pkg directory, then install the Gem using fluent's gem manager
163
+
164
+ ```
165
+ fluent-gem install pkg/fluent-plugin-scalyr-<VERSION>.gem
166
+ ```
@@ -0,0 +1,11 @@
1
+ require 'bundler'
2
+ Bundler::GemHelper.install_tasks
3
+
4
+ require 'rake/testtask'
5
+
6
+ Rake::TestTask.new do |t|
7
+ t.libs << "test" << "lib"
8
+ t.pattern = 'test/**/test_*.rb'
9
+ end
10
+
11
+ task :default => [:build]
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.7.4
@@ -0,0 +1,23 @@
1
+ $:.push File.expand_path('../lib', __FILE__)
2
+
3
+ Gem::Specification.new do |gem|
4
+ gem.name = "fluent-plugin-scalyr"
5
+ gem.summary = "Scalyr plugin for fluentd"
6
+ gem.description = "Sends log data collected by fluentd to Scalyr (http://www.scalyr.com)"
7
+ gem.homepage = "https://github.com/scalyr/scalyr-fluentd"
8
+ gem.version = File.read("VERSION").strip
9
+ gem.authors = ["Imron Alston"]
10
+ gem.licenses = ["Apache-2.0"]
11
+ gem.email = "imron@imralsoftware.com"
12
+ gem.has_rdoc = false
13
+ gem.platform = Gem::Platform::RUBY
14
+ gem.files = `git ls-files`.split("\n")
15
+ gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
16
+ gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
17
+ gem.require_paths = ['lib']
18
+ gem.add_dependency "fluentd", [">= 0.10.49", "< 0.14"]
19
+ gem.add_development_dependency "rake", "~> 0.9"
20
+ gem.add_development_dependency "test-unit", "~> 3.0"
21
+ gem.add_development_dependency "flexmock", "~> 1.2"
22
+ gem.add_development_dependency "bundler", "~> 1.9"
23
+ end
@@ -0,0 +1,28 @@
1
+ <match scalyr.*>
2
+ @type scalyr
3
+ api_write_token YOUR_WRITE_LOGS_API_TOKEN
4
+
5
+ ##Scalyr specific options
6
+ # server_attributes {
7
+ # "serverHost": "front-1",
8
+ # "serverType": "frontend",
9
+ # "region": "us-east-1"
10
+ # }
11
+ # scalyr_server https://agent.scalyr.com/
12
+ # ssl_ca_bundle_path /etc/ssl/certs/ca-bundle.crt
13
+ # ssl_verify_peer true
14
+ # ssl_verify_depth 5
15
+ # force_message_encoding nil
16
+ # replace_invalid_utf8 false
17
+
18
+
19
+ ##BufferedOutput options
20
+ # retry_limit 40
21
+ # retry_wait 5s
22
+ # max_retry_wait 30s
23
+ # flush_interval 5s
24
+ # buffer_chunk_limit 100k
25
+ # buffer_queue_limit 1024
26
+ # num_threads 1
27
+
28
+ </match>