influxdb-logger 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b05d8b6706111f2fca5db10879f26ce106aa81b
-  data.tar.gz: f486822bc9d4c99f7837c8dfc6d0ee760c240e48
+  metadata.gz: e56aa8636f81b07f6f8ba75b534ac4165b190ef1
+  data.tar.gz: bc744b3cb2fd91cc6ebaa3735ab5d02bc1252ffc
 SHA512:
-  metadata.gz: e438029412859abae4811a40d1982ff86f24f8faa762f37f4f653666109dbeea1130635146a5a6df6254870267345ffe862d04255f7616464efd36ae0463abf4
-  data.tar.gz: a46e990537873512fa206aa0de0de1eff7121fc0db29b2f86c189784e9fe0fc3038fb9b7e5f1a2508aa15c8c6152d24e5d69e938440b61434cd8b341e2b85630
+  metadata.gz: 9f1fc696deec683e26159b0993771d61762cbf372640ec6c082852905dff18f956e147fb84bb29aa5d5f52cba66861be129a15cb04b3201108cc45b18caceb4e
+  data.tar.gz: 16f960d5c0315cf0bc24762974611811fad31faebe69b3e8efdfa98f216a52ee6ccd14984093b6bdf2d824c050a9cf1ef7eff7fa4f04c3faaf6df6dc99b586a5

data/README.md

@@ -10,7 +10,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'influxdb-logger', '1.0.1'
+    gem 'influxdb-logger', '2.0.0'
 
 And then execute:
 
@@ -20,42 +20,56 @@ Or install it yourself as:
 
     $ gem install influxdb-logger
 
-## Usage
+## Basic Usage
 
 In `config/environments/production.rb`(`test.rb`, `development.rb`)
 
 ```ruby
-config.logger = InfluxdbLogger::Logger.new(log_tags: {}, ...)
+config.logger = InfluxdbLogger::Logger.new(influxdb_tags: ... tags: ... settings: ... batch_size: ..., interval: ...,  async: ...)
 
 ```
 
-Supported parameters for `InfluxdbLogger::Logger.new`:
+By default, influxdb-logger will log
+`duration, db, format, location, message, message_type, method, params, path, severity, status, view` as [fields](https://docs.influxdata.com/influxdb/v1.7/concepts/key_concepts/#field-key) into specified
+[series](https://docs.influxdata.com/influxdb/v1.7/concepts/key_concepts/#series).
 
-* `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:
+Which means, your `influxdb-logger` is good to go with configuration only about how to talk to influxdb: 
+```ruby
+config.logger = InfluxdbLogger::Logger.new(settings: {
+  database: ENV['INFLUXDB_DB_NAME'],
+  series: ENV['INFLUXDB_SERIES'],
+  username: ENV['INFLUXDB_USER'],
+  password: ENV['INFLUXDB_USER_PASSWORD']
+})
+```
 
+## Advanced Usage
+
+* `influxdb_tags`[Array]: This argument specifies [tag-set](https://docs.influxdata.com/influxdb/v1.7/concepts/key_concepts/#tag-set) of series.
+If we need to constantly checkout influxdb logs about specific `controller` or `action`, the best way is to tag both fields to speed up any query on them utilizing `influxdb_tags`:
   ```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: ...})
+  config.logger = InfluxdbLogger::Logger.new(infludb_tags: [:controller, :action], settings: ...)
+  ```
 
+* `tags`[Hash]: If extra fields are required to be sent to influxdb, `tags` could be utilized, e.g., ip info of agents:
+  ```ruby
+  config.logger = InfluxdbLogger::Logger.new(tags: {
+    remote_ip: -> request { request.remote_ip }
+  },  settings: ...)
   ```
+  Passed `tags` can be a `Hash` consisting values of any basic ruby type or a `lambda`. 
 
-* `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(settings: {
-        host: 'influxdb',
-        database: 'rallets',
-        series: series,
-        retry: 3,
-        username: 'user',
-        password: 'password',
-        time_precision: 'ms'
-      })
+* `settings`: Which defines how our `influxdb-logger` connects to influxdb database. Detailed doc about it is here: [influxdb-ruby](https://github.com/influxdata/influxdb-ruby).
+  ```ruby
+  InfluxdbLogger::Logger.new(settings: {
+    host: 'influxdb',
+    retry: 3,
+    time_precision: 'ms',
+    database: ENV['INFLUXDB_DB_NAME'],
+    series: ENV['INFLUXDB_SERIES'],
+    username: ENV['INFLUXDB_USER'],
+    password: ENV['INFLUXDB_USER_PASSWORD']
+  })
   ```
 
 * `batch_size`, `interval`: Since logging is a high frequncy job for any application with large user base in production environment. These two parameters
@@ -64,28 +78,17 @@ Supported parameters for `InfluxdbLogger::Logger.new`:
    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'
-      })
+  InfluxdbLogger::Logger.new(batch_size: 1000, interval: 1000, settings: ...)
   ```
 
 * `async`: Determines whether the logger write asynchronously to influxdb, default to `false`. Read code [here](https://github.com/influxdata/influxdb-ruby/blob/master/lib/influxdb/writer/async.rb#L48) to know how it works.
   ```ruby
