td-logger 0.3.23 → 0.3.24

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: d56c1c7474afbeaf21ac6d5cb67c92be9e17d0f0
-  data.tar.gz: d896adedf865360212fa5c863a0750a856ac72c4
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzExZTFkZTM1MDlkZDQzYjU3YzI1NGU2NTQwYTA1NzJhMGM2MTYyZg==
+  data.tar.gz: !binary |-
+    MWM3YWYyMmVmNzQyMmIzMTU4YjUyNWFlYWJlNTdlMTFiN2I3OGRhZQ==
 SHA512:
-  metadata.gz: dc7fb69a448f4df5c51b89a95070b2815d32c09290cd072fda2f7eabfcfa536c91e6bf0875f2efdb3bb925bfe7884a5fcc7b19004628a4f35b1d3e67f9dd9058
-  data.tar.gz: 1cf6fbc1329f5545f22e35a628f3d290416cb12a4651b484239c7324e235365e21c24cfb85ad81ac953bce75b2d19cd61c4d2de553d465f436bd9a6d0e2ff5ef
+  metadata.gz: !binary |-
+    MTBiMTQ2ZDEwMTJkY2ZlN2YyMjc0OTExZDYyNWY3NmZlZTMxNTBiYjhjM2Ni
+    MzAzZjM1ZmE5ZGY4ZTcxNTkxOTQwMTJlOWU4YzIyZThjOWExMzQxOTJiYmQ1
+    NzdiZjk4ZDM4MWYwZTE3NTA3Y2QwMWQ3ZjM5OGM5NjQyNzc4NDc=
+  data.tar.gz: !binary |-
+    NzQ4MGUwYWFjOGQxOTgzYzczMThlNTA3NGI1MWRiNWExMThkNDdiZTNiNjlh
+    NzNiYWIyOWFlN2Q4YTU5NDc1Njg1MzBmOTBhMGZjMTI0NzhmY2M3YWVjZmNm
+    ZTYzNWVjM2Y4NDkxZDk2NWZhNDg3MGM1MWEzZDc4OTdhMDM3YjE=

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - ruby-head
+  - rbx
+
+branches:
+  only:
+    - master
+
+gemfile:
+  - Gemfile
+
+script: bundle exec rake spec
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx

data/ChangeLog

@@ -1,3 +1,9 @@
+== 2014-11-18 version 0.3.24
+
+* Pass all option hash's arguments to the td-client library to support
+  switching of API endpoints
+
+
 == 2013-09-20 version 0.3.23
 
 * Add TreasureDataLogger#flush to flush stored events immediatedly

data/README.rdoc

@@ -4,12 +4,12 @@
 
 This gem is a *logging* *library* *for* *Treasure* *Data*. The events logged by this module will be uploaded into the cloud. There're two ways to upload:
 
