logstash-output-cls 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2538cd3ec494899e7559c372f8ae4401cdfc80ffaf4224720b0727b2fb6440b5
+  data.tar.gz: 1392e475a09e4fe975a840314017d0a3a2e5106a134f7549d421c5df8a1d6af0
+SHA512:
+  metadata.gz: 721a36cdc78c3358db426da1382021fc6c670e703a07137f3bf4bd16ba5d6a36b0aa3e950857fc2ad7df131a03d78ed59753ccd2658b65e51ad1e65c03b0a22f
+  data.tar.gz: 78be5be829901fc5af6df8f0a986698027ca3075ed68e9ce84207210b7d83e0578fe68e0177aa80b09877604033a6fca98e012f0764dbed791a9508ff5f8e02e

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+       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 [yyyy] [name of copyright owner]
+
+   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,53 @@
+### Documentation
+日志服务cls logtash sdk
+
+
+### Install the plugin
+you can build the gem and install it using:
+Install the plugin from the Logstash home
+
+```
+logstash-plugin install logstash-output-cls
+```
+
+Start Logstash
+
+```
+logstash -f logstash-sample.conf
+```
+
+#Usage
+
+```
+input {
+}
+
+filter {
+}
+
+output {
+  cls{
+     endpoint  => "[CLS数据接入域名]"
+     topic_id  => "[日志主题id]"
+     access_key_id     => ""
+     access_key_secret => ""
+  }
+}
+
+```
+
+###Logstash Logservice Input Configuration Options
+
+Configuration	Type	Required	Comments
+endpoint	string	true	Your project endpoint
+access_id	string	true	Your access id
+access_key	string	true	Your access key
+topic_id	string	true	Your topic id
+
+
+
+# Latest Release 
+
+* RubyGems: [logstash-output-cls 0.1.5](https://rubygems.org/gems/logstash-output-cls)
+* Tested on: Logstash 6.4.3
+* OS supported: mac 10.14.1, windows 7, Linux (CentOS 7)

data/lib/logstash/outputs/cls.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/environment"
+require "stud/buffer"
+require 'socket'
+require "java"
+require 'json'
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+LogStash::Environment.load_runtime_jars! File.join(root_dir, "vendor")
+
+class LogStash::Outputs::Cls < LogStash::Outputs::Base
+  include Stud::Buffer
+
+  config_name "cls"
+
+  # tencent cloud log service config, 
+  config :endpoint, :validate => :string, :required => true
+  config :topic_id, :validate=> :string, :required=> true
+  # if source is null, will set ip default
+  config :source, :validate=> :string, :required=> false, :default=> ""
+
+  # access_key_id/access_key_secret created by account of tencent cloud
+  config :access_key_id, :validate=> :string, :required=> true
+  config :access_key_secret, :validate=> :string, :required=> true
+
+  # default 4000 logs in a logGroup for batch send
+  config :max_buffer_items, :validate=> :number, :required=> false, :default=> 4096
+  # default 2*1024*1024 Bytes in a logGroup for batch send
+  config :max_buffer_bytes, :validate=> :number, :required=> false, :default=> 2097152
+  # for batch send, logGroup will emit in default 3 seconds
+  config :max_buffer_seconds, :validate=> :number, :required=> false, :default=> 3
+  # the maximum log size that a single producer instance can cache is 100MB by default.
+  config :total_size_in_bytes, :validate=> :number, :required=> false, :default=> 104857600
+
+  # logGroup will retry send to log service when error happened, and will be discard when retry times exceed limit
+  config :max_send_retry, :validate=> :number, :required=> true, :default=> 10
+  # sleep default 200 milliseconds before retry next send
+  config :send_retry_interval, :validate=> :number, :required=> false, :default=> 200
+
+  config :to_json, :validate=> :boolean, :required=> false, :default=> true
+  config :time_key, :validate=> :string, :required=> false, :default=> "@timestamp"
+
+  LP = com.tencentcloudapi.cls.producer
+  LogCommon = com.tencentcloudapi.cls.producer.common
+
+
+  public
+  def register
+    @producerConfig = LP.AsyncProducerConfig::new(@endpoint, @access_key_id, @access_key_secret, @source);
+    @producerConfig.setBatchCountThreshold(@max_buffer_items);
+    @producerConfig.setBatchSizeThresholdInBytes(@max_buffer_bytes);
+    @producerConfig.setLingerMs(@max_buffer_seconds*1000);
+    @producerConfig.setRetries(@max_send_retry);
+    @producerConfig.setBaseRetryBackoffMs(@send_retry_interval);
+    @producerConfig.setTotalSizeInBytes(@total_size_in_bytes);
+    @producer = LP.AsyncProducerClient::new(@producerConfig);
+  
+    @logger.info("init logstash-output-cls plugin", :endpoint => @endpoint, :topic_id => @topic_id, :source => @source, :max_buffer_bytes => @max_buffer_bytes)
+  end # def register
+
+  public
+  def receive(event)
+    begin
+      @event_map = event.to_hash
+      if @event_map.size < 1
+        return
+      end
+      @logitem = LogCommon.LogItem.new
+      #@timestamp like 2016-02-18T03:23:11.053Z
+      time_value = @event_map[@time_key]
+      if time_value.nil?
+         time_value = @event_map['@timestamp']
+         @logger.warn("The time_key is nil, use @timestamp")
+      end
+      @logitem.SetTime(Time.parse(time_value.to_s).to_datetime().strftime('%Q').to_i)
+      @event_map.each do | key, value |
+        @key_str = key.to_s
+        if @key_str == '__time__'
+          next
+        end
+        if value.instance_of? Hash
+          @value_str = value.to_json
+        else
+          @value_str = value.to_s
+        end
+        @logitem.PushBack(@key_str, @value_str)
+      end
+
+      @producer.putLog(@topic_id, @logitem)
+      rescue => e
+        @logger.warn("send log data fail", :exception => e)
+      end
+    end # def event
+
+  def flush(events, close=false)
+  end
+
+  public
+  def close
+    @producer.close();
+  end # def close
+
+end # class LogStash::Outputs::Cls

data/logstash-output-cls.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-cls'
+  s.version = "0.1.5"
+  s.licenses = ['Apache-2.0']
+  s.summary = "post data into tencent cloud cls."
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["farmerx"]
+  s.email = "farmerx@163.com"
+  s.homepage = "https://www.tencentcloud.com/product/cls"
+  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", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/outputs/cls_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Cls do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Example.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-cls
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- farmerx
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-08 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: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !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: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !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 plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
+  a stand-alone program
+email: farmerx@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/cls.rb
+- lib/logstash/vendor/jar-dependencies/runtime-jars/tencentcloud-cls-sdk-java-1.0.15-jar-with-dependencies.jar
+- logstash-output-cls.gemspec
+- spec/outputs/cls_spec.rb
+homepage: https://www.tencentcloud.com/product/cls
+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: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: post data into tencent cloud cls.
+test_files:
+- spec/outputs/cls_spec.rb