fluent-plugin-scalyr 0.8.12 → 0.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e738c523b1cea2d7aa0976064cb4fa85379b63795f1230a965da934033bc619
-  data.tar.gz: '09241b0eabc17074c5b4effb5f53ba47d183bb97ad724a064d6e9cfa9d5e8641'
+  metadata.gz: f9f9a9d2d7c0086b3885e3c3962fcd7271b84b79cbd1dd937cfb27f1d24e16d8
+  data.tar.gz: d99dd0b487a8f4920a2abc53b00fb2f75499647ed6cb75bcd0ffa9a0a0dd0871
 SHA512:
-  metadata.gz: 238b972ec9340a013d473911c05955e0a39d03f706d215167f2b3837bf46610917d2741680fd698c5d1075d1f7a307debd3c7cf4111ebba07280110bff2239dc
-  data.tar.gz: 1c42dfccbfa8963652198b3b2c0da102feda2b1052370b3296c26c781f5ab1fcd0126b513f87139e055c437c82347c597fe930f3739b6f61a4f8ac7d1764996a
+  metadata.gz: b6374eb7cb7e4eb1fa3ba3c7342999f176743b07b3293ff3a34f87e127004db50502fb3989117873b68702600fdb6072f4fe39f1f78fef2d280d37a86fa04dc8
+  data.tar.gz: 8964f56c050fa025825ef3bb4c74d7ef593d32eee86930f9bb9847bedd5048a1851767cc1d3d9d67f064dc1b08622b479add48cab6f395519f08e692c2f57154

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.
@@ -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.

data/VERSION

@@ -1 +1 @@
-0.8.12
+0.8.14

data/lib/fluent/plugin/out_scalyr.rb

@@ -37,6 +37,7 @@ module Scalyr
 
     config_param :api_write_token, :string
     config_param :server_attributes, :hash, default: nil
+    config_param :parser, :string, default: nil # Set the "parser" field to this, per event.
     config_param :use_hostname_for_serverhost, :bool, default: true
     config_param :scalyr_server, :string, default: "https://agent.scalyr.com/"
     config_param :ssl_ca_bundle_path, :string, default: nil
@@ -322,6 +323,9 @@ module Scalyr
         # add a logfile field if one doesn't exist
         record["logfile"] = "/fluentd/#{tag}" unless record.key? "logfile"
 
+        # set per-event parser if it is configured
+        record["parser"] = @parser unless @parser.nil?
+
         # append to list of events
         event = {thread: thread_id.to_s,
                  ts:     timestamp,

data/test/test_config.rb

@@ -57,5 +57,10 @@ class ConfigTest < Scalyr::ScalyrOutTest
     d = create_driver CONFIG + 'server_attributes { "test":"value" }'
     assert_equal("value", d.instance.server_attributes["test"], "Config failed to set server_attributes")
   end
+
+  def test_configure_parser
+    d = create_driver CONFIG + "parser access_log"
+    assert_equal("access_log", d.instance.parser, "Config failed to set parser")
+  end
 end
 # rubocop:enable Layout/LineLength

data/test/test_events.rb

@@ -136,6 +136,34 @@ class EventsTest < Scalyr::ScalyrOutTest
     assert_equal(mock_called, true, "mock method was never called!")
   end
 
+  def test_build_add_events_body_with_parser
+    d = create_driver CONFIG + "parser test_parser"
+
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"a" => 1}
+
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
+
+    mock_called = false
+
+    mock.should_receive(:post_request).with(
+      URI,
+      on {|request_body|
+        body = JSON.parse(request_body)
+        assert_equal("test_parser", body["events"][0]["attrs"]["parser"])
+        mock_called = true
+        true
+      }
+    ).once.and_return(response)
+
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+
+    assert_equal(mock_called, true, "mock method was never called!")
+  end
+
   def test_build_add_events_body_incrementing_timestamps
     d = create_driver
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-scalyr
 version: !ruby/object:Gem::Version
-  version: 0.8.12
+  version: 0.8.14
 platform: ruby
 authors:
 - Imron Alston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -190,8 +190,8 @@ specification_version: 4
 summary: Scalyr plugin for fluentd
 test_files:
 - test/helper.rb
+- test/test_config.rb
 - test/test_events.rb
 - test/test_handle_response.rb
-- test/test_config.rb
-- test/test_utils.rb
 - test/test_ssl_verify.rb
+- test/test_utils.rb