logstash-output-monasca_log_api 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574bed4eaf7960e5e102494e439fe7433582f50e
-  data.tar.gz: 3be5356921f6b101be710c2a7eaa057dad41a219
+  metadata.gz: 6a68c60ae2810a248afe5944379274a1ebe442ac
+  data.tar.gz: 666e18514a756959708cf727373e21b415588a5e
 SHA512:
-  metadata.gz: 847120ddd6fc6a12c87ef8e8828fdfeb54e32e34d458735df35aad317d85b16fe9bf4b5c45f44fa632b8b04dc15047d4497301d5d8741a9405221954f9afb217
-  data.tar.gz: e369ab34daa398a122bddc9e099ee2e1c782e2321f85441849ca5829c37aaf0af598de7007985bd990715e8c63206f4131759c680d972d9d4d5d8226fdbbefde
+  metadata.gz: 5ac12f96dc455cecebd155d49e37b11ed2b7732c30a4007cb7b9bfddf22e1a0bdb471ebdaa4c1d9515ca45cca7cef28225c2257d3321593145c0b6fca7c91960
+  data.tar.gz: c5c244d3443176affc74014bcd0003380347bfd514756cbf6bbb9ce1e7a7c7f77b8e8e5a730ea421cbd6cb1b4c70ee9a02de8dd7617d7824782198b692b534b1

data/README.md

