forked from logstash-plugins/logstash-input-file
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove traces and references the meta logstash gem and change it to u…
…se the new logstash-core gem.
- Loading branch information
Pere Urbon-Bayes
committed
Feb 26, 2015
1 parent
d576b2a
commit 1aabfeb
Showing
3 changed files
with
15 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
source 'https://rubygems.org' | ||
gemspec | ||
gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5" | ||
gemspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,7 +22,7 @@ Need help? Try #logstash on freenode IRC or the [email protected] | |
#### 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. | ||
- 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 | ||
|
@@ -31,40 +31,29 @@ bundle install | |
|
||
#### Test | ||
|
||
```sh | ||
bundle exec rspec | ||
``` | ||
- Update your dependencies | ||
|
||
The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to: | ||
```ruby | ||
gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5" | ||
``` | ||
To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example: | ||
```ruby | ||
gem "logstash", :github => "elasticsearch/logstash", :ref => "master" | ||
``` | ||
```ruby | ||
gem "logstash", :path => "/your/local/logstash" | ||
```sh | ||
bundle install | ||
``` | ||
|
||
Then update your dependencies and run your tests: | ||
- Run tests | ||
|
||
```sh | ||
bundle install | ||
bundle exec rspec | ||
``` | ||
|
||
### 2. Running your unpublished Plugin in Logstash | ||
|
||
#### 2.1 Run in a local Logstash clone | ||
|
||
- Edit Logstash `tools/Gemfile` and add the local plugin path, for example: | ||
- Edit Logstash `Gemfile` and add the local plugin path, for example: | ||
```ruby | ||
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome" | ||
``` | ||
- Update Logstash dependencies | ||
- Install plugin | ||
```sh | ||
rake vendor:gems | ||
bin/plugin install --no-verify | ||
``` | ||
- Run Logstash with your plugin | ||
```sh | ||
|
@@ -74,6 +63,8 @@ At this point any modifications to the plugin code will be applied to this local | |
|
||
#### 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 | ||
|
@@ -90,6 +81,6 @@ All contributions are welcome: ideas, patches, documentation, bug reports, compl | |
|
||
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 me that you are able to contribute. | ||
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. | ||
For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters