Skip to content

Commit

Permalink
Merge pull request elastic#1072 from jordansissel/fix-docs-build
Browse files Browse the repository at this point in the history
Fix docs build
  • Loading branch information
jordansissel committed Feb 15, 2014
2 parents 1556d1a + 341cdc8 commit f3994eb
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,9 @@ build/docs/tutorials/getting-started-with-logstash.md: build/docs/tutorials/gett
echo "layout: content_right"; \
echo "---"; \
pandoc -f docbook -t markdown $< \
) > $@
) \
| sed -e 's/%VERSION%/$(VERSION)/g' \
| sed -e 's/%ELASTICSEARCH_VERSION%/$(ELASTICSEARCH_VERSION)/g' > $@

build/docs/tutorials/getting-started-with-logstash.xml: docs/tutorials/getting-started-with-logstash.asciidoc
$(QUIET)asciidoc -b docbook -o $@ $<
Expand Down
14 changes: 6 additions & 8 deletions docs/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: content_right
---
<div id="doc_index_container">

<h3> for users </h3>
<h3> For Users </h3>
<ul>
<li> <a href="https://download.elasticsearch.org/logstash/logstash/logstash-%VERSION%-flatjar.jar"> download logstash %VERSION% </a> </li>
<li> <a href="repositories"> package repositories</a> </li>
Expand All @@ -17,19 +17,17 @@ layout: content_right
<li> <a href="flags"> command-line flags </a> </li>
</ul>

<h3> for developers </h3>
<h3> For Developers </h3>
<ul>
<li> <a href="extending"> writing your own plugins </a> </li>
</ul>

<h3> use cases and tutorials </h3>
<h3> Tutorials and Use Cases </h3>

<ul>
<li> <a href="tutorials/getting-started-simple"> getting started (standalone) </a> </li>
<li> <a href="tutorials/getting-started-centralized"> getting started (centralized) </a> </li>
<li> <a href="tutorials/10-minute-walkthrough"> 10-minute walkthrough</a> - a simple walkthrough to show you how to configure the logstash agent to process events and even old logs. </li>
<li> <a href="tutorials/metrics-from-logs"> Gathering metrics from logs </a> - take metrics from logs and ship them to graphite, ganglia, and more. </li>
<li> <a href="tutorials/just-enough-rabbitmq-for-logstash">Just enough RabbitMQ for Logstash </a> - Get a quick primer on RabbitMQ and how to use it in Logstash! </li>
<li> <a href="tutorials/getting-started-with-logstash"> Getting started with Logstash </a> - New to Logstash? Start here! </li>
<li> <a href="tutorials/metrics-from-logs"> Metrics from logs </a> - take metrics from logs and ship them to graphite, ganglia, and more. </li>
<li> <a href="tutorials/just-enough-rabbitmq-for-logstash">Just enough RabbitMQ knowledge for Logstash </a> - Get a quick primer on RabbitMQ and how to use it in Logstash! </li>
</ul>

<h3> books and articles </h3>
Expand Down
28 changes: 14 additions & 14 deletions docs/tutorials/getting-started-with-logstash.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Once you have verified the existence of Java on your system, we can move on!
=== Logstash in two commands
First, we're going to download the pre-built logstash binary and run it with a very simple configuration.
----
curl -O https://download.elasticsearch.org/logstash/logstash/logstash-1.3.3-flatjar.jar
curl -O https://download.elasticsearch.org/logstash/logstash/logstash-%VERSION%-flatjar.jar
----
Now you should have the file named 'logstash-1.3.3-flatjar.jar' on your local filesystem. Let's run it:
Now you should have the file named 'logstash-%VERSION%-flatjar.jar' on your local filesystem. Let's run it:
----
java -jar logstash-1.3.3-flatjar.jar agent -e 'input { stdin { } } output { stdout {} }'
bin/logstash -e 'input { stdin { } } output { stdout {} }'
----

Now type something into your command prompt, and you will see it output by logstash:
Expand All @@ -45,7 +45,7 @@ OK, that's interesting... We ran logstash with an input called "stdin", and an o

Let's try a slightly fancier example. First, you should exit logstash by issuing a 'CTRL-C' command in the shell in which it is running. Now run logstash again with the following command:
----
java -jar logstash-1.3.3-flatjar.jar agent -e 'input { stdin { } } output { stdout { codec => rubydebug } }'
bin/logstash -e 'input { stdin { } } output { stdout { codec => rubydebug } }'
----

