fluent-plugin-logzio 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de65dcc352aca420ba2469b1c31c0c3f135309b7728d501ca1eb27e09259e322
-  data.tar.gz: b92016ff7b59405e6e9d45b24ae87fb0d60d396b06bc6ae81b681991d45a56ea
+  metadata.gz: 1f0dd01a3030ad599d784e84b7e1032c37cd540f7b642ba39aecf87bfa90df9f
+  data.tar.gz: '08e24b873ce51e284fad88609fa4ef81889f2bfb07b45d553b0a1a827d39a401'
 SHA512:
-  metadata.gz: f167bd4d0d6c60612dff909d2490d734808eb07894c7396af321351ae741c8fc9b60193209ff92819a50f74089c4d72f91bf24393e27f74a2da3246fef22d5a3
-  data.tar.gz: ccb0be4ca90d64ac4626adc6efbc05f46fde74bad6b505535c298f6b824a6e4e8d349a21128cddd211c212f730f9501c75b76c5f9c02efed096ea05e44a967de
+  metadata.gz: 2529a44b97de6d8fd2cebee1664b8617531970596237bb4235148beccc1aee8ceebd22cde6cd220846c2289032dc58976777f7bd7e1598732c57b6d0167ccbae
+  data.tar.gz: 8710e58b271bf793d5122df4290a9f15e02219ae45e2321f212956b7632e682a5f03ab0f0c3cdb494156109af3b2e1c2392fbac21623017a70a6597207f8fffc

data/README.md

@@ -70,13 +70,28 @@ This is an **example** only. Your needs in production may vary!
 * **bulk_limit** Limit to the size of the Logz.io upload bulk. Defaults to 1000000 bytes leaving about 24kB for overhead.
 * **bulk_limit_warning_limit** Limit to the size of the Logz.io warning message when a record exceeds bulk_limit to prevent a recursion when Fluent warnings are sent to the Logz.io output.  Defaults to nil (no truncation).
 * **proxy_uri** Your proxy uri. Default is nil. For example: "`my.ip:12345`".
-* **proxy_cert** Your proxy cert. Default is nil
-* **gzip** should the plugin ship the logs in gzip compression. Default is false
+* **proxy_cert** Your proxy cert. Default is nil.
+* **gzip** should the plugin ship the logs in gzip compression. Default is false.
+
+
+## Plugin metrics:
+
+| Metric Name | Description | Type | Example |
+| --- | --- | --- | --- |
+| `logzio_status_codes` | Status codes received from Logz.io | Gauge | `logzio_status_codes{type="logzio_buffered",plugin_id="out_logzio",status_code="500"}` |
 
 
 ## Release Notes
+- **0.2.1**:
+  - Do not retry on 400 and 401. For 400 - try to fix log and resend.
+  - Generate a metric (`logzio_status_codes`) for response codes from Logz.io.
+- **0.2.0**: N/A - version was yanked. Please refer to **0.2.1**.
 - **0.1.0**:
   - Use fluentd's retry instead of retry in code (raise exception on non-2xx response).
+
+<details>
+  <summary markdown="span"> Expand to check old versions </summary>
+
 - 0.0.22: Update gem `net-http-persistent` to 4.x.
 - 0.0.21: Update gem `net-http-persistent` to 3.x.
 - 0.0.20: Support gzip compression
@@ -87,3 +102,5 @@ This is an **example** only. Your needs in production may vary!
 - 0.0.14: Refactor send function to handle more cases, and retry in case of logzio connection failure.
 - 0.0.13: BREAKING - Removed non-buffered version. It's really not efficient, and should just not be used. If you are using this version, you should change to the buffered one.
 - 0.0.12: Catch exception when parsing YAML to ignore (instead of crash) not valid logs.
+
+</details>

data/fluent-plugin-logzio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'fluent-plugin-logzio'
-  s.version     = '0.1.0'
+  s.version     = '0.2.1'
   s.authors     = ['Yury Kotov', 'Roi Rav-Hon', 'Arcadiy Ivanov', 'Miri Bar']
   s.email       = ['bairkan@gmail.com', 'roi@logz.io', 'arcadiy@ivanov.biz', 'miri.ignatiev@logz.io']
   s.homepage    = 'https://github.com/logzio/fluent-plugin-logzio'
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'net-http-persistent', '~> 4.0'
   s.add_runtime_dependency 'fluentd', ['>= 0.14.0', '< 2']
+  s.add_runtime_dependency 'prometheus-client', '>= 2.1.0'
   s.add_development_dependency 'rake', '~> 12.3'
   s.add_development_dependency 'bundler', '~> 1.16'
   s.add_development_dependency 'rspec', '~> 3.7'

