https://github.com/redborder/logstash-filter-macvendorsenrich
https://github.com/redborder/logstash-filter-macvendorsenrich
logstash logstash-plugin redborder
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/redborder/logstash-filter-macvendorsenrich
- Owner: redBorder
- License: apache-2.0
- Created: 2020-03-13T12:38:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T16:13:59.000Z (over 2 years ago)
- Last Synced: 2024-02-21T17:31:00.379Z (over 2 years ago)
- Topics: logstash, logstash-plugin, redborder
- Language: Ruby
- Size: 259 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Logstash Plugin
This is a plugin for [Logstash](https://github.com/elastic/logstash).
This filter enrich the mac vendor information from a `client_mac` using a mac_vendor file.
## Documentation
Add the redfish input in your Logstash pipeline as follow:
```sh
filter {
macvendorsenrich {
path => "/opt/rb/etc/objects/mac_vendors"
}
}
```
You can find a mac_vendors file example into the `samples` directory of this project.
## Need Help?
Need help? Try sending us an email to support@redborder.com
## Developing
### 1. Plugin Developement and Testing
#### Code
- To get started, you'll need JRuby with the Bundler gem installed:
```sh
rvm install jruby-9.2.6.0
```
- Clone from the GitHub [logstash-filter-macvendorsenrich](https://github.com/redBorder/logstash-filter-macvendorsenrich)
- 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 an installed Logstash
- Build your plugin gem
```sh
gem build logstash-filter-macvendorsenrich.gemspec
```
- Install the plugin from the Logstash home
```sh
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify
# Prior to Logstash 2.3
bin/plugin install --no-verify
```
- 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.