logstash-output-bcdb 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
data/README.md CHANGED
@@ -1,109 +1,109 @@
1
- # Logstash Plugin
2
-
3
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-bcdb.svg)](https://travis-ci.org/logstash-plugins/logstash-output-http)
4
-
5
- This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
-
7
- 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.
8
-
9
- ## Documentation
10
-
11
- 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/).
12
-
13
- - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
14
- - For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
15
-
16
- ## Need Help?
17
-
18
- Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
19
-
20
- ## Developing
21
-
22
- ### 1. Plugin Developement and Testing
23
-
24
- #### Code
25
- - To get started, you'll need JRuby with the Bundler gem installed.
26
-
27
- - You can use the docker-compose file in this repo, before you do `docker-compose up` please modify the config in `dev/logstash/pipeline/logstash.conf`
28
-
29
- - 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).
30
-
31
- - Install dependencies
32
- ```sh
33
- bundle install
34
- ```
35
-
36
- #### Test
37
-
38
- - Update your dependencies
39
-
40
- ```sh
41
- bundle install
42
- ```
43
-
44
- - Run tests
45
-
46
- ```sh
47
- bundle exec rspec
48
- ```
49
-
50
- ### 2. Running your unpublished Plugin in Logstash
51
-
52
- #### 2.1 Run in a local Logstash clone
53
-
54
- - Edit Logstash `Gemfile` and add the local plugin path, for example:
55
- ```ruby
56
- gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
57
- ```
58
- - Install plugin
59
- ```sh
60
- # Logstash 2.3 and higher
61
- bin/logstash-plugin install --no-verify
62
-
63
- # Prior to Logstash 2.3
64
- bin/plugin install --no-verify
65
-
66
- ```
67
- - Run Logstash with your plugin
68
- ```sh
69
- bin/logstash -e 'filter {awesome {}}'
70
- ```
71
- At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
72
-
73
- #### 2.2 Run in an installed Logstash
74
-
75
- 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:
76
-
77
- - Build your plugin gem
78
- ```sh
79
- gem build logstash-output-bcdb.gemspec
80
- ```
81
- - Install the plugin from the Logstash home
82
- ```sh
83
- # Logstash 2.3 and higher
84
- bin/logstash-plugin install --no-verify
85
-
86
- # Prior to Logstash 2.3
87
- bin/plugin install --no-verify
88
-
89
- ```
90
- - Start Logstash and proceed to test the plugin
91
-
92
- **Note** Examples of configuration and additional test files can be used from **./dev** folder. Also read the additional readme.md file locatated in the folder.
93
-
94
- ## Publishing
95
-
96
- ```
97
- gem push <file>.gem
98
-
99
- ```
100
-
101
- ## Contributing
102
-
103
- All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
104
-
105
- 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.
106
-
107
- It is more important to the community that you are able to contribute.
108
-
109
- For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
1
+ # Logstash Plugin
2
+
3
+ [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-bcdb.svg)](https://travis-ci.org/logstash-plugins/logstash-output-http)
4
+
5
+ This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
+
7
+ 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.
8
+
9
+ ## Documentation
10
+
11
+ 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/).
12
+
13
+ - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
14
+ - For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
15
+
16
+ ## Need Help?
17
+
18
+ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
19
+
20
+ ## Developing
21
+
22
+ ### 1. Plugin Developement and Testing
23
+
24
+ #### Code
25
+ - To get started, you'll need JRuby with the Bundler gem installed.
26
+
27
+ - You can use the docker-compose file in this repo, before you do `docker-compose up` please modify the config in `dev/logstash/pipeline/logstash.conf`
28
+
29
+ - 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).
30
+
31
+ - Install dependencies
32
+ ```sh
33
+ bundle install
34
+ ```
35
+
36
+ #### Test
37
+
38
+ - Update your dependencies
39
+
40
+ ```sh
41
+ bundle install
42
+ ```
43
+
44
+ - Run tests
45
+
46
+ ```sh
47
+ bundle exec rspec
48
+ ```
49
+
50
+ ### 2. Running your unpublished Plugin in Logstash
51
+
52
+ #### 2.1 Run in a local Logstash clone
53
+
54
+ - Edit Logstash `Gemfile` and add the local plugin path, for example:
55
+ ```ruby
56
+ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
57
+ ```
58
+ - Install plugin
59
+ ```sh
60
+ # Logstash 2.3 and higher
61
+ bin/logstash-plugin install --no-verify
62
+
63
+ # Prior to Logstash 2.3
64
+ bin/plugin install --no-verify
65
+
66
+ ```
67
+ - Run Logstash with your plugin
68
+ ```sh
69
+ bin/logstash -e 'filter {awesome {}}'
70
+ ```
71
+ At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
72
+
73
+ #### 2.2 Run in an installed Logstash
74
+
75
+ 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:
76
+
77
+ - Build your plugin gem
78
+ ```sh
79
+ gem build logstash-output-bcdb.gemspec
80
+ ```
81
+ - Install the plugin from the Logstash home
82
+ ```sh
83
+ # Logstash 2.3 and higher
84
+ bin/logstash-plugin install --no-verify
85
+
86
+ # Prior to Logstash 2.3
87
+ bin/plugin install --no-verify
88
+
89
+ ```
90
+ - Start Logstash and proceed to test the plugin
91
+
92
+ **Note** Examples of configuration and additional test files can be used from **./dev** folder. Also read the additional readme.md file locatated in the folder.
93
+
94
+ ## Publishing
95
+
96
+ ```
97
+ gem push <file>.gem
98
+
99
+ ```
100
+
101
+ ## Contributing
102
+
103
+ All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
104
+
105
+ 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.
106
+
107
+ It is more important to the community that you are able to contribute.
108
+
109
+ For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.