influxdb-logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a108e31a9049f7e781a2e049c130c0f7453d38c0
-  data.tar.gz: d15563795730d1197bcd81e6fa430913a7f923e6
+  metadata.gz: 4f2d46b592a8e518d7b066a8dc8097f311fffe14
+  data.tar.gz: 6adc6aa9db9821ca75b05548745b2776fc17b1db
 SHA512:
-  metadata.gz: 072df960c685702015d306b87881b2527d4a1268250cccb7274824aa4c5b928676b6fd4a07a596c1f0f5486862ab6c40868f4e67e5e59393db38c8f6a621dc1e
-  data.tar.gz: e31a48b3229760476d8d6119ec97f4ca39f88b445d4fa5b82c0f4da20691f2b78bda168718fbba3706cd9853f543b4751a0d49b9f86cb81834b1767d2eff5bed
+  metadata.gz: ab2d959f0ba12e9c0bc66942ec554a50b2e747fdfc5a4b9c4c08cb8573bf32506585b35e765d57fc7c4202915921be6f4f5215460141734e488ea913d249c2c8
+  data.tar.gz: 5242ee4f75b035a70588384c709f064a6b4af0f990e41030eadbdfb7fabda4e7c35c98362fb521fccae88cb57995d99aaf6937331ae3d613f9ec919760e791cf

data/CHANGELOG.md

@@ -1,8 +1,3 @@
-## 0.5.0 / April 29 2017
-
-* Rails 5.2
-* support nanosecond_precision(Support nanosecond precision when sending logs to Fluentd #43)*
-
 ## 0.4.0 / April 29 2017
 
 * Rails 5.1
@@ -41,11 +36,11 @@
 
 ## 0.1.5 / July 19 2014
 
- * Fix keynames of EVN['FLUENTD_URL']
+ * Fix keynames of EVN['INFLUXDB_URL']
 
 ## 0.1.4 / July 18 2014
 
- * Enable to use EVN['FLUENTD_URL']
+ * Enable to use EVN['INFLUXDB_URL']
 
 ## 0.1.3 / April 11 2014
 

data/README.md

@@ -1,6 +1,6 @@
-# Act::Fluent::Logger::Rails
+# influxdb-logger (Rails)
 
-Fluent logger.
+Log to Influxdb in Rails
 
 ## Supported versions
 
@@ -10,7 +10,7 @@ Fluent logger.
 
 Add this line to your application's Gemfile:
 
-    gem 'influxdb-logger
+    gem 'influxdb-logger', '5.1.4'
 
 And then execute:
 
@@ -22,89 +22,64 @@ Or install it yourself as:
 
 ## Usage
 
-in config/environments/production.rb
-
-    config.log_level = :info
-    config.logger = InfluxdbLogger::Logger.
-      new(log_tags: {
-            ip: :ip,
-            ua: :user_agent,
-            uid: ->(request) { request.session[:uid] }
-          })
-
-Don't use config.log_tags.
-
-### To define where to send messages to, either:
-
-#### create config/fluent-logger.yml
-
-    development:
-      fluent_host:   '127.0.0.1'
-      fluent_port:   24224
-      tag:           'foo'
-      messages_type: 'string'
-      severity_key:  'level'     # default severity
-
-    test:
-      fluent_host:   '127.0.0.1'
-      fluent_port:   24224
-      tag:           'foo'
-      messages_type: 'string'
-      severity_key:  'level'     # default severity
-
-    production:
-      fluent_host:   '127.0.0.1'
-      fluent_port:   24224
-      tag:           'foo'
-      messages_type: 'string'
-      severity_key:  'level'     # default severity
-
-#### set an environment variable FLUENTD_URL
-
-    http://fluentd.example.com:42442/foo?messages_type=string&severity_key=level
-
-#### pass a settings object to InfluxdbLogger::Logger.new
-
-    config.logger = InfluxdbLogger::Logger.
-      new(settings: {
-            host: '127.0.0.1',
-            port: 24224,
-            tag: 'foo',
-            messages_type: 'string',
-            severity_key: 'level'
-          })
-
-### Setting
-
- * fluent_host: The host name of Fluentd.
- * fluent_port: The port number of Fluentd.
- * tag: The tag of the Fluentd event.
- * messages_type: The type of log messages. 'string' or 'array'.
-   If it is 'string', the log messages is a String.
-```
-2013-01-18T15:04:50+09:00 foo {"messages":"Started GET \"/\" for 127.0.0.1 at 2013-01-18 15:04:49 +0900\nProcessing by TopController#index as HTML\nCompleted 200 OK in 635ms (Views: 479.3ms | ActiveRecord: 39.6ms)"],"severity":"INFO"}
-```
-   If it is 'array', the log messages is an Array.
-```
-2013-01-18T15:04:50+09:00 foo {"messages":["Started GET \"/\" for 127.0.0.1 at 2013-01-18 15:04:49 +0900","Processing by TopController#index as HTML","Completed 200 OK in 635ms (Views: 479.3ms | ActiveRecord: 39.6ms)"],"severity":"INFO"}
+In `config/environments/production.rb`(`test.rb`, `development.rb`)
+
+```ruby
+config.logger = InfluxdbLogger::Logger.new(log_tags: {}, ...)
+
 ```
- * severity_key: The key of severity(DEBUG, INFO, WARN, ERROR).
 
-You can add any tags at run time.
+Supported parameters for `InfluxdbLogger::Logger.new`:
 
-   logger[:foo] = "foo value"
+* `log_tags`: tags which you want the created logger to pass into influxdb, for example, 
+  you could log **ip**, **user agent**, **device_type**(through requested parameters) and **version** with the following setup:
 
-### Usage as a standalone logger
+  ```ruby
+    config.logger = InfluxdbLogger::Logger.new(log_tags: {
+      ip: :ip,
+      ua: :user_agent,
+      device_type: -> request { request.params[:DEVICE_TYPE] },
+      version: -> request { request.params[:VERSION] },
+      session_id: -> request { request.params[:session_id] }
+    }, settings: ...})
 
