fluent-plugin-lm-logs 1.0.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7c2e1fc4c9c42e768327c9dead6b9eaa9f8a77b44ea7697b51306617e2702a
-  data.tar.gz: 4aee4bdb365b8c7efd52c2aa33ed8d5b0f83cb3ca7e551986062721b33faea24
+  metadata.gz: 9029af24ba774f88379606844f5faabf062c5bfe4df7f47386dccd72ceb62217
+  data.tar.gz: e2418db14714305e3cec4103255d9ee86a28b2abfdecceb35ec2976b0b78858d
 SHA512:
-  metadata.gz: f96d200ceb54255e82e09248179b442032c96a1f6bf28efeb410a8a5b4f9423ad5c08815f71cc9a47b2f03c9bbaeef258cdfe52b435b168e65cdaa0bb832adbd
-  data.tar.gz: 8dbfcce551188386379bb479021e24dc8b027f6edba4fd0f87ef17ef4eda1535010a0eaf5ca973fda304cfed339a4b0e53306e9fda012336686cc70c75d5b868
+  metadata.gz: f63f0f6a27956cbd08bc8272fcbaebd50f93fd2338b4f17ea9480f2ab35579b86078a8d422476e235dbf6c8e3e014c022158bca72ce6e621399f6d724db95ed0
+  data.tar.gz: 3abdc791dceb1d87407004537ad6f4ec1e40bf730aea9680f4124846d6eb506c9e14817a57a7da8c26af2b01894a9f8353489ad2d6ecfbf6297972f93a028f84

data/README.md

