fluent-plugin-lm-logs 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a4b80a29df39066cf4d0d02dd5d3dd8a409253a9ffac8e2df552aa6d836c8fd
+  data.tar.gz: 80a03e355f4485810f8f591688d2193258a480de797f5b73a627c802ce940a7e
+SHA512:
+  metadata.gz: d4d74839b0bf81fa4b43b79a87015dec5c1c4d15e19e021c966f5c936e1503f55643c7f6902c17cabfd3788701a0f98b6dec6c56903b3ce5aa8c2e9907f11448
+  data.tar.gz: 7ecf5e67a5881154c9f0c5a82d0e824e6cb98bb9b8bf66abbda06bc800ecc2c472f445107bac72996df7bbf2558e4890fe61400f92b84c617c7bb2aaa1795d60

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Misc
+foo/
+*.iml
+.idea/
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Logic Monitor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,62 @@
+
+# lm-logs-fluentd (beta)
+This output plugin sends Fluentd records to the configured LogicMonitor account.
+
+## Prerequisites
+
+Install the plugin:
+* With gem:       `gem install lm-logs-fluentd`
+* For deb packages:       `td-agent-gem install lm-logs-fluentd`
+
+Alternatively, you can add `out_lm.rb` to your Fluentd plugins directory.
+
+## Configure the output plugin
+
+Create a custom `fluent.conf` or edit the existing one to specify which logs should be forwarded to LogicMonitor.
+
+```
+# Match events tagged with "lm.**" and
+# send them to LogicMonitor
+<match lm.**>
+    @type lm
+    company_name <account_name>
+    resource_mapping {"<event_key>": "<lm_property>"}
+    access_id <your_lm_access_id>
+    access_key <your_lm_access_key>
+    flush_interval 1s
+    debug false
+</match>
+```
+
+### Request example
+
+Sending:
+
+`curl -X POST -d 'json={"message":"hello LogicMonitor from fluentd", "event_key":"lm_property_value"}' http://localhost:8888/lm.test`
+
+Returns the event:
+```
+{
+    "message": "hello LogicMonitor from fluentd"
+}
+```
+
+**Note:** Make sure that logs have a message field. Requests sent without a message will not be accepted. 
+
+### Resource mapping examples
+
+- `{"message":"Hey!!", "event_key":"lm_property_value"}` with mapping `{"event_key": "lm_property"}`
+- `{"message":"Hey!!", "a":{"b":{"c":"lm_property_value"}} }` with mapping `{"a.b.c": "lm_property"}`
+- `{"message":"Hey!!", "_lm.resourceId": { "lm_property_name" : "lm_property_value" } }`  this will override resource mapping.
+
+## LogicMonitor properties
+
+| Property | Description |
+| --- | --- |
+| `company_name` | LogicMonitor account name. |
+| `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. |
+| `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. |
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-plugin-lm-logs.gemspec

@@ -0,0 +1,24 @@
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+# This product includes software developed at Logic Monitor (https://www.logicmonitor.com).
+# Copyright 2020 Logic Monitor, Inc.
+
+Gem::Specification.new do |spec|
+  spec.name                           = "fluent-plugin-lm-logs"
+  spec.version                        = '0.0.7'
+  spec.authors                        = ["Logic Monitor"]
+  spec.email                          = "rubygems@logicmonitor.com"
+  spec.summary                        = "Logic Monitor logs fluentd output plugin"
+  spec.description                    = "This output plugin sends fluentd records to the configured LogicMonitor account."
+  spec.homepage                       = "https://www.logicmonitor.com"
+  spec.license                        = "Apache-2.0"
+
+  spec.metadata["source_code_uri"]    = "https://github.com/logicmonitor/lm-logs-fluentd"
+  spec.metadata["documentation_uri"]  = "https://www.rubydoc.info/gems/lm-logs-fluentd"
+
+  spec.files         = [".gitignore", "Gemfile", "LICENSE", "README.md", "Rakefile", "fluent-plugin-lm-logs.gemspec", "lib/fluent/plugin/out_lm.rb"]
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency "fluentd", [">= 1", "< 2"]
+end