And then try another test input, typing the text "goodnight moon":
Expand All @@ -64,19 +64,19 @@ So, by re-configuring the "stdout" output (adding a "codec"), we can change the
== Storing logs with Elasticsearch
Now, you're probably saying, "that's all fine and dandy, but typing all my logs into logstash isn't really an option, and merely seeing them spit to STDOUT isn't very useful." Good point. First, let's set up Elasticsearch to store the messages we send into logstash. If you don't have Elasticearch already installed, you can http://www.elasticsearch.org/download/[download the RPM or DEB package], or install manually by downloading the current release tarball, by issuing the following four commands:
----
curl -O https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-0.90.10.tar.gz
tar zxvf elasticsearch-0.90.10.tar.gz
cd elasticsearch-0.90.10/
curl -O https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-%ELASTICSEARCH_VERSION%.tar.gz
tar zxvf elasticsearch-%ELASTICSEARCH_VERSION%.tar.gz
cd elasticsearch-%ELASTICSEARCH_VERSION%/
./bin/elasticsearch
----

NOTE: This tutorial specifies running Logstash 1.3.3 with Elasticsearch 0.90.10. Each release of Logstash has a *recommended* version of Elasticsearch to pair with. Make sure the versions match based on the http://logstash.net/docs/latest[Logstash version] you're running!
NOTE: This tutorial specifies running Logstash %VERSION% with Elasticsearch %ELASTICSEARCH_VERSION%. Each release of Logstash has a *recommended* version of Elasticsearch to pair with. Make sure the versions match based on the http://logstash.net/docs/latest[Logstash version] you're running!

More detailed information on installing and configuring Elasticsearch can be found on http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index.html[The Elasticsearch reference pages]. However, for the purposes of Getting Started with Logstash, the default installation and configuration of Elasticsearch should be sufficient.

Now that we have Elasticsearch running on port 9200 (we do, right?), logstash can be simply configured to use Elasticsearch as its backend. The defaults for both logstash and Elasticsearch are fairly sane and well thought out, so we can omit the optional configurations within the elasticsearch output:
----
java -jar logstash-1.3.3-flatjar.jar agent -e 'input { stdin { } } output { elasticsearch { host => localhost } }'
bin/logstash -e 'input { stdin { } } output { elasticsearch { host => localhost } }'
----

Type something, and logstash will process it as before (this time you won't see any output, since we don't have the stdout output configured)
Expand Down Expand Up @@ -124,7 +124,7 @@ Now you can browse to http://localhost:9200/_plugin/kopf[http://localhost:9200/_
=== Multiple Outputs
As a quick exercise in configuring multiple Logstash outputs, let's invoke logstash again, using both the 'stdout' as well as the 'elasticsearch' output:
----
java -jar logstash-1.3.3-flatjar.jar agent -e 'input { stdin { } } output { elasticsearch { host => localhost } stdout { } }'
bin/logstash -e 'input { stdin { } } output { elasticsearch { host => localhost } stdout { } }'
----
Typing a phrase will now echo back to your terminal, as well as save in Elasticsearch! (Feel free to verify this using curl or elasticsearch-kopf).

Expand Down Expand Up @@ -188,7 +188,7 @@ output {
Then, run this command:

----
java -jar logstash-1.3.3-flatjar.jar agent -f logstash-simple.conf
bin/logstash -f logstash-simple.conf
----

Et voilà! Logstash will read in the configuration file you just created and run as in the example we saw earlier. Note that we used the '-f' to read in the file, rather than the '-e' to read the configuration from the command line. This is a very simple case, of course, so let's move on to some more complex examples.
Expand Down Expand Up @@ -216,7 +216,7 @@ output {
Run the logstash jar file with this configuration:

----
java -jar logstash-1.3.3-flatjar.jar agent -f logstash-filter.conf
bin/logstash -f logstash-filter.conf
----

Now paste this line into the terminal (so it will be processed by the stdin input):
Expand Down Expand Up @@ -290,7 +290,7 @@ Then, create the file you configured above (in this example, "/Applications/XAMP

Now run it with the -f flag as in the last example:
----
java -jar logstash-1.3.3-flatjar.jar agent -f logstash-apache.conf
bin/logstash -f logstash-apache.conf
----
You should be able to see your apache log data in Elasticsearch now! You'll notice that logstash opened the file you configured, and read through it, processing any events it encountered. Any additional lines logged to this file will also be captured, processed by logstash as events and stored in Elasticsearch. As an added bonus, they will be stashed with the field "type" set to "apache_access" (this is done by the type => "apache_access" line in the input configuration).

Expand Down Expand Up @@ -378,7 +378,7 @@ output {
----
Run it as normal:
----
java -jar logstash-1.3.3-flatjar.jar agent -f logstash-syslog.conf
bin/logstash -f logstash-syslog.conf
----
Normally, a client machine would connect to the logstash instance on port 5000 and send its message. In this simplified case, we're simply going to telnet to logstash and enter a log line (similar to how we entered log lines into STDIN earlier). First, open another shell window to interact with the logstash syslog input and type the following command:

Expand Down

0 comments on commit f3994eb

Please sign in to comment.