fluent-plugin-dynatrace 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11015b23549401ef5812fbc636a3da5a2dc1ff200fad51a1c972f9d9cf54d2e1
-  data.tar.gz: 87a353d50119fe09e3d11a9ce23f6c20c282b31c4a930dba5336a3c05e95e5f4
+  metadata.gz: b25942088d9fc1e97ab3e9c5ee2cfec5baca12f39744bb09012e5f5238522dd9
+  data.tar.gz: d942be9cfa1215746fcf513a629d09986d5996ba8a0401622b6d0cf5cdf93cf2
 SHA512:
-  metadata.gz: 9d8ea643ef564a15584364fcdb28aabf2118cf145f6d4c82301b7441e7986a9f3c7e7e4f4beb93ccdcc7164f60621b96ad238f56531274f72cf5df84dbd74a19
-  data.tar.gz: cd0ac68b36280801f40da7de3363bb5e0051ff697870fc6cb4390f7100f22dfadf417c0cb6c5be6641fa79f01a8ba5434e01bae21fb43e78bd8d2fb6a81cbd89
+  metadata.gz: 63ca8a3ab6b1e22d7d6e4c29bdcba35e33b145b494f6e736b5cd117feb5af22e647262d0477d9eb72ab316550af2a1469cc7459f0730f3a36fceee79d4834cf0
+  data.tar.gz: 9c9532efc4215183ee632ea51a30c27b630b5a239b9fc548e499446fb2dd819ec6c00753e0b3756d435b8625148b59fa1e2c05ad3579d3de5b909fe1c92aa4f7

data/lib/fluent/plugin/dynatrace_constants.rb

@@ -20,7 +20,7 @@ module Fluent
     class DynatraceOutputConstants
       # The version of the Dynatrace output plugin
       def self.version
-        '0.1.3'
+        '0.2.0'
       end
     end
   end

data/lib/fluent/plugin/out_dynatrace.rb

@@ -24,17 +24,24 @@ module Fluent
     class DynatraceOutput < Output
       Fluent::Plugin.register_output('dynatrace', self)
 
+      HTTP_REQUEST_LOCK = Mutex.new
+
       helpers :compat_parameters # add :inject if need be
 
       # Configurations
       desc 'The full URL of the Dynatrace log ingestion endpoint, e.g. https://my-active-gate.example.com/api/logs/ingest'
       config_param :active_gate_url, :string
-      desc 'The API token to use to authenticate requests to the log ingestion endpoint. Must have TODO scope'
+      desc 'The API token to use to authenticate requests to the log ingestion endpoint. '\
+           'Must have logs.ingest (Ingest Logs) scope. '\
+           'It is recommended to limit scope to only this one.'
       config_param :api_token, :string, secret: true
 
       desc 'Disable SSL validation by setting :verify_mode OpenSSL::SSL::VERIFY_NONE'
       config_param :ssl_verify_none, :bool, default: false
 
+      desc 'Inject timestamp into each log message'
+      config_param :inject_timestamp, :bool, default: false
+
       #############################################
 
       config_section :buffer do
@@ -57,7 +64,10 @@ module Fluent
         compat_parameters_convert(conf, :inject)
         super
 
-        @uri = URI.parse(@active_gate_url)
+        raise Fluent::ConfigError, 'api_token is empty' if @api_token.empty?
+
+        @uri = parse_and_validate_uri(@active_gate_url)
+
         @agent = Net::HTTP.new(@uri.host, @uri.port)
 
         return unless uri.scheme == 'https'
@@ -74,20 +84,29 @@ module Fluent
       #############################################
 
       def process(_tag, es)
+        log.on_trace { log.trace('#process') }
+        records = 0
         # es = inject_values_to_event_stream(tag, es)
-        es.each do |_time, record|
-          send_to_dynatrace("#{record.to_json.chomp}\n")
+        es.each do |time, record|
+          records += 1
+          log.on_trace { log.trace("#process Processing record #{records}") }
+          record['@timestamp'] = time * 1000 if @inject_timestamp
+          synchronized_send_records(record)
         end
+        log.on_trace { log.trace("#process Processed #{records} records") }
       end
 
       def write(chunk)
-        body = []
-        chunk.each do |_time, record|
-          # body.push(inject_values_to_record(chunk.metadata.tag, time, record))
-          body.push(record)
+        log.on_trace { log.trace('#write') }
+        records = []
+        chunk.each do |time, record|
+          # records.push(inject_values_to_record(chunk.metadata.tag, time, record))
+          record['@timestamp'] = time * 1000 if @inject_timestamp
+          records.push(record)
         end
 
-        send_to_dynatrace("#{body.to_json.chomp}\n")
+        log.on_trace { log.trace("#write sent #{records.length} records") }
+        synchronized_send_records(records) unless records.empty?
       end
 
       #############################################
@@ -106,7 +125,8 @@ module Fluent
         "fluent-plugin-dynatrace v#{DynatraceOutputConstants.version}"
       end
 
-      def prepare_request(uri)
+      def prepare_request
+        log.on_trace { log.trace('#prepare_request') }
         req = Net::HTTP::Post.new(uri, { 'User-Agent' => user_agent })
         req['Content-Type'] = 'application/json; charset=utf-8'
         req['Authorization'] = "Api-Token #{@api_token}"
@@ -114,15 +134,37 @@ module Fluent
         req
       end
 
-      def send_to_dynatrace(body)
+      def synchronized_send_records(records)
+        log.on_trace { log.trace('#synchronized_send_records') }
+        HTTP_REQUEST_LOCK.synchronize do
+          send_records(records)
+        end
+      end
+
+      def send_records(records)
+        log.on_trace { log.trace('#send_records') }
+
         agent.start unless agent.started?
 
-        req = prepare_request(@uri)
-        res = @agent.request(req, body)
+        response = send_request(serialize(records))
+
+        return if response.is_a?(Net::HTTPSuccess)
+
+        raise failure_message response
+      end
 
-        return if res.is_a?(Net::HTTPSuccess)
+      def serialize(records)
+        log.on_trace { log.trace('#serialize') }
+        body = "#{records.to_json.chomp}\n"
+        log.on_trace { log.trace("#serialize body length #{body.length}") }
+        body
+      end
 
-        raise failure_message res
+      def send_request(body)
+        log.on_trace { log.trace('#send_request') }
+        response = @agent.request(prepare_request, body)
+        log.on_trace { log.trace("#send_request response #{response}") }
+        response
       end
 
       def failure_message(res)
@@ -134,6 +176,22 @@ module Fluent
 
         "failed to request #{uri} (#{res_summary})"
       end
+
+      #############################################
+
+      private
+
+      def parse_and_validate_uri(uri_string)
+        raise Fluent::ConfigError, 'active_gate_url is empty' if uri_string.empty?
+
+        uri = URI.parse(uri_string)
+        raise Fluent::ConfigError, 'active_gate_url scheme must be http or https' unless
+          %w[http https].include?(uri.scheme)
+
+        raise Fluent::ConfigError, 'active_gate_url must include an authority' if uri.host.nil?
+
+        uri
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-dynatrace
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Dynatrace Open Source Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A fluentd output plugin for sending logs to the Dynatrace Generic log ingest