@@ -66,6 +66,7 @@ See the [LogicMonitor Helm repository](https://github.com/logicmonitor/k8s-helm-
 | `resource_mapping` | The mapping that defines the source of the log event to the LM resource. In this case, the `<event_key>` in the incoming event is mapped to the value of `<lm_property>`.|
 | `access_id` | LM API Token access ID. |
 | `access_key` | LM API Token access key. |
+| `bearer_token` | LM API Bearer Token. Either specify `access_id` and `access_key` both or `bearer_token`. If all specified, LMv1 token(`access_id` and `access_key`) will be used for authentication with Logicmonitor.   |
 | `flush_interval` | Defines the time in seconds to wait before sending batches of logs to LogicMonitor. Default is `60s`. |
 | `debug` | When `true`, logs more information to the fluentd console. |
 | `force_encoding` | Specify charset when logs contains invalid utf-8 characters. |

data/lib/fluent/plugin/out_lm.rb

@@ -25,9 +25,9 @@ module Fluent
 
     # config_param defines a parameter. You can refer a parameter via @path instance variable
 
-    config_param :access_id,  :string, :default => "access_id"
+    config_param :access_id,  :string, :default => nil
 
-    config_param :access_key,  :string, :default => "access_key"
+    config_param :access_key,  :string, :default => nil, secret: true
 
     config_param :company_name,  :string, :default => "company_name"
 
@@ -36,7 +36,7 @@ module Fluent
     config_param :debug,  :bool, :default => false
 
     config_param :include_metadata,  :bool, :default => false
-		
+
     config_param :force_encoding,  :string, :default => ""
 
     config_param :compression,  :string, :default => ""
@@ -48,7 +48,10 @@ module Fluent
     config_param :device_less_logs,  :bool, :default => false
 
     config_param :http_proxy,   :string, :default => nil
-  
+
+    # Use bearer token for auth.
+    config_param :bearer_token, :string, :default => nil, secret: true
+
     # This method is called before starting.
     # 'conf' is a Hash that includes configuration parameters.
     # If the configuration is invalid, raise Fluent::ConfigError.
@@ -56,10 +59,15 @@ module Fluent
       super
     end
 
+    def multi_workers_ready?
+      true
+    end
+
     # This method is called when starting.
     # Open sockets or files here.
     def start
       super
+      configure_auth
       proxy_uri = :ENV
       if @http_proxy
         proxy_uri = URI.parse(http_proxy)
@@ -73,6 +81,17 @@ module Fluent
       @uri = URI.parse(@url)
     end
 
+    def configure_auth
+      @use_bearer_instead_of_lmv1 = false
+      if @access_id == nil || @access_key == nil
+        log.info "Access Id or access key null. Using bearer token for authentication."
+        @use_bearer_instead_of_lmv1 = true
+      end
+      if @use_bearer_instead_of_lmv1 && @bearer_token == nil
+        log.error "Bearer token not specified. Either access_id and access_key both or bearer_token must be specified for authentication with Logicmonitor."
+        raise ArgumentError, 'No valid authentication specified. Either access_id and access_key both or bearer_token must be specified for authentication with Logicmonitor.'
+      end
+    end
     # This method is called when shutting down.
     # Shutdown the thread and close sockets or files here.
     def shutdown
@@ -135,7 +154,7 @@ module Fluent
         else
           lm_event[DEVICELESS_KEY_SERVICE] = encode_if_necessary(record[DEVICELESS_KEY_SERVICE])
           if record[DEVICELESS_KEY_NAMESPACE]!=nil
-            lm_event[DEVICELESS_KEY_NAMESPACE] = encode_if_necessary(record[DEVICELESS_KEY_NAMESPACE]) 
+            lm_event[DEVICELESS_KEY_NAMESPACE] = encode_if_necessary(record[DEVICELESS_KEY_NAMESPACE])
           end
         end
       end
@@ -152,13 +171,13 @@ module Fluent
     end
 
     def get_metadata(record)
-      #if encoding is not defined we will skip going through each key val 
+      #if encoding is not defined we will skip going through each key val
       #and return the whole record for performance reasons in case of a bulky record.
-      if @force_encoding == "" 
+      if @force_encoding == ""
         return record
       else
         lm_event = {}
-        record.each do |key, value| 
+        record.each do |key, value|
           lm_event["#{key}"] = get_encoded_string(value)
         end
         return lm_event
@@ -179,7 +198,7 @@ module Fluent
 
     def send_batch(events)
       body = events.to_json
-      
+
       if @debug
         log.info "Sending #{events.length} events to logic monitor at #{@url}"
         log.info "Request json #{body}"
@@ -203,22 +222,27 @@ module Fluent
       end
 
       resp = @http_client.request @uri, request
-      if @debug || resp.kind_of?(Net::HTTPMultiStatus) || !resp.kind_of?(Net::HTTPSuccess) 
+      if @debug || resp.kind_of?(Net::HTTPMultiStatus) || !resp.kind_of?(Net::HTTPSuccess)
         log.info "Status code:#{resp.code} Request Id:#{resp.header['x-request-id']} message:#{resp.body}"
       end
     end
 
 
     def generate_token(events)
-      timestamp = DateTime.now.strftime('%Q')
-      signature = Base64.strict_encode64(
-          OpenSSL::HMAC.hexdigest(
-              OpenSSL::Digest.new('sha256'),
-              @access_key,
-              "POST#{timestamp}#{events.to_json}/log/ingest"
-          )
-      )
-      "LMv1 #{@access_id}:#{signature}:#{timestamp}"
+
+      if @use_bearer_instead_of_lmv1
+        return "Bearer #{@bearer_token}"
+      else
+        timestamp = DateTime.now.strftime('%Q')
+        signature = Base64.strict_encode64(
+            OpenSSL::HMAC.hexdigest(
+                OpenSSL::Digest.new('sha256'),
+                @access_key,
+                "POST#{timestamp}#{events.to_json}/log/ingest"
+            )
+        )
+        return "LMv1 #{@access_id}:#{signature}:#{timestamp}"
+      end
     end
   end
-end
+end

data/lib/fluent/plugin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LmLogsFluentPlugin
-    VERSION = '1.0.6'
-end
+    VERSION = '1.2.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-lm-logs
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.2.0
 platform: ruby
 authors:
 - LogicMonitor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd