fluent-plugin-scalyr 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 07de29b14ab7bb4183d662138f847ee9b75e94ee1b4eabeb65bb30725baea31a
-  data.tar.gz: 26261270771892d09baa36c4c7625492b69748c2f908dc9d1595fad609adae6a
+SHA1:
+  metadata.gz: 525ad76a1b5dffcc9e95054ce47518f236b09f42
+  data.tar.gz: c6e7fc32d30c1af2c90a1370bf7acd52191e9725
 SHA512:
-  metadata.gz: b2de1513bda2040d60c4f7ccfeb9a44f1c5a8965601833b7f656851d3fe7107e8070b42b6e0f7dca47a31827285670b01317020cea272f8186f56eaeaa97e1e7
-  data.tar.gz: c07a6f90ffda567a2518a5d7de0b7c0af9d0320535ff3b080a1a23d40861a01a5a8193d3c44c03ea97ba0ddb2361f39d012f4dffb766e8e0c9d7be78ddfe703d
+  metadata.gz: b7906fea7f77596e7be212f82759970b3ca68db9fa9a192bfdced94d6f02342a76e0ce37cb2396d813dd3d4f24abe2214f437a0637aea1605911aa34bb0bcd5b
+  data.tar.gz: 8b18d99f72bdc39d0043d93cb37aa4cfaf71ea67ecba0003281ae567689089d6ed5ec15c41242abd76242b5b5b821c75172815dfc27dd75e7755a82faae85d6e

data/README.md

@@ -33,7 +33,7 @@ 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](http://docs.fluentd.org/articles/filter_record_transformer).
+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:
 
@@ -67,6 +67,7 @@ The following configuration options are also supported:
   #scalyr specific options
   api_write_token YOUR_SCALYR_WRITE_TOKEN
   compression_type bz2
+  use_hostname_for_serverhost true
   server_attributes {
     "serverHost": "front-1",
     "serverType": "frontend",
@@ -98,7 +99,7 @@ The following configuration options are also supported:
 </match>
 ```
 
-####Scalyr specific options
+### 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.
 
@@ -106,6 +107,8 @@ The following configuration options are also supported:
 
 ***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*.
 
+***use_hostname_for_serverhost*** - if `true` then if `server_attributes` is nil or it does *not* include a field called `serverHost` then the plugin will add the `serverHost` field with the value set to the hostname that fluentd is running on.  Defaults to `true`.
+
 ***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*.
@@ -132,7 +135,7 @@ The cURL project maintains CA certificate bundles automatically converted from m
 
 ***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'.
 
-####Buffer options
+### Buffer options
 
 ***retry_max_times*** - the maximum number of times to retry a failed post request before giving up.  Defaults to *40*.
 

data/VERSION

@@ -1 +1 @@
-0.8.7
+0.8.8

data/lib/fluent/plugin/out_scalyr.rb

@@ -26,6 +26,7 @@ require 'rbzip2'
 require 'stringio'
 require 'zlib'
 require 'securerandom'
+require 'socket'
 require 'thread'
 
 module Scalyr
@@ -36,6 +37,7 @@ module Scalyr
 
     config_param :api_write_token, :string
     config_param :server_attributes, :hash, :default => nil
+    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 => "/etc/ssl/certs/ca-bundle.crt"
     config_param :ssl_verify_peer, :bool, :default => true
@@ -109,6 +111,22 @@ module Scalyr
         @server_attributes = new_attributes
       end
 
+      # See if we should use the hostname as the server_attributes.serverHost
+      if @use_hostname_for_serverhost
+
+        # ensure server_attributes is not nil
+        if @server_attributes.nil?
+          @server_attributes = {}
+        end
+
+        # only set serverHost if it doesn't currently exist in server_attributes
+        # Note: Use strings rather than symbols for the key, because keys coming
+        # from the config file will be strings
+        if !@server_attributes.key? 'serverHost'
+          @server_attributes['serverHost'] = Socket.gethostname
+        end
+      end
+
       @scalyr_server << '/' unless @scalyr_server.end_with?('/')
 
       @add_events_uri = URI @scalyr_server + "addEvents"

data/test/test_config.rb

@@ -17,12 +17,15 @@
 
 
 require 'helper'
+require 'socket'
 
 class ConfigTest  < Scalyr::ScalyrOutTest
 
   def test_default_params
     d = create_driver
-    assert_nil( d.instance.server_attributes, "Default server_attributes not nil" )
+    hostname = Socket.gethostname
+    assert_not_nil( d.instance.server_attributes, "Default server_attributes should not be nil" )
+    assert_equal( hostname, d.instance.server_attributes['serverHost'], "Default serverHost is not hostname" )
     assert( d.instance.ssl_verify_peer, "Default ssl_verify_peer should be true" )
 
     #check default buffer limits because they are set outside of the config_set_default
@@ -30,6 +33,17 @@ class ConfigTest  < Scalyr::ScalyrOutTest
     assert_equal( 1024, d.instance.buffer.buffer_queue_limit, "Buffer queue limit should be 1024" )
   end
 
+  def test_custom_serverhost_not_overwritten
+    hostname = "customHost"
+    d = create_driver CONFIG + "server_attributes { \"serverHost\":\"#{hostname}\" }\nuse_hostname_for_serverhost true"
+    assert_equal( hostname, d.instance.server_attributes['serverHost'], "Custom serverHost should not be overwritten" )
+  end
+
+  def test_configure_use_hostname_for_serverhost
+    d = create_driver CONFIG + 'use_hostname_for_serverhost false'
+    assert_nil( d.instance.server_attributes, "Default server_attributes should be nil" )
+  end
+
   def test_configure_ssl_verify_peer
     d = create_driver CONFIG + 'ssl_verify_peer false'
     assert( !d.instance.ssl_verify_peer, "Config failed to set ssl_verify_peer" )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-scalyr
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors:
 - Imron Alston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -169,13 +169,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Scalyr plugin for fluentd
 test_files:
-- test/test_events.rb
-- test/test_config.rb
 - test/helper.rb
-- test/test_handle_response.rb
 - test/test_ssl_verify.rb
+- test/test_handle_response.rb
+- test/test_events.rb
+- test/test_config.rb