-* 1) direct upload from applications: app -> cloud (used by default)
-* 2) in-direct upload from td-agent: app -> td-agent -> cloud
+* *direct* *upload* *from* *applications*: app -> cloud. This option is easier to configure and setup, but it requires extra memory in the application processes. The data is logged directly in the Treasure Data Cloud through the REST APIs by leveraging the {Treasure Data Ruby Client (td-client-ruby)}[https://github.com/treasure-data/td-client-ruby] library.
+* *in-direct* *upload* *from* *td-agent*: app -> td-agent -> cloud. This option requires extra steps to install the daemons into your cluster, but lowers the logging impact on your applications. The data is sent to a td-agent running either locally or remotely by leveraging the {Fluentd Ruby Logger (fluent-logger-ruby)}[https://github.com/fluent/fluent-logger-ruby/] library.
 
-(1) is more easy to configure and extra setup, but it requires extra memory in the application processes. (2) requires the extra installation of the daemons into your cluster, but lowers the logging impact to your applications. You can choose whether to use, by config file described laster.
+The actual upload method can be selected in the config file as described below.
 
-== Getting Started
+== Installation
 
 Add the following line to your Gemfile:
 
@@ -19,8 +19,12 @@ For Rails 2.x (not tested) without Bundler,
 edit +environment.rb+ and add to the initalizer block:
 
     config.gem "td-logger"
+    
+== Configuration
+
+=== Direct Upload
 
-And then add +config/treasure_data.yml+ file as followings. This is a template, which is doing the direct upload from the application processes.
+This configuration enables the application to upload the events directly from the application processes (app -> cloud) through the Treasure Data REST APIs. Please add this template +config/treasure_data.yml+ file and set your apikey:
 
     development:
       apikey: "YOUR_API_KEY"
@@ -35,15 +39,45 @@ And then add +config/treasure_data.yml+ file as followings. This is a template,
     # disable logging
     test:
 
+If you would wish to keep your API key as an environment variable, you can use this setting:
+
+      apikey: <% ENV['TD_API_KEY'] %>
+
+Alternatively, one can initialize the Ruby Logger module for direct upload straight from within the application:
+
+    TreasureData::Logger.open('production',
+                              :apikey => "YOUR_API_KEY",
+                              :auto_create_table => true)
+
+The hash key / value pairs specified in the second and following arguments of the 'open' function correspond to the configuration option of the underlying {td-client-ruby Ruby Client}[https://github.com/treasure-data/td-client-ruby#configuration] library.
+
+Refer to the {Ruby SDK documentation}[http://docs.treasuredata.com/articles/ruby-sdk] for more information.
+
+Please note that we recommend to use a write-only API key. To obtain one, please:
+
+1. Login into the Treasure Data Console at http://console.treasuredata.com;
+2. Visit your Profile page at http://console.treasuredata.com/users/current;
+3. Insert your password under the 'API Keys' panel;
+4. In the bottom part of the panel, under 'Write-Only API keys', either copy the API key or click on 'Generate New' and copy the new API key.
+
+=== Indirect Upload
+
+When the 'agent' and 'tag' options are specified, the events are logged into the local td-agent daemon. Later on, the daemon uploads the event periodically to the cloud (app -> td-agent -> cloud).
+
+This requires additional setup steps but lowers the memory and performance impact to your application processes. For the installation process, please look at our {knowledge base}[http://help.treasuredata.com/customer/portal/topics/550539-installing-td-agent/articles] page.
+
+NOTE: This configuration is not supported on PaaS platforms.
+
+    production:
+      agent: "localhost:24224"
+      tag: td.myapp
+      debug_mode: false
+      
 == Logging events
 
 You can log anytime using 'TD.event.post' method:
 
-    class MyClass
-      def mymethod
-        TD.event.post('table_name', {:foo=>:bar})
-      end
-    end
+    TD.event.post('table_name', {:foo=>:bar})
 
 == Rails extension
 
@@ -64,30 +98,6 @@ In rails application, you can use 'TD.event.attribute' to set static attribute t
       end
     end
 
-== Configuration file
-
-=== Direct Upload from Application Buffer
-
-This configuration enables the application to upload the events, directly from the application processes (app -> cloud).
-
-    production:
-      apikey: "YOUR_API_KEY"
-      database: rails_production
-      debug_mode: false
-
-=== In-Direct Upload from td-agent
-
-When 'agent' and 'tag' options are specified, the events are logged into the local td-agent daemon. Later on, the daemon uploads the event periodically to the cloud (app -> td-agent -> cloud).
-
-This requires the additional setup to your infrastructure, but lowers the memory and performance impact to your application processes. For the installation process, please look at our {knowledge base}[http://help.treasure-data.com/kb/installing-td-agent-daemon] page.
-
-NOTE: This configuration is not supported on PaaP platforms.
-
-    production:
-      agent: "localhost:24224"
-      tag: td.myapp
-      debug_mode: false
-
 === Test mode
 
 This mode uses TestLogger of fluent-logger-ruby to store the events.
@@ -105,10 +115,8 @@ You can access the logger instance via TD.logger to check the status.
 
 == Further Readings
 
-If you have any problem, please ask us from the support site.
-
-* {Support Site}[http://help.treasure-data.com/]
-* {Knowledge Base}[http://help.treasure-data.com/kb]
+If you have any problem, please consult the knowledge based and ask us on the support site: 
+{Support Site}[http://help.treasure-data.com].
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.3.23
+0.3.24

data/lib/td/logger/td_logger.rb

@@ -37,14 +37,16 @@ class TreasureDataLogger < Fluent::Logger::LoggerBase
       @logger.level = ::Logger::INFO
     end
 
-    @client = TreasureData::Client.new(apikey, :ssl => !!options[:use_ssl])
+    # translate :use_ssl to :ssl for backwards compatibility
+    options[:ssl] = options[:use_ssl] unless options[:use_ssl].nil?
+    @client = TreasureData::Client.new(apikey, options)
 
     @mutex = Mutex.new
     @cond = ConditionVariable.new
     @map = {}  # (db,table) => buffer:String
     @queue = []
 
-    @chunk_limit = 8*1024*1024
+    @chunk_limit = 8 * 1024 * 1024
     @queue_limit = 50
 
     @flush_interval = 2

data/lib/td/logger/version.rb

@@ -1,7 +1,7 @@
 module TreasureData
 module Logger
 
-VERSION = '0.3.23'
+VERSION = '0.3.24'
 
 end
 end

data/spec/td_logger_spec.rb

@@ -4,41 +4,63 @@ require 'spec_helper'
 describe TreasureData::Logger::TreasureDataLogger do
   context 'init' do
     it 'with apikey' do
-      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_1')
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1')
       td.instance_variable_get(:@client).api.apikey.should == 'test_1'
       td.instance_variable_get(:@client).api.instance_variable_get(:@ssl).should be_false
     end
 
     it 'with apikey and use_ssl' do
-      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_1', :use_ssl => true)
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1', :use_ssl => true)
       td.instance_variable_get(:@client).api.apikey.should == 'test_1'
       td.instance_variable_get(:@client).api.instance_variable_get(:@ssl).should be_true
     end
 
+    it 'with apikey and ssl' do
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1', :ssl => true)
+      td.instance_variable_get(:@client).api.apikey.should == 'test_1'
+      td.instance_variable_get(:@client).api.instance_variable_get(:@ssl).should be_true
+    end
+
+    it 'with apikey and HTTP endpoint' do
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1', :endpoint => "http://idontexi.st")
+      td.instance_variable_get(:@client).api.apikey.should == 'test_1'
+      td.instance_variable_get(:@client).api.instance_variable_get(:@host).should == "idontexi.st"
+      td.instance_variable_get(:@client).api.instance_variable_get(:@port).should == 80
+      td.instance_variable_get(:@client).api.instance_variable_get(:@ssl).should be_false
+    end
+
+    it 'with apikey and HTTPS endpoint' do
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1', :endpoint => "https://idontexi.st")
+      td.instance_variable_get(:@client).api.apikey.should == 'test_1'
+      td.instance_variable_get(:@client).api.instance_variable_get(:@host).should == "idontexi.st"
+      td.instance_variable_get(:@client).api.instance_variable_get(:@port).should == 443
+      td.instance_variable_get(:@client).api.instance_variable_get(:@ssl).should be_true
+    end
+
     it 'db config' do
-      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_1')
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_1')
       time = Time.now
-      td.should_receive(:add).with('db1', 'table1', {:foo=>:bar, :time=>time.to_i})
-      td.post_with_time('table1', {:foo=>:bar}, time)
+      td.should_receive(:add).with('db1', 'table1', {:foo => :bar, :time => time.to_i})
+      td.post_with_time('table1', {:foo => :bar}, time)
     end
 
     it 'fluent-logger-td compat' do
-      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_2')
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_2')
       time = Time.now
-      td.should_receive(:add).with('overwrite', 'table1', {:foo=>:bar, :time=>time.to_i})
-      td.post_with_time('overwrite.table1', {:foo=>:bar}, time)
+      td.should_receive(:add).with('overwrite', 'table1', {:foo => :bar, :time => time.to_i})
+      td.post_with_time('overwrite.table1', {:foo => :bar}, time)
     end
 
     ## TODO this causes real upload
     #it 'success' do
-    #  td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_3')
+    #  td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_3')
     #  td.post('valid', {}).should == true
     #end
   end
 
   context 'validate' do
     it 'validate table name' do
-      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey=>'test_4')
+      td = TreasureData::Logger::TreasureDataLogger.new('db1', :apikey => 'test_4')
       proc {
         td.post('invalid-name', {})
       }.should raise_error(RuntimeError)
@@ -51,7 +73,7 @@ describe TreasureData::Logger::TreasureDataLogger do
     end
 
     it 'validate database name' do
-      td = TreasureData::Logger::TreasureDataLogger.new('invalid-db-name', :apikey=>'test_5')
+      td = TreasureData::Logger::TreasureDataLogger.new('invalid-db-name', :apikey => 'test_5')
       proc {
         td.post('table', {})
       }.should raise_error(RuntimeError)

data/td-logger.gemspec

@@ -22,7 +22,7 @@ EOF
   gem.authors     = ["Sadayuki Furuhashi"]
   #gem.email       = %q{frsyuki@gmail.com}
   #gem.homepage    = %q{https://github.com/treasure-data/td-logger-ruby}
-  gem.description = %q{Treasure Data logging library for Rails}
+  gem.description = %q{Treasure Data logging library}
   gem.summary     = gem.description
 
   gem.files         = `git ls-files`.split("\n")
@@ -31,8 +31,8 @@ EOF
   gem.require_paths = ['lib']
 
   gem.add_dependency "msgpack", [">= 0.4.4", "!= 0.5.0", "!= 0.5.1", "!= 0.5.2", "!= 0.5.3", "< 0.6.0"]
-  gem.add_dependency "td-client", "~> 0.8.51"
-  gem.add_dependency "fluent-logger", "~> 0.4.6"
+  gem.add_dependency "td-client", "~> 0.8.66"
+  gem.add_dependency "fluent-logger", "~> 0.4.9"
   gem.add_development_dependency 'rake', '>= 0.9.2'
   gem.add_development_dependency 'rspec', '>= 2.7.0'
 end

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: td-logger
 version: !ruby/object:Gem::Version
-  version: 0.3.23
+  version: 0.3.24
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.4
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.0
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.1
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.2
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.3
     - - <
@@ -36,19 +36,19 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.4
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.0
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.1
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.2
-    - - '!='
+    - - ! '!='
       - !ruby/object:Gem::Version
         version: 0.5.3
     - - <
@@ -60,63 +60,64 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.51
+        version: 0.8.66
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.51
+        version: 0.8.66
 - !ruby/object:Gem::Dependency
   name: fluent-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 0.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.7.0
-description: Treasure Data logging library for Rails
+description: Treasure Data logging library
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - ChangeLog
 - Gemfile
 - README.rdoc
@@ -147,20 +148,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Treasure Data logging library for Rails
+summary: Treasure Data logging library
 test_files:
 - spec/event_spec.rb
 - spec/rails_config_spec.rb