logstash-input-gitlog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daf7dedeb82b1cbb34dbab8ca35ceb8ee31e3c0a1a2e19d02361526c5e5a3f11
+  data.tar.gz: 5bc12f97dc55ac75fdf46f0432c92fc1eed9ef3d9b44e606bbbb94a18da75f03
+SHA512:
+  metadata.gz: 1c9936ac82f49ca5b183f6b7a4d8ce53964cd0c87c6a88e7b394ee69a86552b0860beaafbb4834917454f60092794a512541d3ae9655285ec94e39996a9068ab
+  data.tar.gz: 014f678a16b63cbd9e0aa471d7d350c25371d3c8bdee49296ea3384422c7869520d651e48d37e63f9fc58fcac8db0e87fc3de22d7a2687c9189f65449348f1fc

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-input-gitlog
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+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,92 @@
+# Logstash Plugin
+
+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 plugin is a skunkworks proof-of-concept.
+
+It is known to be incompatible with other Logstash plugins, notably `logstash-output-email` and `logstash-output-imap`, which both have a dependency conflict regarding the `mime-type` gem; you will need to uninstall these plugins before using this project.
+
+## 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/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/inputs/gitlog.rb

@@ -0,0 +1,161 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require 'set'
+
+require "rjgit"
+
+require 'java'
+
+# Generate a repeating message.
+#
+# This plugin is intented only as an example.
+
+class LogStash::Inputs::Gitlog < LogStash::Inputs::Base
+
+  import 'org.eclipse.jgit.revwalk.RevWalk'
+  import 'org.eclipse.jgit.revwalk.RevSort'
+
+  config_name "gitlog"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  config :path, :validate => :string, :required => true
+
+  config :head, :validate => :string, :default => 'master'
+
+  config :limit, :validate => :number, :default => nil
+
+  config :diff, :validate => :boolean, :default => false
+
+  config :delay, :validate => :number, :default => nil
+
+
+  public
+  def register
+    # ensure that configured `@path` points to a real file path
+    unless File.exists?(@path)
+      logger.error("path not found: `#{@path}`")
+      fail "path not found: `#{@path}`"
+    end
+
+    # ensure that configured `@path` points to a valid git repository
+    @repo = RJGit::Repo.new(@path)
+    unless @repo.valid?
+      logger.error("not a valid git repository `#{@path}`")
+      fail "not a valid git repository `#{@path}`"
+    end
+
+    # ensure that configured `@head` is a valid head reference
+    branch_head = @repo.jrepo.resolve(@head)
+    if branch_head.nil?
+      logger.error("not a valid branch, tag, or commit reference `#{@head}`", path: @path)
+      fail "not a valid branch, tag, or commit reference `#{@head}`"
+    else
+      logger.debug("resolved head `#{@head}` to `#{branch_head.get_name}`", path: @path)
+    end
+  end # def register
+
+  def run(queue)
+    # delay-tactic enables testability
+    unless @delay.nil?
+      logger.info("delaying for `#{delay}` seconds...")
+      sleep(@delay)
+    end
+
+    unprocessed_commits = Set.new
+
+    commits.each do |commit|
+      # we can abort the loop if stop? becomes true
+      break if stop?
+
+      hevent = {
+        "id"             => commit.id,
+        "parents"        => commit.parents.map(&:id),
+        "actor"          => {
+          "name" => commit.actor.name,
+          "email" => commit.actor.email,
+        },
+        "committer"      => {
+          "name" => commit.committer.name,
+          "email" => commit.committer.email,
+        },
+        "authored_date"  => commit.authored_date,
+        "committed_date" => commit.committed_date,
+        "message"        => commit.message,
+        "short_message"  => commit.short_message,
+      }
+
+      # add diffs only if enabled
+      hevent["diffs"]= commit.diffs if @diffs
+
+      logger.trace("Created event from commit", event: hevent)
+
+      event = LogStash::Event.new(hevent)
+
+      decorate(event)
+      queue << event
+
+      # dragons: tracking unprocessed commits in this manner requires
+      # topographic children-before-parents processing.
+      commit.parents.each do |parent|
+        unprocessed_commits.add(parent.id)
+      end
+      unprocessed_commits.delete(commit.id)
+    end # loop
+
+    unless unprocessed_commits.empty?
+      logger.debug("unprocessed commits", commits: unprocessed_commits)
+    end
+  end # def run
+
+
+  def stop
+    # nothing to do in this case so it is not necessary to define stop
+    # examples of common "stop" tasks:
+    #  * close sockets (unblocking blocking reads/accepts)
+    #  * cleanup temporary files
+    #  * terminate spawned threads
+  end
+
+  private
+
+  # returns a lazy Enumerator that will walk upwards on the repo from the configured `@head`,
+  # following all parents and respecting `@limit`.
+  #
+  # @return [Enumerator::Lazy<RJGit::Commit>] if no block given
+  # @yieldparam commit [RJGit::Commit]
+  # @yieldreturn [Object]
+  def commits
+    return enum_for(:commits).lazy unless block_given?
+
+    jrepo = @repo.jrepo
+    objhead = jrepo.resolve(@head)
+    walk = RevWalk.new(jrepo)
+
+    # dragons: the way unprocessed children are tracked requires TOPO ordering to be enabled
+    walk.sort(RevSort::TOPO, true)
+    walk.sort(RevSort::COMMIT_TIME_DESC, true)
+
+    root = walk.parse_commit(objhead)
+    walk.mark_start(root)
+
+    loop.with_index do |_, index|
+      logger.debug("crawling commits", index: index) if (index%1000).zero?
+
+      if @limit && (index >= @limit)
+        logger.info("crawl limit reached", index: index)
+        break
+      end
+
+      jcommit = walk.next
+      if jcommit.nil?
+        logger.info("crawl complete", index: index)
+        break
+      end
+
+      yield(RJGit::Commit.new(@repo, jcommit))
+    end
+  end
+end # class LogStash::Inputs::Gitlog

data/logstash-input-gitlog.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-gitlog'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash Events from Git History'
+  s.homepage      = 'https://github.com/yaauie/logstash-input-gitlog'
+  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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_runtime_dependency 'rjgit', '~> 4.10.0'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+end

data/spec/inputs/gitlog_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/gitlog"
+
+describe LogStash::Inputs::Gitlog do
+
+  it_behaves_like "an interruptible input plugin" do
+
+    # assumes that the local code is running from its own repository, with a valid reference `master`
+    # configure with 1s delay, since it runs too quickly for underlying test to validate that it can be interrupted
+    let(:git_repo_path) { File.expand_path("../../../", __FILE__) }
+    let(:config) { { "path" => git_repo_path, "delay" => 1} }
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-gitlog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ry Biesemeyer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-01-30 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: '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.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.10.0
+  name: rjgit
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.10.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description:
+email: ry.biesemeyer@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/gitlog.rb
+- logstash-input-gitlog.gemspec
+- spec/inputs/gitlog_spec.rb
+homepage: https://github.com/yaauie/logstash-input-gitlog
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.11
+signing_key:
+specification_version: 4
+summary: Logstash Events from Git History
+test_files:
+- spec/inputs/gitlog_spec.rb