logstash-output-logservice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0136766990ee9e06bd4548d8385ac7120cfe1275
+  data.tar.gz: e3422c2e1705932e30ba6422f1e7a3feda02bce5
+SHA512:
+  metadata.gz: fcf85a80751c260469d0da8239226e4ed143f272be5ff3ac22d5e86473dc65cfaa296fe91c99aac4f56989dd3b84dbef1d2df962a61fe2953f4002bff85cbada
+  data.tar.gz: c28980495fdfb804f9e2da7c31447001db8f9b61d4b29017a10b83ac85dd2e7abcb3097a6c816c345c1b49ff893ed97f6ce6049380880b95930a54f236591362

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 2.0.1
+ - Add encoding: utf-8 to spec files. This can help prevent issues during testing.
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+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/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-example
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "logstash", :github => "elastic/logstash", :branch => "2.2"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,89 @@
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/logservice.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/environment"
+require "stud/buffer"
+require 'socket'
+require "java"
+
+import "java.util.ArrayList"
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+LogStash::Environment.load_runtime_jars! File.join(root_dir, "vendor")
+
+class LogStash::Outputs::LogService < LogStash::Outputs::Base
+  include Stud::Buffer
+
+  config_name "logservice"
+
+  # log service config, https://help.aliyun.com/document_detail/sls/api/endpoints.html
+  config :endpoint, :validate => :string, :required => true
+  config :project, :validate=> :string, :required=> true
+  config :logstore, :validate=> :string, :required=> true
+  config :topic, :validate=> :string, :requried=> false, :default=> ""
+  # if source is null, will set ip default
+  config :source, :validete=> :string, :required=> true
+
+  # access_key_id/access_key_secret created by account of aliyun.com
+  config :access_key_id, :validate=> :string, :required=> true
+  config :access_key_secret, :validate=> :string, :required=> true
+
+  # default 1000 logs in a logGroup for batch send
+  config :max_buffer_items, :validate=> :number, :required=> false, :default=> 1000
+  # 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
+
+  # logGroup will retry send to log service when error happened, and will be discard when retry times exceed limit (default 3)
+  config :max_send_retry, :validate=> :number, :required=> true, :default=> 3
+  # sleep default 100 milliseconds before retry next send
+  config :send_retry_interval, :validate=> :number, :required=> false, :default=> 100
+
+  Log = com.aliyun.openservices.log
+  LogException = com.aliyun.openservices.log.exception.LogException
+  LogCommon = com.aliyun.openservices.log.common
+
+  public
+  def register
+    buffer_initialize(
+        :max_items => @max_buffer_items,
+        :max_interval => @max_buffer_seconds,
+        :logger => @logger
+    )
+    @logclient = Log.Client::new(@endpoint, @access_key_id, @access_key_secret)
+    if @source == ''
+      @source = Socket.ip_address_list.detect{|intf| intf.ipv4_private?}
+    end
+    @send_retry_interval_seconds = @send_retry_interval / 1000.0
+    @logger.info("init logstash-output-logservice plugin", :endpoint => @endpoint, :project => @project, :logstore => @logstore, :topic => @topic, :source => @source, :max_buffer_bytes => @max_buffer_bytes)
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+    begin
+      buffer_receive(event)
+    rescue => e
+      @logger.warn("error encoding event for logstash-output-logservice", :exception => e, :event => event)
+    end
+  end # def event
+
+  def send_to_log_service(loggroup)
+    @retry = 0
+    begin
+      @retry += 1
+      @logclient.PutLogs(@project, @logstore, @topic, loggroup, @source)
+      @logger.info("send logs to logservice success", :logcount => loggroup.size().to_s)
+    rescue LogException => e
+      @error_code = e.GetErrorCode()
+      @error_message = e.GetErrorMessage()
+      if @retry < @max_send_retry
+        @logger.info("send logs to logservice fail, will retry soon", :exception => e, :error_code => @error_code, :error_message => @error_message, :retry => @retry)
+        sleep(@send_retry_interval_seconds)
+        retry
+      else
+        @logger.error("send logs to logservice fail, disarcd logs", :exception => e, :error_code => @error_code, :error_message => @error_message, :retry => @retry)
+      end
+    rescue => e
+      if @retry < @max_send_retry
+        @logger.info("send logs to logservice fail, will retry soon", :exception => e, :retry => @retry)
+        sleep(@send_retry_interval_seconds)
+        retry
+      else
+        @logger.error("send logs to logservice fail, disarcd logs", :exception => e, :retry => @retry)
+      end
+    end
+  end
+
+  # called from Stud::Buffer#buffer_flush when there are events to flush
+  def flush(events, close=false)
+    if events.size < 1
+      return
+    end
+
+    @loggroup = ArrayList.new
+    @byte_size = 0
+    events.each { |x|
+      begin
+        @event_map = x.to_hash
+        if @event_map.size < 1
+          next
+        end
+        @logitem = LogCommon.LogItem.new
+        #@timestamp like 2016-02-18T03:23:11.053Z
+        @logitem.SetTime(Time.parse(@event_map['@timestamp'].to_s).to_i)
+        @event_map.each do | key, value |
+          @key_str = key.to_s
+          @value_str = value.to_s
+          @byte_size += @key_str.length + @value_str.length
+          @logitem.PushBack(@key_str, @value_str)
+        end
+        @loggroup.add(@logitem)
+        if @byte_size > @max_buffer_bytes
+          send_to_log_service(@loggroup)
+          @loggroup = ArrayList.new
+          @byte_size = 0
+        end
+      rescue => e
+        @logger.warn("decode log data to LogGroup fail", :exception => e)
+      end
+    }
+    if @byte_size > 0
+      send_to_log_service(@loggroup)
+    end
+  end
+
+  public
+  def close
+    buffer_flush(:final => true)
+  end # def close
+
+end # class LogStash::Outputs::LogService

data/logstash-output-logservice.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-logservice'
+  s.version = "0.1.0"
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "put data into logservice."
+  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 = ["tangkai"]
+  s.email = "kai.tangkai@alibaba-inc.com"
+  s.homepage = "https://help.aliyun.com/product/8314976_sls.html"
+  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", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "stud"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/logservice_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/example"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::LogService 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,137 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-logservice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tangkai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.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: stud
+  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: 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: kai.tangkai@alibaba-inc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/logservice.rb
+- lib/logstash/vendor/jar-dependencies/runtime-jars/aliyun-log-0.6.0-javadoc.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/aliyun-log-0.6.0.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-beanutils-1.8.3.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-codec-1.4.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-collections-3.2.1.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-digester-1.8.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-lang-2.6.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-logging-1.1.1.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/commons-validator-1.4.0.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/ezmorph-1.0.6.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/gson-2.2.4.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/hamcrest-core-1.1.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/httpclient-4.1.3.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/httpcore-4.1.4.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/json-lib-2.4-jdk15.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/lz4-1.3.0.jar
+- lib/logstash/vendor/jar-dependencies/runtime-jars/protobuf-java-2.4.1.jar
+- logstash-output-logservice.gemspec
+- spec/outputs/logservice_spec.rb
+homepage: https://help.aliyun.com/product/8314976_sls.html
+licenses:
+- Apache License (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.5.1
+signing_key: 
+specification_version: 4
+summary: put data into logservice.
+test_files:
+- spec/outputs/logservice_spec.rb