-      InfluxdbLogger::Logger.new(async: false, ...)
+  InfluxdbLogger::Logger.new(async: false, settings: ...)
   ```
 
+## License
+
+MIT
 
 ## Contributing
 

data/lib/influxdb-logger/logger.rb

@@ -44,11 +44,11 @@ module InfluxdbLogger
     # Severity label for logging. (max 5 char)
     SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY)
 
-    def self.new(async: true, tags: {}, fields: {}, settings: {}, batch_size: 1000, interval: 1000)
-      all_tags = tags.values + fields.values
-      Rails.application.config.log_tags = all_tags
+    def self.new(influxdb_tags: [], tags: {}, settings: {}, batch_size: 1000, interval: 1000, async: true)
+      log_tags = tags.values
+      Rails.application.config.log_tags = log_tags
       if Rails.application.config.respond_to?(:action_cable)
-        Rails.application.config.action_cable.log_tags = all_tags.map do |x|
+        Rails.application.config.action_cable.log_tags = log_tags.map do |x|
           case
             when x.respond_to?(:call)
               x
@@ -69,8 +69,8 @@ module InfluxdbLogger
       settings[:async] = async
 
       level = SEV_LABEL.index(Rails.application.config.log_level.to_s.upcase)
-      logger = InfluxdbLogger::InnerLogger.new(settings, level, tags, fields)
-      logger = ActiveSupport::TaggedLogging.new(logger)
+      inner_logger = InfluxdbLogger::InnerLogger.new(settings, level, tags, influxdb_tags)
+      logger = ActiveSupport::TaggedLogging.new(inner_logger)
       logger.extend self
     end
 
@@ -100,7 +100,7 @@ module InfluxdbLogger
   end
 
   class InnerLogger < ActiveSupport::Logger
-    def initialize(options, level, tags, fields)
+    def initialize(options, level, initialized_tags, influxdb_tags)
       self.level = level
       @messages_type = (options[:messages_type] || :array).to_sym
       @tag = options[:tag]
@@ -115,15 +115,15 @@ module InfluxdbLogger
       @time_precision = options[:time_precision] || 'ns'
 
       @influxdb_logger = InfluxDB::Client.new(
-        **options.slice(:host, :database, :retry, :username, :password, :async),
+        **options.slice(:host, :port, :database, :retry, :username, :password, :async),
         time_precision: @time_precision,
         discard_write_errors: true
       )
 
+      @influxdb_tags = influxdb_tags
       @severity = 0
       @messages = []
-      @all_tags = tags.merge(fields)
-      @fields = fields
+      @initialized_tags = initialized_tags
       after_initialize if respond_to? :after_initialize
     end
 
@@ -181,19 +181,16 @@ module InfluxdbLogger
             }
         end
 
-      tags = @global_tags.clone
-
       if @tags
-        @all_tags.keys.zip(@tags).each do |k, v|
-          tags[k] = v
+        @initialized_tags.keys.zip(@tags).each do |k, v|
+          values[k] = v
         end
       end
-
       message = {
         series: @series,
         timestamp: Time.now.to_precision(@time_precision),
-        tags: tags.except(@fields.keys),
-        values: values.merge(tags.slice(@fields.keys)).merge({
+        tags: values.slice(*@influxdb_tags).merge(@global_tags),
+        values: values.except(*@influxdb_tags).merge({
           severity: format_severity(@severity)
         }).transform_values {|value|
           case value

data/lib/influxdb-logger/version.rb

@@ -1,3 +1,3 @@
 module InfluxdbLogger
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/spec/logger_spec.rb

@@ -51,6 +51,10 @@ describe InfluxdbLogger::Logger do
 
   let(:series) { 'Request' }
 
+  let(:influxdb_tags) {
+    [:uuid, :foo]
+  }
+
   let(:tags) {
     {
       uuid: :uuid,
@@ -71,7 +75,7 @@ describe InfluxdbLogger::Logger do
   }
 
   let(:logger) {
-    InfluxdbLogger::Logger.new(tags: tags, settings: settings)
+    InfluxdbLogger::Logger.new(influxdb_tags: influxdb_tags, tags: tags, settings: settings)
   }
 
   let(:request) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Rallets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2019-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Influxdb logger