logstash-output-arangodb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 508bccdaeeaf41916a528f694aed33127552909d
+  data.tar.gz: 6a719bd0052135c8719ea18001bb618f37650c72
+SHA512:
+  metadata.gz: 1d021020e77841b36eb22a51abcffd4a1cc6a4db8a64bd7fdedae83719c0f7a8e65110aa0bad5973fe652228c2b561a7e91a861c22348942a621833b55e842c2
+  data.tar.gz: 11ea4efea0fab786ef80bfa8d71b6d56fcb6301521825f65c3178c7f98e9149d106581c09f4a5e007a372ee94b4f77cbc88e6cc2c6ebf456d9d6d114ed52b840

data/.gitignore

@@ -0,0 +1,36 @@
+*.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CONTRIBUTORS

@@ -0,0 +1,9 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+
+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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,11 @@
+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,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.elasticsearch.org/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/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## 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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,23 @@
+ROOT = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift File.join(ROOT, 'lib')
+Dir.glob('lib/**').each{ |d| $LOAD_PATH.unshift(File.join(ROOT, d)) }
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'bundler/gem_tasks'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Specs all at ones."
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = true
+  t.verbose = false
+end

data/lib/logstash/outputs/arangodb.rb

@@ -0,0 +1,86 @@
+require "logstash/namespace"
+require "logstash/outputs/base"
+require "ashikawa-core"
+require "stud/buffer"
+
+class LogStash::Outputs::ArangoDB < LogStash::Outputs::Base
+
+  include Stud::Buffer
+
+  config_name 'arangodb'
+
+  # The URL used to connect to the database.
+  config :url, :validate => :string, :default => "http://localhost:8529"
+
+  # The database that is going to be used
+  config :database, :validate => :string, :default => "logstash"
+
+  # The username used when authenticating with ArangoDB
+  config :username, :validate => :string, :required => true
+
+  # The password used when authenticating with ArangoDB
+  config :password, :validate => :password, :required => true
+
+  # The collection used to log the events, by default it will create a collection
+  # per day of logs following the pattern logstash-%{+YYYY-MM-dd}
+  config :collection, :validate => :string, :default => "logstash-%{+YYYY-MM-dd}"
+
+  # This plugin uses the bulk index api for improved indexing performance.
+  # To make efficient bulk api calls, we will buffer a certain number of
+  # events before flushing that out to ArangoDB. This setting
+  # controls how many events will be buffered before sending a batch
+  # of events.
+  config :flush_size, :validate => :number, :default => 500
+
+  # The amount of time since last flush before a flush is forced.
+  #
+  # This setting helps ensure slow event rates don't get stuck in Logstash.
+  # For example, if your `flush_size` is 100, and you have received 10 events,
+  # and it has been more than `idle_flush_time` seconds since the last flush,
+  # Logstash will flush those 10 events automatically.
+  #
+  # This helps keep both fast and slow log streams moving along in
+  # near-real-time.
+  config :idle_flush_time, :validate => :number, :default => 1
+
+  def register
+
+    @host = Socket.gethostname.force_encoding(Encoding::UTF_8)
+
+    @database = Ashikawa::Core::Database.new do |config|
+      config.url = @url
+      config.database_name = @database if @database
+      config.username = @username
+      config.password = @password.value
+    end
+
+    buffer_initialize(
+      :max_items => @flush_size,
+      :max_interval => @idle_flush_time,
+      :logger => @logger
+    )
+
+  end
+
+  def receive(event)
+    return unless output?(event)
+    buffer_receive(event, :server => @host)
+  end
+
+  def teardown
+    buffer_flush(:final => true)
+  end
+
+  def flush(events, params, final=false)
+    events.each do |event|
+      collection(event).create_document(event.to_hash)
+    end
+  end
+
+  private
+
+  def collection(event)
+    @database[event.sprintf(@collection)]
+  end
+
+end

data/logstash-output-arangodb.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-arangodb'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Logstash Output to ArangoDB"
+  s.description     = "Output events to ArangoDB"
+  s.authors         = ["Pere Urbon-Bayes"]
+  s.email           = 'pere.urbon@gmail.com'
+  s.homepage        = "http://purbon.com/"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # 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" }
+
+  s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'ashikawa-core', '~> 0.14.0'
+  s.add_runtime_dependency 'stud', ['>= 0.0.17', '~> 0.0']
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-codec-plain'
+
+end

data/spec/outputs/arangodb_spec.rb

@@ -0,0 +1,42 @@
+require_relative '../spec_helper'
+require "logstash/plugin"
+require "logstash/json"
+
+describe LogStash::Outputs::ArangoDB do
+
+  let(:config) do
+    { "username" => "logstash", "password" => "logstash" }
+  end
+
+  describe "registration" do
+
+    let(:output) { LogStash::Plugin.lookup("output", "arangodb").new(config) }
+
+    it "should register" do
+      expect { output.register }.to_not raise_error
+    end
+
+    it "should teardown" do
+      output.register
+      expect { output.teardown }.to_not raise_error
+    end
+  end
+
+  describe "#save" do
+
+    subject     { LogStash::Outputs::ArangoDB.new(config) }
+    let(:event) { LogStash::Event.new({"message" => "dummy"}) }
+
+    before(:each) do
+      subject.register
+    end
+
+
+    it "should buffer the event to be flushed" do
+      expect(subject).to receive(:buffer_receive)
+      subject.receive(event)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/arangodb"

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-arangodb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pere Urbon-Bayes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: ashikawa-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: stud
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Output events to ArangoDB
+email: pere.urbon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/outputs/arangodb.rb
+- logstash-output-arangodb.gemspec
+- spec/outputs/arangodb_spec.rb
+- spec/spec_helper.rb
+homepage: http://purbon.com/
+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.6
+signing_key:
+specification_version: 4
+summary: Logstash Output to ArangoDB
+test_files:
+- spec/outputs/arangodb_spec.rb
+- spec/spec_helper.rb