logstash-filter-memcached 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a5b909f6459b8a3d4ae405b3d9e076ed4c1bb7eab344dbc5f4a8a98c55268d0
+  data.tar.gz: 4dbf8017bcf03a1f6462da74df69b1ca8485b57df2c585f772cf38a158858c94
+SHA512:
+  metadata.gz: bda94d2ee65f231e5a40bc8ffa4b32e8c04126694e74f66b1aee3e8a2e33cc56ca96707fb5cf2e1f29c8fd48e6a51d02e98ed70a2bcd5286cc9e2c7f2c1bc6a7
+  data.tar.gz: d094cebcab25b085d0f8aca5d6611fb7654e7d9f5ee56f7c64250998a427742b39c1ee35afdffdc0b6c05341b55d81329445423369096a68cf92f737fc62e07c

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

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:
+* Ry Biesemeyer - ry.biesemeyer@elastic.co
+
+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-filter-memcached
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

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,95 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-memcached.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-memcached)
+
+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.
+
+## CAVEAT: 0.x
+
+This `logstash-filter-memcached` repository is a pre-release, 0.x, skunkwork proof-of-concept. It works, but as a 0.x release we can make no guaranees that upgrades to future versions will be trivial. The API may change within the 0.x series as we work to find the API that feels "right" for a full-featured 1.x release.
+
+The Logstash team is in the process of bringing this project (or equivalent functionality) into the [logstash-plugins fold](https://github.com/elastic/logstash/issues/8930), but the exact shape of the resulting API is still being debated.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin from its [index summary](./docs/index.asciidoc). 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
+
+## TODO:
+
+ - Automated tests that don't rely on memcached magically pre-existing on localhost:11211
+ - Better spec coverage
+
+## 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/logstash-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/logstash-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/filters/memcached.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This filter provides facilities to interact with Memcached.
+class LogStash::Filters::Memcached < LogStash::Filters::Base
+
+  # This is how you configure this filter from your Logstash config.
+  #
+  # Given:
+  #  - event with field `hostname` with value `example.com`
+  #  - memcached with entry for `threats/hostname/example.com`
+  #
+  # The following config will inject the value from memcached into
+  # the nested field `[threats][host]`:
+  #
+  # filter {
+  #   memcached {
+  #     hosts => ["localhost:11211"]
+  #     namespace => "threats"
+  #     get => {
+  #       "hostname:%{[hostname]}" => "[threats][host]"
+  #     }
+  #   }
+  # }
+  #
+  config_name "memcached"
+  
+  # an array of memcached hosts to connect to
+  # valid forms:
+  # ipv4:
+  #   - 127.0.0.1
+  #   - 127.0.0.1:11211
+  # ipv6:
+  #   - ::1
+  #   - [::1]:11211
+  # fqdn:
+  #   - your.fqdn.com
+  #   - your.fqdn.com:11211
+  config :hosts, :validate => :array, :default => ["localhost"]
+
+  # if specified and non-empty, all keys will be prepended with this string and a colon (`:`)
+  config :namespace, :validate => :string, :required => false
+
+  # GET data from the given memcached keys to inject into the corresponding event fields.
+  #  - memcached keys can reference event fields via sprintf
+  #  - event fields can be deep references
+  #
+  # get {
+  #   "memcached-key1" => "[path][to][field1]"
+  #   "memcached-key2" => "[path][to][field2]"
+  # }
+  config :get, :validate => :hash, :required => false
+
+  # SET the given fields from the event to the corresponding keys in memcached
+  #  - memcached keys can reference event fields via sprintf
+  #  - event fields can be deep references
+  #
+  # set {
+  #   "[path][to][field1]" => "memcached-key1"
+  #   "[path][to][field2]" => "memcached-key2"
+  # }
+  config :set, :validate => :hash, :required => false
+
+
+  # if performing a setting operation to memcached, the time-to-live in seconds.
+  # NOTE: in Memcached, a value of 0 (default) means "never expire"
+  config :ttl, :validate => :number, :default => 0
+
+  public
+
+  attr_reader :cache
+
+  def register
+    if @ttl < 0
+      logger.error("ttl cannot be negative")
+      fail("invalid ttl: cannot be negative")
+    end
+
+    @cache = establish_connection
+  end # def register
+
+  def filter(event)
+    do_set(event)
+    do_get(event)
+
+    filter_matched(event)
+  end # def filter
+
+  def close
+    cache.close
+  end
+
+  private
+
+  def do_get(event)
+    return unless @get && !@get.empty?
+
+    event_fields_by_memcached_key = @get.each_with_object({}) do |(memcached_key_template, event_field), memo|
+      memcached_key = event.sprintf(memcached_key_template)
+      memo[memcached_key] = event_field
+    end
+
+    memcached_keys = event_fields_by_memcached_key.keys
+    cache_hits_by_memcached_key = cache.get_multi(memcached_keys)
+
+    event_fields_by_memcached_key.each do |memcached_key, event_field|
+      value = cache_hits_by_memcached_key[memcached_key]
+      if value.nil?
+        logger.trace("cache:get miss", context(key: memcached_key))
+      else
+        logger.trace("cache:get hit", context(key: memcached_key, value: value))
+        event.set(event_field, value)
+      end
+    end
+  end
+
+  def do_set(event)
+    return unless @set && !@set.empty?
+
+    values_by_memcached_key = @set.each_with_object({}) do |(event_field, memcached_key_template), memo|
+      memcached_key = event.sprintf(memcached_key_template)
+      value = event.get(event_field)
+
+      memo[memcached_key] = value unless value.nil?
+    end
+
+    cache.multi do
+      values_by_memcached_key.each do |memcached_key, value|
+        logger.trace("cache:set", context(key: memcached_key, value: value))
+        cache.set(memcached_key, value)
+      end
+    end
+  end
+
+  def establish_connection
+    require 'dalli'
+
+    hosts = validate_connection_hosts
+    options = validate_connection_options
+    logger.debug('connecting to memcached', context(hosts: hosts, options: options))
+    Dalli::Client.new(@hosts, options).tap do |client|
+      begin
+        client.alive!
+      rescue Dalli::RingError
+        logger.error("failed to connect", context(hosts: hosts, options: options))
+        fail("cannot connect to memcached")
+      end
+    end
+  end
+
+  def validate_connection_options
+    {}.tap do |options|
+      options[:ttl] = @ttl
+      options[:namespace] = @namespace unless @namespace.nil? || @namespace.empty?
+    end
+  end
+
+  def validate_connection_hosts
+    logger.error("configuration: hosts empty!") && fail if @hosts.empty?
+
+    @hosts.map(&:to_s)
+  end
+
+  def context(hash={})
+    @plugin_context ||= Hash.new.tap do |hash|
+      hash[:namespace] = @namespace unless @namespace.nil? or @namespace.empty?
+    end
+    return hash if @plugin_context.empty?
+
+    @plugin_context.merge(hash)
+  end
+end # class LogStash::Filters::Memcached

data/logstash-filter-memcached.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-memcached'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'A Logstash filter plugin for interacting with memcached'
+  s.homepage      = 'https://github.com/yaauie/logstash-filter-memcached'
+  s.authors       = ['Ry Biesemeyer']
+  s.email         = 'ry.biesemeyer@elastic.co'
+  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" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "dalli", "~> 2.7"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/memcached_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/memcached"
+
+LogStash::Logging::Logger::configure_logging("TRACE")
+
+describe LogStash::Filters::Memcached do
+  subject { described_class.new(config) }
+  let(:cache) { double('memcached') }
+  before(:each) do
+    allow(subject).to receive(:establish_connection).and_return(cache)
+    allow(subject).to receive(:close)
+    subject.register
+  end
+
+  after(:each) do
+    subject.close
+  end
+
+  describe "#get" do
+    let(:event) { ::LogStash::Event.new(data) }
+    let(:config) do
+      {
+        "hosts" => ["localhost:11211"],
+        "get" => { "success/%{success}/answer" => "[ultimate][answer]" }
+      }
+    end
+    let(:data) { { "success" => "true" } }
+
+    it "retrieves data from memcache" do
+      expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => "42"})
+      subject.filter(event)
+      expect(event.get("ultimate")).to eq("answer" => "42")
+    end
+  end
+
+  describe "#set" do
+    let(:event) { ::LogStash::Event.new(data) }
+    let(:config) do
+      {
+        "hosts" => ["localhost:11211"],
+        "set" => { "[answer]" => "success/%{success}/answer" },
+      }
+    end
+    let(:data) { { "answer" => "42", "success" => "true" } }
+    before(:each) { allow(cache).to receive(:multi) {|&b| b.call } }
+
+    it "sets data on memcache" do
+      expect(cache).to receive(:set).with("success/true/answer", "42")
+      subject.filter(event)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-memcached
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ry Biesemeyer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  name: dalli
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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:
+email: ry.biesemeyer@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/memcached.rb
+- logstash-filter-memcached.gemspec
+- spec/filters/memcached_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yaauie/logstash-filter-memcached
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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.6.13
+signing_key:
+specification_version: 4
+summary: A Logstash filter plugin for interacting with memcached
+test_files:
+- spec/filters/memcached_spec.rb
+- spec/spec_helper.rb