data/lib/fluent/plugin/out_logzio_buffered.rb

@@ -6,6 +6,7 @@ require 'stringio'
 module Fluent::Plugin
   class LogzioOutputBuffered < Output
     Fluent::Plugin.register_output('logzio_buffered', self)
+    class RetryableResponse < StandardError; end
 
     helpers :compat_parameters
 
@@ -37,9 +38,23 @@ module Fluent::Plugin
         log.debug "Proxy #{@proxy_cert}"
         ENV['SSL_CERT_FILE'] = @proxy_cert
       end
+      @metric_labels = {
+        type: 'logzio_buffered',
+        plugin_id: 'out_logzio',
+      }
+      @metrics = {
+        status_codes: get_gauge(
+          :logzio_status_codes,
+          'Status codes received from Logz.io', {"status_code":""}),
+      }
 
     end
 
+    def initialize
+      super
+      @registry = ::Prometheus::Client.registry
+    end
+
     def start
       super
       require 'net/http/persistent'
@@ -121,6 +136,25 @@ module Fluent::Plugin
     end
 
     def send_bulk(bulk_records, bulk_size)
+      response = do_post(bulk_records, bulk_size)
+      
+      @metrics[:status_codes].increment(labels: merge_labels({'status_code': response.code.to_s}))
+
+      if not response.code.start_with?('2')
+        if response.code == '400'
+          log.warn "Received #{response.code} from Logzio. Some logs may be malformed or too long. Valid logs were succesfully sent into the system. Will try to proccess and send oversized logs. Response body: #{response.body}"
+          process_code_400(bulk_records, Yajl.load(response.body))
+        elsif response.code == '401'
+          log.error "Received #{response.code} from Logzio. Unauthorized, please check your logs shipping token. Will not retry sending. Response body: #{response.body}"
+        else
+          log.debug "Failed request body: #{post.body}"
+          log.error "Error while sending POST to #{@uri}: #{response.body}"
+          raise RetryableResponse, "Logzio listener returned (#{response.code}) for #{@uri}:  #{response.body}", []
+        end
+      end
+    end
+
+    def do_post(bulk_records, bulk_size)
       log.debug "Sending a bulk of #{bulk_records.size} records, size #{bulk_size}B to Logz.io"
 
       # Setting our request
@@ -136,16 +170,39 @@ module Fluent::Plugin
         response = @http.request @uri, post
         rescue Net::HTTP::Persistent::Error => e
           raise e.cause
+        return response
       end
+    end
 
-      resp_err = response.code.to_s.start_with?('4') || response.code.to_s.start_with?('5')
-
-      if not response.code.start_with?('2')
-        log.debug "Failed request body: #{post.body}"
-        log.error "Error while sending POST to #{@uri}: #{response.body}"
+    def process_code_400(bulk_records, response_body)
+      max_log_field_size_bytes = 32000
+      oversized_logs_counter = response_body['oversizedLines'].to_i
+      new_bulk = []
+      for log_record in bulk_records
+        log.info "Oversized lines: #{oversized_logs_counter}" # todo
+        if oversized_logs_counter == 0
+          log.debug "No malformed lines, breaking"
+          break
+        end
+        new_log = Yajl.load(log_record)
+        msg_size = new_log['message'].size
+        # Handle oversized log:
+        if msg_size >= max_log_field_size_bytes
+          new_log['message'] = new_log['message'][0,  max_log_field_size_bytes - 1]
+          log.debug "new log: #{new_log}"
+          new_bulk.append(Yajl.dump(new_log))
+          oversized_logs_counter -= 1
+        end
+      end
+      if new_bulk.size > 0
+        log.debug "Number of fixed bad logs to send: #{new_bulk.size}"
+        response = do_post(new_bulk, new_bulk.size)
+        if response.code.start_with?('2')
+          log.info "Succesfully sent bad logs"
+        else
+          log.warn "While trying to send fixed bad logs, got #{response.code} from Logz.io, will not try to re-send"
+        end
       end
-
-      raise "Logzio listener returned (#{response.code}) for #{@uri}:  #{response.body}" if resp_err
     end
 
     def compress(string)
@@ -155,5 +212,17 @@ module Fluent::Plugin
       w_gz.close
       wio.string
     end
+
+    def merge_labels(extra_labels= {})
+      @metric_labels.merge extra_labels
+    end
+
+    def get_gauge(name, docstring, extra_labels = {})
+      if @registry.exist?(name)
+        @registry.get(name)
+      else
+        @registry.gauge(name, docstring: docstring, labels: @metric_labels.keys + extra_labels.keys)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-logzio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Yury Kotov
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
@@ -47,6 +47,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement