logstash-output-treasure_data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94b4e2ddb3fa7e20ff41d85834692ca01db13bee
+  data.tar.gz: d0a3d5437e18f34ba7db5fc38d5edc03f9efea97
+SHA512:
+  metadata.gz: 52c0f763330105b4e351512575c8256c4e40565d25b83c8b6ec116bf0c8bfd1d11a9a2d80949dbc6f83ac5206b355d4c01747ec2a08944d9a25c24ce28197110
+  data.tar.gz: a7bccbfe3a94d5bd0878da55280de3af317947ff961a2288efb5e7e08c7a5115b499e12321070f21f48c883867d4a6b16d9809581644e231db9c1ff34f2f1d3e

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+ - Initial version
+

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:
+* Satoshi Tagomori (tagomoris)
+
+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-treasure_data
+Treasure Data output plugin.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015- Treasure Data, Inc. <https://www.treasuredata.com/>
+
+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 @@
+Treasure Data, Inc.
+Copyright 2015- Treasure Data, Inc.
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,89 @@
+# Logstash Plugin for Tresure Data service
+
+[![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/treasure_data.rb

@@ -0,0 +1,166 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/json"
+require "stud/buffer"
+
+require "td-client"
+require "msgpack"
+require "uuid"
+
+require "stringio"
+require "zlib"
+
+require_relative "./treasure_data/version"
+
+# Logstash output plugin to send data to Treasure Data service.
+
+class LogStash::Event
+  def to_msgpack(packer=nil)
+    # LogStash objects (ex: LogStash::Timestamp) are impossible to serialize by msgpack
+    begin
+      @data.reject{|a,b| a == TIMESTAMP }.to_msgpack
+    rescue ArgumentError => e
+      LogStash::Json.load(@data.to_json).to_msgpack
+    end
+  end
+end
+
+class LogStash::Outputs::TreasureData < LogStash::Outputs::Base
+  include Stud::Buffer
+
+  config_name "treasure_data"
+
+  IMPORT_SIZE_LIMIT = 32 * 1024 * 1024
+  RECORD_KEYS_LIMIT = 512
+  RECORD_SIZE_LIMIT = 32 * 1024 * 1024
+
+  UUID_FORMAT = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/
+
+  config :apikey, validate: :password, required: true
+  config :auto_create_table, validate: :boolean, default: true
+  config :endpoint, validate: :string, default: TreasureData::API::NEW_DEFAULT_ENDPOINT
+  config :use_ssl, validate: :boolean, default: true
+
+  config :database, validate: :string, required: true
+  config :table, validate: :string, required: true
+
+  config :http_proxy, validate: :string, default: nil
+  config :connect_timeout, validate: :number, default: nil
+  config :read_timeout, validate: :number, default: nil
+  config :send_timeout, validate: :number, default: nil
+
+  config :flush_size, validate: :number, default: 10000      # 10,000 records for flush
+  config :flush_interval, validate: :number, default: 60 * 5 # 15min for flush
+
+  public
+  def register
+    @empty_gz_data = TreasureData::API.create_empty_gz_data
+    @user_agent = "logstash-output-treasure_data: #{VERSION}".freeze
+    @uuid = UUID.new
+
+    TreasureData::API.validate_database_name(@database)
+    TreasureData::API.validate_table_name(@table)
+
+    client_opts = {
+      ssl: @use_ssl,
+      http_proxy: @http_proxy,
+      user_agent: @user_agent,
+      endpoint: @endpoint,
+      connect_timeout: @connect_timeout,
+      read_timeout: @read_timeout,
+      send_timeout: @send_timeout
+    }
+    @client = TreasureData::Client.new(@apikey.value, client_opts)
+
+    buffer_initialize(
+      max_items: @flush_size,
+      max_interval: @flush_interval,
+      logger: @logger
+    )
+  end # def register
+
+  public
+  def receive(event)
+    record = event.clone
+    @logger.debug "receive a event"
+
+    record['time'] ||= (record.timestamp.to_i || Time.now.to_i)
+    if record.to_hash.size > RECORD_KEYS_LIMIT
+      raise "Too many number of keys (#{record.keys.size} keys)"
+    end
+
+    row = record.to_msgpack
+    if row.bytesize > RECORD_SIZE_LIMIT
+      raise "Too large record (#{row.bytesize} bytes with keys:#{record.keys.join(',')})"
+    end
+
+    buffer_receive(row)
+    @logger.debug "buffered a event"
+  end
+
+  public
+  def flush(events, teardown = false)
+    @logger.debug "flushing #{events} events (may include chunk uuid)"
+    return if events.size < 1
+    if UUID_FORMAT !~ events.first
+      new_uuid = @uuid.generate
+      @logger.debug "adding chunk uuid #{new_uuid}"
+      events.unshift new_uuid
+    end
+
+    uuid = events.first
+    io = StringIO.new
+    @logger.debug "gzipping chunk #{uuid}"
+    Zlib::GzipWriter.wrap(io){|f|
+      events.each do |row|
+        unless row == uuid
+          f.write row
+        end
+      end
+      f.finish
+    }
+    data = io.string
+    @logger.debug "sending gzipped chunk #{uuid}, #{data.bytesize} bytes"
+    begin
+      @client.import(@database, @table, "msgpack.gz", data, data.bytesize, uuid)
+
+    rescue TreasureData::NotFoundError => e
+      raise unless @auto_create_table
+
+      @logger.info "creating missing table #{@table} on database #{@database} for chunk #{uuid}"
+      ensure_table_exists(@client, @database, @table)
+      @logger.info "retrying upload chunk #{uuid}"
+      retry
+    end
+
+    @logger.debug "done #{uuid}"
+  end # def flush
+
+  public
+  def ensure_table_exists(client, database, table)
+    begin
+      client.create_log_table(database, table)
+    rescue TreasureData::NotFoundError => e
+      client.create_database(database)
+      client.create_log_table(database, table)
+    rescue TreasureData::AlreadyExistsError => e
+      # ignore
+    end
+  end
+
+  public
+  def on_flush_error(e)
+    @logger.warn "flush error #{e.class}: #{e.message}"
+  end
+
+  public
+  def on_full_buffer_error(opts={})
+    @logger.warn "buffer exceeds limits: pending:#{opts[:pending_count]}, outgoing:#{opts[:outgoing_count]}"
+  end
+
+  public
+  def close
+    buffer_flush(final: true)
+  end
+end # class LogStash::Outputs::Example

data/lib/logstash/outputs/treasure_data/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+
+class LogStash::Outputs::TreasureData < LogStash::Outputs::Base
+  VERSION = "0.0.1"
+end

data/logstash-output-treasure_data.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-treasure_data'
+  s.version         = "0.1.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "Logstash plugin to store data into Treasure Data service."
+  s.description = "This gem is a logstash plugin to store data from logstash to Treasure Data service. This gem is not a stand-alone program."
+  s.authors = ["Satoshi Tagomori"]
+  s.email = "tagomoris@gmail.com"
+  s.homepage = "https://github.com/tagomoris/logstash-output-treasure_data"
+  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 "msgpack", "= 0.7.2dev1"
+  s.add_runtime_dependency "td-client", "= 0.9.0dev2"
+  s.add_runtime_dependency "uuid"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/treasure_data_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+require "logstash/outputs/treasure_data"
+
+describe LogStash::Outputs::TreasureData do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::TreasureData.new(config) }
+  let(:config) do
+    {
+      "apikey" => "0/xxxxxxxxxxxxxxxxx",
+      "database" => "logstash",
+      "table" => "spec",
+    }
+  end
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a nil" do
+      expect(subject).to be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-treasure_data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Satoshi Tagomori
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2dev1
+  name: msgpack
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2dev1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0dev2
+  name: td-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0dev2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: uuid
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a logstash plugin to store data from logstash to Treasure Data service. This gem is not a stand-alone program.
+email: tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/treasure_data.rb
+- lib/logstash/outputs/treasure_data/version.rb
+- logstash-output-treasure_data.gemspec
+- spec/outputs/treasure_data_spec.rb
+homepage: https://github.com/tagomoris/logstash-output-treasure_data
+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.4.8
+signing_key:
+specification_version: 4
+summary: Logstash plugin to store data into Treasure Data service.
+test_files:
+- spec/outputs/treasure_data_spec.rb
+has_rdoc: