github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 06:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Copy edit a bit. Try to make it clear the intent and usage

Browse source
This commit is contained in:
Jordan Sissel 2014-02-13 00:48:52 -08:00
parent dca315d841
commit d4713f86c3
2 changed files with 39 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

60
docs/contrib-plugins.md
View file

@ -1,49 +1,59 @@
---
title: Logstash Core and Contrib
title: Logstash Contrib plugins
layout: content_right
---
# core and contrib plugins
# contrib plugins
As logstash has grown, we've accumulated a massive repository of plugins. Well
over 100 plugins, it became difficult for the project maintainers to adequately
support everything effectively.
In order to improve the quality of popular plugins, we've moved the
less-commonly-used plugins to a separate repository we're calling "contrib".
Concentrating common plugin usage into core solves a few problems, most notably
user complaints about the size of logstash releases, support/maintenance costs,
etc.
It is our intent that this separation will improve life for users. If it
doesn't, please file a bug so we can work to address it!
If a plugin is available in the 'contrib' package, the documentation for that
plugin will note this boldly at the top of that plugin's documentation.
Starting in version 1.4.0, core and contributed plugins will be separated.
Contrib plugins reside in a [separate github project](https://github.com/elasticsearch/logstash-contrib).
# Packaging
At present, the contrib modules are available as a tarball.
# Automated Installation
The `bin/plugin` script will handle the installation for you:
```
cd /path/to/logstash
bin/plugin install contrib
```
cd /path/to/logstash
bin/plugin install contrib
# Manual Installation
# Manual Installation (if you're behind a firewall, etc.)
The contrib plugins can be extracted on top of an existing Logstash installation.
For example, if I've extracted `logstash-1.4.0.tar.gz` into `/path`, e.g.
For example, if I've extracted `logstash-%VERSION%.tar.gz` into `/path`, e.g.
```
cd /path
tar zxf ~/logstash-1.4.0.tar.gz
```
cd /path
tar zxf ~/logstash-%VERSION%.tar.gz
It will have a `/path/logstash-1.4.0` directory, e.g.
It will have a `/path/logstash-%VERSION%` directory, e.g.
```
$ ls
logstash-1.4.0
```
$ ls
logstash-%VERSION%
The method to install the contrib tarball is identical.
```
cd /path
tar zxf ~/logstash-contrib-1.4.0.tar.gz
```
cd /path
wget http://download.elasticsearch.org/logstash/logstash/logstash-contrib-%VERSION%.tar.gz
tar zxf ~/logstash-contrib-%VERSION%.tar.gz
This will install the contrib plugins in the same directory as the core install.
This will install the contrib plugins in the same directory as the core
install. These plugins will be available to logstash the next time it starts.
The download link is http://download.elasticsearch.org/logstash/logstash/logstash-contrib-${VERSION}.tar.gz
where ${VERSION} is the same version of Logstash you currently have installed, e.g. 1.4.0

6
docs/plugin-doc.html.erb
View file

@ -5,8 +5,10 @@ layout: content_right
<h2><%= name %></h2>
<h3>Milestone: <a href="../plugin-milestones"><%= @milestone %></a></h3>
<% if is_contrib_plugin -%>
<h3>Community plugin!</h3>
This is a community-contributed plugin. To use this, you must have <a href="core-vs-contrib">installed the contrib plugins package</a>.
<div class="community-plugin-notice">
<strong>This is a community-contributed plugin!</strong> It does not ship with logstash by default, but it is easy to install!
To use this, you must have <a href="../contrib-plugins">installed the contrib plugins package</a>.
</div>
<% end -%>
<%= description %>