-Typical usage is as a replacement for the default Rails logger, in which case
-messages are collected and flushed automatically as part of the request
-lifecycle. If you wish to use it instead as a separate logger and log to it
-manually then it is necessary to initialize with the `flush_immediately` flag.
+  ```
 
+* `settings`: which defines how the logger would connect to influxdb database. More detail about it could found in [influxdb-ruby](https://github.com/influxdata/influxdb-ruby).
 ```ruby
-InfluxdbLogger::Logger.new(flush_immediately: true)
-```
-
+      InfluxdbLogger::Logger.new(settings: {
+        host: 'influxdb',
+        database: 'rallets',
+        series: series,
+        retry: 3,
+        username: 'user',
+        password: 'password',
+        time_precision: 'ms'
+      })
+  ```
+
+* `batch_size`, `interval`: Since logging is a high frequncy job for any application with large user base in production environment. These two parameters
+   give a chance for the logger to batch logging actions.
+
+   For example, you can tell the logger to log when size of logging actions hits `1000` or that the last logging action is `1000`ms later than the first one in the queue by:
+
+  ```ruby
+      InfluxdbLogger::Logger.new(batch_size: 1000, interval: 1000, log_tags: {
+        ip: :ip,
+        ua: :user_agent,
+        device_type: -> request { request.params[:DEVICE_TYPE] },
+        version: -> request { request.params[:VERSION] },
+        session_id: -> request { request.params[:session_id] }
+      }, settings: {
+        host: 'influxdb',
+        database: 'rallets',
+        series: series,
+        retry: 3,
+        username: 'user',
+        password: 'password',
+        time_precision: 'ms'
+      })
+  ```
 
 ## Contributing
 

data/lib/influxdb-logger/logger.rb

@@ -11,6 +11,11 @@ class Time
 end
 
 module InfluxdbLogger
+  def log_to_file(message) # for test
+    open("#{Rails.root}/log/my.log", 'w') { |f|
+      f.puts message.inspect
+    }
+  end
 
   module Logger
 
@@ -31,41 +36,35 @@ module InfluxdbLogger
           end
         end
       end
-      if (0 == settings.length)
-        fluent_config = if ENV["FLUENTD_URL"]
-                          self.parse_url(ENV["FLUENTD_URL"])
-                        end
-        settings = {
-          tag:  fluent_config['tag'],
-          host: fluent_config['fluent_host'],
-          port: fluent_config['fluent_port'],
-          nanosecond_precision: fluent_config['nanosecond_precision'],
-          messages_type: fluent_config['messages_type'],
-          severity_key: fluent_config['severity_key'],
-        }
+
+      if ENV["INFLUXDB_URL"]
+        settings = self.parse_url(ENV["INFLUXDB_URL"]).merge(settings)
       end
 
       settings[:batch_size] ||= batch_size
       settings[:interval] ||= interval
 
       level = SEV_LABEL.index(Rails.application.config.log_level.to_s.upcase)
-      logger = InfluxdbLogger::FluentLogger.new(settings, level, log_tags)
+      logger = InfluxdbLogger::InnerLogger.new(settings, level, log_tags)
       logger = ActiveSupport::TaggedLogging.new(logger)
       logger.extend self
     end
 
-    def self.parse_url(fluentd_url)
-      uri = URI.parse fluentd_url
+    def self.parse_url(influxdb_url)
+      uri = URI.parse influxdb_url
       params = CGI.parse uri.query