@@ -109,7 +109,7 @@ bin/plugin install --no-verify
 ```
 
 Verify installed plugins:
-With ``bin/plugin list`` you can check installed plugins. There should be ``logstash-output-monasca_log_api``.
+With ``bin/plugin list --verbose`` you can check installed plugins. There should be ``logstash-output-monasca_log_api``.
 
 ## Start logstash output plugin
 

data/lib/logstash/outputs/keystone/token.rb

@@ -28,11 +28,11 @@ module LogStash::Outputs
         token = @keystone_client
           .authenticate(username, user_domain_name, password, project_name, project_domain_name)
         set_token(token[:token], token[:expires_at])
-        @logger.info("New token requested")
+        @logger.info('New token requested')
         @logger.debug("token=#{@id}, expire_at=#{@expires_at}")
       end
 
-      def set_token id, expires_at
+      def set_token(id, expires_at)
         @id = id
         @expires_at = expires_at
       end
@@ -49,12 +49,11 @@ module LogStash::Outputs
       def valid?
         token_valid = true
         now = DateTime.now + Rational(1, 1440)
-        if @id.nil? or now >= @expires_at
+        if @id.nil? || now >= @expires_at
           token_valid = false
         end
         token_valid
       end
-
     end
   end
 end

data/lib/logstash/outputs/monasca/monasca_log_api_client.rb

@@ -23,7 +23,7 @@ module LogStash::Outputs
   module Monasca
     class MonascaLogApiClient
 
-      def initialize(url, insecure=false)
+      def initialize(url, insecure = false)
         @logger = Cabin::Channel.get(LogStash)
         @uri = URI.parse(url)
         @http = Net::HTTP.new(@uri.host, @uri.port)
@@ -34,17 +34,12 @@ module LogStash::Outputs
       end
 
       def send_logs(logs, auth_token)
-        begin
-          post_header = {
-              'X-Auth-Token' => auth_token,
-              'Content-Type' => 'application/json',
-          }
-          response = request('/logs', post_header, logs.to_json)
-          handle_response(response)
-        rescue => e
-          @logger.warn('Sending event to monasca-log-api threw exception',
-            :exceptionew => e)
-        end
+        post_header = {
+          'X-Auth-Token' => auth_token,
+          'Content-Type' => 'application/json',
+        }
+        response = request('/logs', post_header, logs.to_json)
+        handle_response(response)
       end
 
       private
@@ -56,16 +51,20 @@ module LogStash::Outputs
         @http.request(post_request)
       end
 
+      class InvalidTokenError < StandardError; end
+
       def handle_response(response)
         case response
         when Net::HTTPNoContent
-          @logger.debug("Successfully sent logs")
+          @logger.debug('Successfully sent logs')
+        when Net::HTTPUnauthorized # HTTP code: 401
+          @logger.warn("Invalid token. Response=#{response}")
+          raise InvalidTokenError, "Invalid token. Response=#{response}"
         else
           # TODO: Handle logs which could not be sent
           @logger.error("Failed to send logs. Response=#{response}")
         end
       end
-
     end
   end
 end

data/lib/logstash/outputs/monasca_log_api.rb

@@ -102,7 +102,7 @@ class LogStash::Outputs::MonascaLogApi < LogStash::Outputs::Base
 
     # if new log would exceed the bytesize then send logs without the new log
     if @logs[JSON_LOGS] and (logs_bytesize + log_bytesize) > max_data_size_kb
-      @logger.debug("bytesize reached. Sending logs")
+      @logger.debug('bytesize reached. Sending logs')
       @mutex.synchronize do
         send_logs
         add_log log
@@ -112,7 +112,7 @@ class LogStash::Outputs::MonascaLogApi < LogStash::Outputs::Base
     # if the new log would reach the maximum bytesize or the maximum allowed
     # number of sendable logs is reached
     elsif @logs[JSON_LOGS] and (@logs[JSON_LOGS].size + 1 >= num_of_logs)
-      @logger.debug("bytesize or maximum number of logs reached. Sending logs")
+      @logger.debug('bytesize or maximum number of logs reached. Sending logs')
       @mutex.synchronize do
         add_log log
         send_logs
@@ -135,7 +135,7 @@ class LogStash::Outputs::MonascaLogApi < LogStash::Outputs::Base
       event.to_hash['dimensions']
     type = event.to_hash['type'] if event.to_hash['type']
 
-    log = { "message" => message, "dimensions" => { "path" => path }}
+    log = { 'message' => message, 'dimensions' => { 'path' => path }}
     log[JSON_DIMS]['type'] = type if type
     if local_dims
       begin
@@ -178,7 +178,7 @@ class LogStash::Outputs::MonascaLogApi < LogStash::Outputs::Base
 
           if @logs[JSON_LOGS] and (@logs[JSON_LOGS].size > 0) and
             ((Time.now - @start_time) >= elapsed_time_sec)
-            @logger.debug("Time elapsed. Sending logs")
+            @logger.debug('Time elapsed. Sending logs')
             @mutex.synchronize do
               send_logs
             end
@@ -200,17 +200,37 @@ class LogStash::Outputs::MonascaLogApi < LogStash::Outputs::Base
   end
 
   def send_logs
-    if @logs[JSON_LOGS] and @logs[JSON_LOGS].size > 0
+    if @logs[JSON_LOGS] && !@logs[JSON_LOGS].empty?
       check_token
-      token_id = LogStash::Outputs::Keystone::Token.instance.id
+      token = LogStash::Outputs::Keystone::Token.instance
       @logger.debug("Sending #{@logs[JSON_LOGS].size} logs")
-      @monasca_log_api_client.send_logs(@logs, token_id)
+      retry_tries = 5
+      begin
+        tries ||= retry_tries
+        @monasca_log_api_client.send_logs(@logs, token.id)
+      rescue LogStash::Outputs::Monasca::MonascaLogApiClient::InvalidTokenError => e
+        tries -= 1
+        if tries > 0
+          @logger.info("Unauthorized: #{e}. Requesting new token.")
+          token.request_new_token(
+            username, user_domain_name, password,
+            project_name, project_domain_name
+          )
+          retry
+        else
+          @logger.error("Unauthorized: #{e}. Requesting new token failed "\
+                        "after #{retry_tries} retries.")
+        end
+      rescue => e
+        @logger.error('Sending event to monasca-log-api threw exception',
+                      :exceptionew => e)
+      end
       @logs.clear
       initialize_logs_object
     end
   end
 
-  def add_log log
+  def add_log(log)
     @logs[JSON_LOGS].push(log)
     if @logs[JSON_LOGS].size == 1
       @start_time = Time.now

data/logstash-output-monasca_log_api.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-monasca_log_api'
-  s.version = '0.5.1'
-  s.licenses = ['Apache License 2.0']
+  s.version = '0.5.2'
+  s.licenses = ['Apache-2.0']
   s.summary = 'This gem is a logstash output plugin to connect via http to monasca-log-api.'
   s.description = 'This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program'
   s.authors = ['Fujitsu Enabling Software Technology GmbH']

data/spec/outputs/monasca/monasca_log_api_client_spec.rb

@@ -102,12 +102,14 @@ describe LogStash::Outputs::Monasca::MonascaLogApiClient do
       expect_any_instance_of(Cabin::Channel).to receive(:error)
 
       stub_request(:post, monasca_log_api_url_post)
-        .with(:headers => {
-          'Accept'=>'*/*',
-          'Content-Type'=>'application/json',
-          'User-Agent'=>'Ruby',
-          'X-Auth-Token'=>'f8cdafb7dce94444ad781a53ddaff693'})
-        .to_return(:status => 401)
+        .with(:headers =>
+        {
+          'Accept' => '*/*',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Ruby',
+          'X-Auth-Token' => 'f8cdafb7dce94444ad781a53ddaff693'
+        })
+        .to_return(:status => 410)
 
       client = LogStash::Outputs::Monasca::MonascaLogApiClient
         .new(monasca_log_api_url)
@@ -116,17 +118,26 @@ describe LogStash::Outputs::Monasca::MonascaLogApiClient do
     end
   end
 
-  context 'when request throws an exception' do
-    it 'rescued the exception and logs a failure' do
+  context 'when request failed with 401' do
+    it 'logs a warning and throw an exception' do
       expect_any_instance_of(Cabin::Channel).to receive(:warn)
 
       stub_request(:post, monasca_log_api_url_post)
-        .to_raise(Errno::ECONNREFUSED)
+        .with(:headers =>
+        {
+          'Accept' => '*/*',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Ruby',
+          'X-Auth-Token' => 'f8cdafb7dce94444ad781a53ddaff693'
+        })
+        .to_return(:status => 401)
 
       client = LogStash::Outputs::Monasca::MonascaLogApiClient
         .new(monasca_log_api_url)
-      client.send_logs(logs, token)
+
+      expect { client.send_logs(logs, token) }.to raise_error(
+        LogStash::Outputs::Monasca::MonascaLogApiClient::InvalidTokenError
+      )
     end
   end
-
 end

data/spec/outputs/monasca_log_api_spec.rb

@@ -108,6 +108,7 @@ describe 'outputs/monasca_log_api' do
   let (:password) { 'qweqwe' }
 
   let (:monasca_log_api_url) { 'http://192.168.10.4:5607/v3.0' }
+  let (:monasca_log_api_url_post) { monasca_log_api_url + "/logs" }
   let (:keystone_api_url) { 'http://192.168.10.5:5000/v3' }
 
   let (:complete_config) {
@@ -180,8 +181,8 @@ describe 'outputs/monasca_log_api' do
 
   let (:valid_date) { DateTime.now + Rational(5, 1440) }
   let (:expired_date) { DateTime.now - Rational(5, 1440) }
-  let (:token_id) { "f8cdafb7dce94444ad781a53ddaff693" }
-  let (:old_token_id) { "553ae6ea7d074f00a12750e4aa1dad50" }
+  let (:token_id) { 'f8cdafb7dce94444ad781a53ddaff693' }
+  let (:old_token_id) { '553ae6ea7d074f00a12750e4aa1dad50' }
 
   let (:valid_token) { {:token => token_id,
     :expires_at => valid_date } }
@@ -374,9 +375,11 @@ describe 'outputs/monasca_log_api' do
       monasca_log_api.multi_receive([event_without_dims])
 
       expect(monasca_log_api.instance_variable_get(:@logs)['logs'])
-        .to eq([{"message"=>"A graceful shutdown.",
-          "dimensions"=>{"path"=>"/opt/logstash-2.2.0/test.log",
-            "type"=>"test-type"}}])
+        .to eq([{ 'message' => 'A graceful shutdown.',
+                  'dimensions' => {
+                    'path' => '/opt/logstash-2.2.0/test.log',
+                    'type' => 'test-type' }
+                }])
     end
 
     it 'with one dimensions' do
@@ -390,9 +393,12 @@ describe 'outputs/monasca_log_api' do
       monasca_log_api.multi_receive([event_with_one_dim])
 
       expect(monasca_log_api.instance_variable_get(:@logs)['logs'])
-        .to eq([{"message"=>"A graceful shutdown.",
-          "dimensions"=>{"path"=>"/opt/logstash-2.2.0/test.log",
-            "type"=>"test-type", "service"=>"nova"}}])
+        .to eq([{ 'message' => 'A graceful shutdown.',
+                  'dimensions' => {
+                    'path' => '/opt/logstash-2.2.0/test.log',
+                    'type' => 'test-type',
+                    'service' => 'nova' }
+                }])
     end
 
     it 'with more dimensions' do
@@ -406,9 +412,30 @@ describe 'outputs/monasca_log_api' do
       monasca_log_api.multi_receive([event_with_more_dims])
 
       expect(monasca_log_api.instance_variable_get(:@logs)['logs'])
-        .to eq([{"message"=>"A graceful shutdown.",
-          "dimensions"=>{"path"=>"/opt/logstash-2.2.0/test.log",
-            "type"=>"test-type", "service"=>"nova", "priority"=>"high"}}])
+        .to eq([{ 'message' => 'A graceful shutdown.',
+                  'dimensions' => {
+                    'path' => '/opt/logstash-2.2.0/test.log',
+                    'type' => 'test-type',
+                    'service' => 'nova',
+                    'priority' => 'high' }
+                }])
+    end
+  end
+
+  context 'when sending logs raise exception' do
+    it 'logs a failure' do
+      expect_any_instance_of(Cabin::Channel).to receive(:error)
+
+      monasca_log_api = LogStash::Outputs::MonascaLogApi.new(complete_config)
+      expect_any_instance_of(LogStash::Outputs::Monasca::MonascaLogApiClient)
+        .to receive(:send_logs)
+        .and_raise(Errno::ETIMEDOUT)
+      expect_any_instance_of(LogStash::Outputs::Keystone::KeystoneClient)
+        .to receive(:authenticate).and_return(valid_token)
+
+      monasca_log_api.register
+      monasca_log_api.multi_receive([event, event])
+      expect { monasca_log_api.multi_receive([event]) }.to_not raise_error
     end
   end
 
@@ -439,7 +466,8 @@ describe 'outputs/monasca_log_api' do
       expect_any_instance_of(LogStash::Outputs::Monasca::MonascaLogApiClient)
         .to receive(:send_logs)
       expect_any_instance_of(LogStash::Outputs::Keystone::KeystoneClient)
-        .to receive(:authenticate).with(complete_config['username'],
+        .to receive(:authenticate).with(
+          complete_config['username'],
           complete_config['user_domain_name'],
           complete_config['password'],
           complete_config['project_name'],
@@ -452,6 +480,42 @@ describe 'outputs/monasca_log_api' do
       monasca_log_api.multi_receive([event, event, event])
       expect(LogStash::Outputs::Keystone::Token.instance.id).to eq(token_id)
     end
+
+    it 'if unauthorized, renew it' do
+      stub_request(:post, monasca_log_api_url_post)
+        .with(:headers =>
+        {
+          'Accept' => '*/*',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Ruby',
+          'X-Auth-Token' => 'f8cdafb7dce94444ad781a53ddaff693'
+        })
+        .to_return(:status => 401)
+
+      expect_any_instance_of(LogStash::Outputs::Monasca::MonascaLogApiClient)
+        .to receive(:handle_response).exactly(5).times
+        .and_raise(
+          LogStash::Outputs::Monasca::MonascaLogApiClient::InvalidTokenError
+        )
+
+      expect_any_instance_of(LogStash::Outputs::Keystone::KeystoneClient)
+        .to receive(:authenticate).exactly(6).times
+        .with(
+          complete_config['username'],
+          complete_config['user_domain_name'],
+          complete_config['password'],
+          complete_config['project_name'],
+          complete_config['project_domain_name']
+        )
+        .and_return(expired_token, valid_token)
+
+      monasca_log_api = LogStash::Outputs::MonascaLogApi.new(complete_config)
+      allow(monasca_log_api).to receive(:start_time_check)
+      monasca_log_api.register
+      expect(LogStash::Outputs::Keystone::Token.instance.id).to eq(old_token_id)
+      monasca_log_api.multi_receive([event, event, event])
+      expect(LogStash::Outputs::Keystone::Token.instance.id).to eq(token_id)
+    end
   end
 
   context 'when stopping plugin' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-monasca_log_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Fujitsu Enabling Software Technology GmbH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -143,7 +143,7 @@ files:
 - spec/outputs/spec_helper.rb
 homepage: https://github.com/FujitsuEnablingSoftwareTechnologyGmbH/logstash-output-monasca_api
 licenses:
-- Apache License 2.0
+- Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: output