You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+27-42
Original file line number
Diff line number
Diff line change
@@ -2,62 +2,43 @@
2
2
3
3
This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
4
4
5
-
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.
5
+
This plugin is to read the /proc virtual file system , decode the files in it.
6
6
7
7
## Documentation
8
8
9
-
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.elasticsearch.org/guide/en/logstash/current/).
10
-
11
-
- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
12
-
- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
13
-
14
-
## Need Help?
15
-
16
-
Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
17
-
18
-
## Developing
19
9
20
10
### 1. Plugin Developement and Testing
21
11
22
12
#### Code
23
13
- To get started, you'll need JRuby with the Bundler gem installed.
24
-
25
-
- 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).
26
-
27
-
- Install dependencies
28
-
```sh
14
+
```sh
29
15
bundle install
30
16
```
31
17
32
-
#### Test
18
+
- Then clone this repo
19
+
- You will need to either clone the logstash repo or download the binary
33
20
34
-
- Update your dependencies
35
21
36
-
```sh
37
-
bundle install
38
-
```
39
22
40
-
- Run tests
41
-
42
-
```sh
43
-
bundle exec rspec
44
-
```
45
-
46
-
### 2. Running your unpublished Plugin in Logstash
23
+
### 2. Running the unpublished Plugin in Logstash
47
24
48
25
#### 2.1 Run in a local Logstash clone
49
26
50
27
- Edit Logstash `Gemfile` and add the local plugin path, for example:
All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
81
-
82
-
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.
83
-
84
-
It is more important to the community that you are able to contribute.
85
-
86
-
For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
0 commit comments