-
       {
-        fluent_host: uri.host,
-        fluent_port: uri.port,
-        tag: uri.path[1..-1],
-        nanosecond_precision: params['nanosecond_precision'].try(:first),
+        database: uri.path[1..-1],
+        host: uri.host,
+        port: uri.port,
         messages_type: params['messages_type'].try(:first),
         severity_key: params['severity_key'].try(:first),
-      }.stringify_keys
+        username: params['username'].try(:first),
+        password: params['password'].try(:first),
+        series: params['series'].try(:first),
+        time_precision: params['time_precision'].try(:first),
+        retry: params['retry'].try(:first).to_i
+      }
     end
 
     def tagged(*tags)
@@ -76,7 +75,7 @@ module InfluxdbLogger
     end
   end
 
-  class FluentLogger < ActiveSupport::Logger
+  class InnerLogger < ActiveSupport::Logger
     def initialize(options, level, log_tags)
       self.level = level
       @messages_type = (options[:messages_type] || :array).to_sym
@@ -192,18 +191,14 @@ module InfluxdbLogger
 
     def flush
       return if @messages.empty?
-      # test switch
-      # open("#{Rails.root}/log/my.log", 'w') { |f|
-      #   f.puts @messages
-      # }
       @influxdb_logger.write_points(@messages)
       @severity = 0
       @messages.clear
       @last_flush_time = Time.now.to_ms
+      @tags = nil
     end
 
     def close
-      # @fluent_logger.close
     end
 
     def level
@@ -219,4 +214,3 @@ module InfluxdbLogger
     end
   end
 end
-

data/lib/influxdb-logger/version.rb

@@ -1,3 +1,3 @@
 module InfluxdbLogger
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/logger_spec.rb

@@ -7,6 +7,12 @@ class Time
   end
 end
 
+module InfluxdbLogger
+  module Logger
+    attr_accessor :settings
+  end
+end
+
 describe InfluxdbLogger::Logger do
   before do
     stub_const('Rails', Class.new) unless defined?(Rails)
@@ -16,6 +22,10 @@ describe InfluxdbLogger::Logger do
 
     class MyLogger
       attr_accessor :log
+      def initialize()
+        @log = []
+      end
+
       def post(tag, map)
       end
 
@@ -27,7 +37,6 @@ describe InfluxdbLogger::Logger do
       end
 
       def write_point(point)
-        @log ||= []
         @log << point
       end
 
@@ -179,24 +188,43 @@ describe InfluxdbLogger::Logger do
     end
   end
 
-  describe "use ENV['FLUENTD_URL']" do
-    let(:fluentd_url) { "http://fluentd.example.com:42442/hoge?messages_type=string&severity_key=level" }
-
-    describe ".parse_url" do
-      subject { described_class.parse_url(fluentd_url) }
-      it { expect(subject['tag']).to eq 'hoge' }
-      it { expect(subject['fluent_host']).to eq 'fluentd.example.com' }
-      it { expect(subject['fluent_port']).to eq 42442 }
-      it { expect(subject['messages_type']).to eq 'string' }
-      it { expect(subject['severity_key']).to eq 'level' }
+  describe "settings with ENV['INDUX_DB_URL']" do
+    let(:influxdb_url) { 'http://influxdb:8086/rallets?messages_type=string&severity_key=level&username=user&password=pass&time_precision=ms&series=Log&retry=3' }
+
+      it "settings are properly set" do
+        stub_const("ENV", {'INFLUXDB_URL' => influxdb_url })
+        allow(InfluxdbLogger::InnerLogger).to receive(:new) do |settings|
+          expect(settings).to eq({
+            database: "rallets",
+            host: "influxdb",
+            port: 8086,
+            messages_type: "string",
+            severity_key: "level",
+            username: "user",
+            password: "pass",
+            series: "Log",
+            time_precision: "ms",
+            retry: 3,
+            batch_size: 1000,
+            interval: 1000
+          })
+          ActiveSupport::Logger.new(STDOUT)
+        end
+        InfluxdbLogger::Logger.new(settings: {})
     end
   end
 
-  describe 'batch size' do
-    it 'works well with batch size' do
-      # logger = InfluxdbLogger::Logger.new(settings: settings, batch_size: 2))
-      # logger.info('Immediately!')
-      # expect(@my_logger.log).to eq(nil)
+  describe 'batch size', now: true do
+    it 'inner logger write_points after every two messages if batch_size is set to 2' do
+      logger = InfluxdbLogger::Logger.new(settings: settings, batch_size: 2)
+      logger.info('message 1')
+      expect(@my_logger.log.size).to eq 0
+      logger.info('message 2')
+      expect(@my_logger.log.size).to eq 2
+      logger.info('message 3')
+      expect(@my_logger.log.size).to eq 2
+      logger.info('message 4')
+      expect(@my_logger.log.size).to eq 4
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rallets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec