logstash-output-coralogix 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0059319f6ac7e932acbdb9b7085f03720431abd31b389448a392d9bb9513f201'
+  data.tar.gz: 2f768fe950077bb4e6f57fce260243c3314520c270ee0d01cb64bc5b2e82efc9
+SHA512:
+  metadata.gz: ed1b4d33af3c7cff45583cde7c7c0a65d8c68484342cf2ab0ae46f7d6e11584b9100e701486ed5b610193acbc62dbab8f39e185b09d6d3f97f353f7747f26138
+  data.tar.gz: 7c93152430ddb13861dc8c60b2c1de01896205960653edefc3ec3921dafd2f3a723ca2cf02e2aafe57e5ad01988de0409d0cc76e7c888a1feda701260c9a83f5

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+
+## 1.0.0
+  - Initial release

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* coralogix - 
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'centralized_ruby_logger'

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 2019 Coralogix, Inc.
+
+   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,97 @@
+# Logstash Coralogix Output Plugin
+
+[![gem](https://img.shields.io/gem/v/logstash-output-coralogix.svg?logo=ruby&logoColor=red&style=flat)](https://rubygems.org/gems/logstash-output-coralogix/)
+[![gem downloads](https://img.shields.io/gem/dt/logstash-output-coralogix.svg?style=flat)](https://rubygems.org/gems/logstash-output-coralogix/)
+[![Github license](https://img.shields.io/github/license/coralogix/logstash-output-coralogix.svg?logo=github&style=flat)](https://github.com/coralogix/logstash-output-coralogix/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/coralogix/logstash-output-coralogix.svg?style=flat)](https://github.com/coralogix/logstash-output-coralogix/issues)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/coralogix/logstash-output-coralogix.svg?style=flat)](https://github.com/coralogix/logstash-output-coralogix/pulls)
+[![GitHub contributors](https://img.shields.io/github/contributors/coralogix/logstash-output-coralogix.svg?style=flat)](https://github.com/coralogix/logstash-output-coralogix/graphs/contributors)
+
+Coralogix provides a seamless integration with Logstash, so you can send your logs from anywhere and parse them according to your needs.
+
+## Table of contents
+
+1. Prerequisites
+2. Usage
+3. Installation
+4. Configuration
+
+## Prerequisites
+
+Have Logstash installed, for more information on how to install: https://www.elastic.co/guide/en/logstash/current/installing-logstash.html
+
+## Usage
+
+**Private Key** - A unique ID which represents your company, this Id will be sent to your mail once you register to Coralogix..
+
+**Application Name** - The name of your main application, for example, a company named “SuperData” would probably insert the “SuperData” string parameter or if they want to debug their test environment they might insert the  “SuperData– Test”.
+
+**SubSystem Name** - Your application probably has multiple subsystems, for example: Backend servers, Middleware, Frontend servers etc. in order to help you examine the data you need, inserting the subsystem parameter is vital.
+
+## Installation
+
+```bash
+logstash-plugin install logstash-output-coralogix
+```
+
+If you are not sure where logstash-plugin is located, you can check here:
+
+https://www.elastic.co/guide/en/logstash/current/dir-layout.html
+
+## Configuration
+
+### Common
+
+Open your Logstash configuration file and add Coralogix output (You should configure input plugin depending on your needs, for more information regarding input plugins please refer to: https://www.elastic.co/guide/en/logstash/current/input-plugins.html).
+
+```ruby
+output {
+    coralogix {
+        config_params => {
+            "PRIVATE_KEY" => "YOUR_PRIVATE_KEY"
+            "APP_NAME" => "APP_NAME"
+            "SUB_SYSTEM" => "SUB_NAME"
+        }
+        log_key_name => "message"
+        timestamp_key_name => "@timestamp"
+        is_json => true
+    }
+}
+```
+
+The first key (config_params) is mandatory while the others are optional.
+
+### Application and subsystem name
+
+In case your input stream is a JSON object, you can extract **APP_NAME** and/or **SUB_SYSTEM** from the JSON using the `$` sign. For example, in the below JSON, `$message.system` will extract *nginx* value.
+
+```json
+{
+    "@timestamp": "2017 - 04 - 03 T18: 44: 28.591 Z",
+    "@version": "1",
+    "host": "test-host",
+    "message": {
+        "system": "nginx",
+        "status": "OK",
+        "msg": "Hello from Logstash"
+    }
+}
+```
+
+### Record content
+
+In case your input stream is a JSON object and you don’t want to send the entire JSON, rather just a portion of it, you can write the value of the key you want to send in the `log_key_name`. By default, logstash will send whole record content.
+
+For instance, in the above example, if you write `log_key_name` message then only the value of message key will be sent to Coralogix.
+
+If you want to send the entire message then you can just delete this key.
+
+### Timestamp
+
+Coralogix automatically generates the timestamp based on the log arrival time. If you rather use your own timestamp, use the `timestamp_key_name` to specify your timestamp field, and it will be read from your log.
+
+**Note:** We accepts only logs which are not older than `24 hours`.
+
+### JSON support
+
+In case your raw log message is a JSON object you should set `is_json` key to a **true** value, otherwise you can ignore it.

data/lib/logstash/outputs/coralogix.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+require "json"
+require "date"
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "centralized_ruby_logger"
+
+DEFAULT_APP_NAME = "FAILED_APP_NAME"
+DEFAULT_SUB_SYSTEM = "FAILED_SUB_SYSTEM_NAME"
+
+class LogStash::Outputs::Coralogix < LogStash::Outputs::Base
+  config_name "coralogix"
+  concurrency :shared
+  config :config_params, :validate => :hash, :required => true
+  config :timestamp_key_name, :validate => :string, :required => false
+  config :log_key_name, :validate => :string, :required => false
+  config :is_json, :validate => :boolean, :required => false
+  config :force_compression, :validate => :boolean, :required => false, :default => false
+  config :debug, :validate => :boolean, :required => false, :default => false
+  @configured = false
+
+  public def register
+    configure
+  end
+
+  public def multi_receive(events)
+    events.each do |record|
+      record = record.to_hash
+
+      logger = get_logger(record)
+
+      log_record = log_key_name != nil ? record.fetch(log_key_name, record) : record
+      log_record = is_json ? log_record.to_json : log_record
+      log_record = log_record.to_s.empty? ? record : log_record
+
+      timestamp = record.fetch(timestamp_key_name, nil)
+      if (timestamp.nil?)
+        logger.debug log_record
+      else
+        begin
+          float_timestamp = DateTime.parse(timestamp.to_s).to_time.to_f * 1000
+          logger.debug log_record, nil, timestamp: float_timestamp
+        rescue Exception => e
+          logger.debug log_record
+        end
+      end
+    end
+
+    return 1
+  end
+
+  def version?
+    begin
+      Gem.loaded_specs['logstash-output-coralogix'].version.to_s
+    rescue Exception => e
+      return '1.0.0'
+    end
+  end
+
+  # This method is called before starting.
+  def configure
+    begin
+      @loggers = {}
+      #If config parameters doesn't start with $ then we can configure Coralogix logger now.
+      if !config_params["APP_NAME"].start_with?("$") && !config_params["SUB_SYSTEM"].start_with?("$")
+        @logger = Coralogix::CoralogixLogger.new config_params["PRIVATE_KEY"], config_params["APP_NAME"], config_params["SUB_SYSTEM"], debug, "Logstash (#{version?})", force_compression
+        @configured = true
+      end
+    rescue Exception => e
+      $stderr.write "Failed to configure: #{e}"
+    end
+  end
+
+  def extract record, key, default
+    begin
+      res = record
+      return key unless key.start_with?("$")
+      key[1..-1].split(".").each do |k|
+        res = res.fetch(k, nil)
+        return default if res == nil
+      end
+      return res
+    rescue Exception => e
+      return default
+    end
+  end
+
+
+  def get_app_sub_name(record)
+    app_name = extract(record, config_params["APP_NAME"], DEFAULT_APP_NAME)
+    sub_name = extract(record, config_params["SUB_SYSTEM"], DEFAULT_SUB_SYSTEM)
+    return app_name, sub_name
+  end
+
+  def get_logger(record)
+
+    return @logger if @configured
+
+    app_name, sub_name = get_app_sub_name(record)
+
+    if !@loggers.key?("#{app_name}.#{sub_name}")
+      @loggers["#{app_name}.#{sub_name}"] = Coralogix::CoralogixLogger.new config_params["PRIVATE_KEY"], app_name, sub_name, debug, "Logstash (#{version?})", force_compression
+    end
+
+    return @loggers["#{app_name}.#{sub_name}"]
+  end
+
+end

data/logstash-output-coralogix.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-coralogix'
+  s.version = '1.0.0'
+  s.licenses = ['Apache-2.0']
+  s.summary = 'Deliever the logs to Coralogix service.'
+  s.description = 'This gem is a Logstash output plugin to deliver the logs to Coralogix service.'
+  s.homepage = 'https://coralogix.com/'
+  s.authors = ['Coralogix']
+  s.email = 'info@coralogix.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*', 'spec/**/*', 'vendor/**/*', '*.gemspec', '*.md', 'CONTRIBUTORS', 'Gemfile', 'LICENSE', 'NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = {'logstash_plugin' => 'true', 'logstash_group' => 'output'}
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core-plugin-api', '~> 2.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'centralized_ruby_logger', '>= 0.0.12'
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/outputs/coralogix_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/coralogix_logger"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+file = "samples/logstash.conf"
+@@configuration = String.new
+@@configuration << File.read(file)
+
+
+describe LogStash::Outputs::Coralogix do
+  let(:config) {{'config_params' => {"PRIVATE_KEY" => "9626c7dd-8174-5015-a3fe-5572e042b6d9", "APP_NAME" => "Logstash Tester", "SUB_SYSTEM" => "Logstash subsystem"}}}
+  let(:output) {LogStash::Outputs::Coralogix.new config}
+
+  before do
+    output.register
+  end
+
+  describe "Send message" do
+    records = []
+    records << {"message" => "Hello from Logstash"}
+    subject {output.multi_receive(records)}
+
+    it "returns 1" do
+      expect(subject).to eq(1)
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-coralogix
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Coralogix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: centralized_ruby_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash output plugin to deliver the logs to Coralogix
+  service.
+email: info@coralogix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/coralogix.rb
+- logstash-output-coralogix.gemspec
+- spec/outputs/coralogix_spec.rb
+homepage: https://coralogix.com/
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Deliever the logs to Coralogix service.
+test_files:
+- spec/outputs/coralogix_spec.rb