logstash-output-lmlogs 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b4784b47b720c638e2f6cb53ace887c3ff3bd821cc27ca675fc3bf6b5b3325
-  data.tar.gz: 2dd4c277e4b769d4580ea1474d00f058d2f08f1d718da6e715c51ab16f722679
+  metadata.gz: a4846f9bbbd52ab6c5f801aa3d6938e7fc58311408588ab3e57adeb12c852b02
+  data.tar.gz: 23239bd62adc2baf7d8340bcfccf5b63b85bf5b30c189420465f66d3b6584d51
 SHA512:
-  metadata.gz: 118161034fbd6b10b946449a75ccabc6fcce733006824711bdbcde2fff864f65ac249bd1de2f78600e975e71f47740881e946c4f2335a82956e6a8b130f44af5
-  data.tar.gz: f28a74d295e3f14bca4bfed4389c5dd32cfaaecb8f5b550168f2542494b0876c50b95d42661d101879284f9a7f532a74551b7fa1989abf83289b046f210e33de
+  metadata.gz: d24e42560a21de68485a601ac2f82e60559269801597756848c4d8d000eace113bc07265e2352f967224f2c43f2abf3f98c47da2855bec8123745429c4e249d8
+  data.tar.gz: b72a1fb18c3bb21d31c6d78d4291b293c272cea084f761f2359edd9d984b3c01a467bef42c76a7dd3821b590fabebbc2cd3b5a260ba94f3377b6b041a9ca1af0

data/CHANGELOG.md

@@ -16,3 +16,5 @@
 - Fix user agent populated in headers
 ## 2.0.0
 - Dont send event metadata by default. Add config include_metadata_keys for including custom metadata
+## 2.0.1
+- Fix incomplete json metadata error.

data/README.md

@@ -15,12 +15,14 @@ Run the following on your Logstash instance
 output {
     lmlogs {
         portal_name => "your company name"
+        portal_domain => "your LM company domain."
         access_id => "your lm access id"
         access_key => "your access key"
     }
 }
 ```
-You would need either `access_id` and `access_id` both or `bearer_token` for authentication with Logicmonitor.
+You would need either `access_id` and `access_id` both or `bearer_token` for authentication with Logicmonitor. 
+The portal_domain is the domain of your LM portal. If not set the default is set to `logicmonitor.com`. Eg if your LM portal URL is `https://test.domain.com`, portal_name should be set to `test` and portal_domain to `domain.com`
 
 
 

data/lib/logstash/outputs/lmlogs.rb

@@ -91,9 +91,13 @@ class LogStash::Outputs::LMLogs < LogStash::Outputs::Base
   # LM Portal Name
   config :portal_name, :validate => :string, :required => true
 
+  # LM Portal Domain. Default will be logicmonitor.com
+  config :portal_domain, :validate => :string, :required => false, :default => "logicmonitor.com"
+
   # Username to use for HTTP auth.
   config :access_id, :validate => :string, :required => false, :default => nil
 
+
   # Include/Exclude metadata from sending to LM Logs
   config :include_metadata, :validate => :boolean, :default => false
 
@@ -121,6 +125,11 @@ class LogStash::Outputs::LMLogs < LogStash::Outputs::Base
                 :size => @@MAX_PAYLOAD_SIZE)
     configure_auth
 
+    # Check if `portal_domain` is an empty string and set the default value
+    if @portal_domain.nil? || @portal_domain.strip.empty?
+      @portal_domain = "logicmonitor.com"
+    end
+
     @final_metadata_keys = Hash.new
     if @include_metadata_keys.any?
       include_metadata_keys.each do | nested_key |
@@ -201,7 +210,7 @@ class LogStash::Outputs::LMLogs < LogStash::Outputs::Base
   def send_batch(events)
     log_debug("Started sending logs to LM: ",
                   :time => Time::now.utc)
-    url = "https://" + @portal_name + ".logicmonitor.com/rest/log/ingest"
+    url = "https://" + @portal_name + "." + @portal_domain +"/rest/log/ingest"
     body = events.to_json
     auth_string = generate_auth_string(body)
     request = client.post(url, {
@@ -298,7 +307,12 @@ class LogStash::Outputs::LMLogs < LogStash::Outputs::Base
     elsif @final_metadata_keys
       @final_metadata_keys.each do | key, value |
         nestedVal = event_json
-        value.each { |x| nestedVal = nestedVal[x] }
+        value.each do |x|
+          if nestedVal == nil
+            break
+          end
+          nestedVal = nestedVal[x]
+        end
         if nestedVal != nil
           lmlogs_event[key] = nestedVal
         end

data/lib/logstash/outputs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LmLogsLogstashPlugin
-  VERSION = '2.0.0'
+  VERSION = '2.0.2'
 end

data/spec/outputs/metadata_spec.rb

@@ -83,4 +83,26 @@ describe LogStash::Outputs::LMLogs do
       puts " hash diff : #{Hashdiff.diff(constructed_event,expected_event)}"
       expect(Hashdiff.diff(constructed_event,expected_event)).to eq([])
     end
+
+    it "Netsted key that doesn not exist should not break" do
+      plugin = create_output_plugin_with_conf({
+        "portal_name" => "localhost",
+        "access_id" => "abcd",
+        "access_key" => "abcd",
+        "lm_property" => "system.hostname",
+        "property_key" => "host",
+        "include_metadata_keys" => %w[nested1.nested2.nestedkey_that_doesnt_exist]
+      })
+      constructed_event = plugin.processEvent(logstash_event)
+      expected_event = {
+        "message" => "hello this is log 1",
+        "timestamp" => logstash_event.timestamp,
+        "_lm.resourceId" => {"system.hostname" => "host1"}
+      }
+      puts " actual : #{constructed_event} \n expected : #{expected_event}"
+      puts " hash diff : #{Hashdiff.diff(constructed_event,expected_event)}"
+      expect(Hashdiff.diff(constructed_event,expected_event)).to eq([])
+    end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-lmlogs
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - LogicMonitor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement