fluent-plugin-scalyr 0.8.10 → 0.8.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607dd0cf45280387ab9c19b460eab081f2111b1059f8036032e13c1c5c4fd901
-  data.tar.gz: 3d0fa711e084ce2f204dbf69c249363a88d73293a6874c8eb6a175ee920e5cc5
+  metadata.gz: b707a6d76dc806731c45f6a96915936e559c49c79e873c3c5ea5dce4ffbaf288
+  data.tar.gz: a328a42722469673e69d9e7a77e84c65cb1f7235a566076a1316216937a54405
 SHA512:
-  metadata.gz: f6075b808c1126d4b4d8ba7ea30fb5d899facc78c38f4d0d95afc8c97f5eca8f28aefdf414b267dd45695ebe70feb2dd976be76babb8f8458d1240382077a3f0
-  data.tar.gz: deeafb8a4886f51ce635541756e33ba5c3a98b31e6c4ac6f0a5a37a9f8f8862e2a32d0be2026d90f6f7828157e43ac77261529364f1b2bf697b9a2948f7fd3e4
+  metadata.gz: fad3abf458ae0f215f7a29ca3aa4cc167d05811e270c3eace46057ce291307f3b76ef8c13c269b8c43b4564909001e2421dd6ef591188e52c6ed44c22a5ef946
+  data.tar.gz: b8a3268ce7d4d71178ea3356ba47ffd9247cbe3c55d49d436916868076710c4f66719266235d926e314b936bed5544a92de6afdad93a0b33be5d4d0fe0d473cb

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -30,22 +30,6 @@ This can be done by specifying tags such as scalyr.apache, scalyr.maillog etc an
 
 Fluentd tag names will be used for the logfile name in Scalyr.
 
