logstash-plugins/logstash-codec-nmap

Name: logstash-codec-nmap

Owner: Logstash Plugins

Description: NMap XML decoding for logstash

Created: 2016-01-26 16:49:00.0

Updated: 2018-05-15 06:54:31.0

Pushed: 2018-03-16 12:37:34.0

Homepage: null

Size: 49

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Logstash Plugin

This is a plugin for 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.

• 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 organization. We also provide example plugins.

• Install dependencies

  le install
  

Test

• Update your dependencies

le install

• Run tests

le 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:

  "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
  

• Install plugin

  gstash 2.3 and higher
  logstash-plugin install --no-verify
  

Prior to Logstash 2.3

bin/plugin install –no-verify

n Logstash with your plugin

bin/logstash -e 'filter {awesome {}}'

his 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

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:

ild your plugin gem

gem build logstash-filter-awesome.gemspec

stall the plugin from the Logstash home

Logstash 2.3 and higher

bin/logstash-plugin install –no-verify

Prior to Logstash 2.3

bin/plugin install –no-verify

art Logstash and proceed to test the plugin

ontributing

contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

ramming 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.

s more important to the community that you are able to contribute.

more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.