data/lib/fluent/plugin/out_lm.rb

@@ -0,0 +1,134 @@
+require 'fluent/output'
+require 'date'
+require 'time'
+require 'uri'
+require 'digest'
+require 'json'
+require 'openssl'
+require "base64"
+require 'net/http'
+require 'net/https'
+
+
+module Fluent
+  class LmOutput < BufferedOutput
+    Fluent::Plugin.register_output('lm', self)
+
+    # 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_key,  :string, :default => "access_key"
+
+    config_param :company_name,  :string, :default => "company_name"
+
+    config_param :resource_mapping,  :hash, :default => {"host": "system.hostname", "hostname": "system.hostname"}
+
+    config_param :debug,  :bool, :default => false
+
+    # This method is called before starting.
+    # 'conf' is a Hash that includes configuration parameters.
+    # If the configuration is invalid, raise Fluent::ConfigError.
+    def configure(conf)
+      super
+    end
+
+    # This method is called when starting.
+    # Open sockets or files here.
+    def start
+      super
+    end
+
+    # This method is called when shutting down.
+    # Shutdown the thread and close sockets or files here.
+    def shutdown
+      super
+    end
+
+    # This method is called when an event reaches to Fluentd.
+    # Convert the event to a raw string.
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    # This method is called every flush interval. Write the buffer chunk
+    # to files or databases here.
+    # 'chunk' is a buffer chunk that includes multiple formatted
+    # events. You can use 'data = chunk.read' to get all events and
+    # 'chunk.open {|io| ... }' to get IO objects.
+    #
+    # NOTE! This method is called by internal thread, not Fluentd's main thread. So IO wait doesn't affect other plugins.
+    def write(chunk)
+      events = []
+      chunk.msgpack_each do |(tag, time, record)|
+        event = process_record(tag,time,record)
+        events.push(event)
+      end
+      send_batch(events)
+    end
+
+    def process_record(tag, time, record)
+      resource_map = {}
+      lm_event = {}
+      lm_event["message"] = record["message"]
+      if record["_lm.resourceId"] == nil
+          @resource_mapping.each do |key, value|
+            k = value
+            nestedVal = record
+            key.to_s.split('.').each { |x| nestedVal = nestedVal[x] }
+            if nestedVal != nil
+              resource_map[k] = nestedVal
+            end
+          end
+        lm_event["_lm.resourceId"] = resource_map
+      else
+        lm_event["_lm.resourceId"] = record["_lm.resourceId"]
+      end
+  
+      lm_event["timestamp"] = Time.at(time).utc.to_datetime.rfc3339
+      return lm_event
+    end
+
+    def send_batch(events)
+      url = "https://#{@company_name}.logicmonitor.com/rest/log/ingest"
+      body = events.to_json
+      uri = URI.parse(url)
+
+      log.info "Sending #{events.length} events to logic monitor at #{url}"
+      
+      if @debug
+        log.info "Request json #{body}"
+      end
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['authorization'] = generate_token(events)
+      request['Content-type'] = "application/json"  
+      request.body = body
+
+      resp = http.request(request)
+      if @debug
+        log.info "Response #{resp.body}"
+      end
+
+      if !resp.kind_of? Net::HTTPSuccess
+        log.error "Error sending batch #{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}"
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-lm-logs
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Logic Monitor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This output plugin sends fluentd records to the configured LogicMonitor
+  account.
+email: rubygems@logicmonitor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-lm-logs.gemspec
+- lib/fluent/plugin/out_lm.rb
+homepage: https://www.logicmonitor.com
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/logicmonitor/lm-logs-fluentd
+  documentation_uri: https://www.rubydoc.info/gems/lm-logs-fluentd
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Logic Monitor logs fluentd output plugin
+test_files: []