-Scalyr Parsers and Custom Fields
---------------------------------
-
-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](https://docs.fluentd.org/filter/record_transformer).
-
-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:
-
-```
-<filter scalyr.access>
-  @type record_transformer
-  <record>
-    parser accessLog
-  </record>
-</filter>
-```
-
 Plugin Configuration
 -------------
 
@@ -80,6 +64,7 @@ The following configuration options are also supported:
   ssl_verify_peer true
   ssl_verify_depth 5
   message_field message
+  parser nil
 
   max_request_buffer 5500000
 
@@ -104,6 +89,32 @@ For some additional examples of configuration for different setups, please refer
 [examples/configs/](https://github.com/scalyr/scalyr-fluentd/tree/master/examples/configs/)
 directory.
 
+Scalyr Parsers and Custom Fields
+--------------------------------
+
+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](https://docs.fluentd.org/filter/record_transformer).
+
+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:
+
+```
+<filter scalyr.access>
+  @type record_transformer
+  <record>
+    parser accessLog
+  </record>
+</filter>
+```
+
+Alternatively, if the same parser can be used for all events sent by the Fluentd output plugin, the parser can be set using the ```parser``` plugin configuration. For example, to use Scalyr's ```accessLog``` parser for all events, use the output plugin configuration:
+
+```
+<match scalyr.*>
+  @type scalyr
+  api_write_token YOUR_SCALYR_WRITE_LOGS_TOKEN
+  parser accessLog
+</match>
+```
+
 ### Scalyr specific options
 
 ***compression_type*** - compress Scalyr traffic to reduce network traffic. Options are `bz2` and `deflate`. See [here](https://www.scalyr.com/help/scalyr-agent#compressing) for more details.  This feature is optional.
@@ -116,7 +127,7 @@ directory.
 
 ***scalyr_server*** - the Scalyr server to send API requests to. This value is optional and defaults to https://agent.scalyr.com/
 
-***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*.
+***ssl_ca_bundle_path*** - a path on your server pointing to a valid certificate bundle.  This value is optional and defaults to *nil*, which means it will look for a valid certificate bundle on its own.
 
 **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:
 
@@ -134,6 +145,8 @@ The cURL project maintains CA certificate bundles automatically converted from m
 
 ***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.
 
+***parser*** - The Scalyr parser to use to parse the 'message' field for each event. This value is optional and defaults to *nil*.
+
 ***max_request_buffer*** - The maximum size in bytes of each request to send to Scalyr.  Defaults to 5,500,000 (5.5MB).  Fluentd chunks that generate JSON requests larger than the max_request_buffer will be split in to multiple separate requests.  **Note:** The maximum size the Scalyr servers accept for this value is 6MB and requests containing data larger than this will be rejected.
 
 ***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.
@@ -180,3 +193,22 @@ Which builds the gem and puts it in the pkg directory, then install the Gem usin
 ```
 fluent-gem install pkg/fluent-plugin-scalyr-<VERSION>.gem
 ```
+
+Publishing a new release to RubyGems
+------------------------------------
+
+(for project maintainers)
+
+To publish a new version to RubyGems, simply make your changes, make sure all the lint checks and
+tests pass and merge your changes into master.
+
+After that's done, bump a version in ``VERSION`` file, update ``CHANGELOG.md`` file, add a tag
+which matches a version in VERSION file (e.g. ``v0.8.10``) and push that tag to the remote:
+
+```bash
+git tag v0.8.10
+git push origin v0.8.10
+```
+
+Push of this tag will trigger a Circle CI job which will build the latest version of the gem and
+publish it to RubyGems.

data/Rakefile

@@ -1,11 +1,15 @@
-require 'bundler'
+# frozen_string_literal: true
+
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.libs << "test" << "lib"
-  t.pattern = 'test/**/test_*.rb'
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.test_files = FileList["test/test_*.rb"]
+  test.verbose = true
+  test.options = "--verbose=verbose"
 end
 
-task :default => [:build]
+task default: [:build]

data/VERSION

@@ -1 +1 @@
-0.8.10
+0.8.15

data/fluent-plugin-scalyr.gemspec

@@ -1,4 +1,6 @@
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 
 Gem::Specification.new do |gem|
   gem.name = "fluent-plugin-scalyr"
@@ -10,16 +12,18 @@ Gem::Specification.new do |gem|
   gem.licenses = ["Apache-2.0"]
   gem.email = "imron@scalyr.com"
   gem.platform = Gem::Platform::RUBY
-  gem.files = Dir['AUTHORS', 'Gemfile', 'LICENSE', 'README.md', 'Rakefile', 'VERSION', 'fluent-plugin-scalyr.gemspec', 'fluent.conf.sample', 'lib/**/*', 'test/**/*']
+  gem.files = Dir["AUTHORS", "Gemfile", "LICENSE", "README.md", "Rakefile", "VERSION",
+                  "fluent-plugin-scalyr.gemspec", "fluent.conf.sample", "lib/**/*", "test/**/*"]
   gem.test_files = Dir.glob("{test,spec,features}/**/*")
-  gem.executables = Dir.glob("bin/*").map{ |f| File.basename(f) }
-  gem.require_paths = ['lib']
-  gem.add_dependency "fluentd", [">= 0.14.0", "< 2"]
+  gem.executables = Dir.glob("bin/*").map {|f| File.basename(f) }
+  gem.require_paths = ["lib"]
   gem.add_dependency "ffi", "1.9.25"
+  gem.add_dependency "fluentd", [">= 0.14.0", "< 2"]
   gem.add_dependency "rbzip2", "0.3.0"
   gem.add_dependency "zlib"
+  gem.add_development_dependency "bundler", "~> 1.9"
+  gem.add_development_dependency "flexmock", "~> 1.2"
   gem.add_development_dependency "rake", "~> 0.9"
+  gem.add_development_dependency "rubocop", "~> 0.4"
   gem.add_development_dependency "test-unit", "~> 3.0"
-  gem.add_development_dependency "flexmock", "~> 1.2"
-  gem.add_development_dependency "bundler", "~> 1.9"
 end