Skip to content

Commit 25c4adc

Browse files
debadairdebadair
committed
Updated Marvel & Sense information for 2.0.
1 parent 79f48fb commit 25c4adc

File tree

3 files changed

+59
-73
lines changed

3 files changed

+59
-73
lines changed

‎010_Intro/10_Installing_ES.asciidoc

+38-48
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
=== Installing Elasticsearch
1+
[[running-elasticsearch]]
2+
=== Installing and Running Elasticsearch
23

34
The easiest way to understand what Elasticsearch can do for you is to
45
play with it, so let's get started!((("Elasticsearch", "installing")))
@@ -24,41 +25,8 @@ https://github.com/elasticsearch/puppet-elasticsearch[Puppet module] or
2425
https://github.com/elasticsearch/cookbook-elasticsearch[Chef cookbook].
2526
====
2627

27-
[[marvel]]
28-
==== Installing Marvel
29-
30-
http://www.elasticsearch.com/products/marvel[Marvel] is a management((("Marvel", "defined"))) and monitoring
31-
tool for Elasticsearch, which is free for development use. It comes with an
32-
interactive console called Sense,((("Sense console (Marvel plugin)"))) which makes it easy to talk to
33-
Elasticsearch directly from your browser.
34-
35-
Many of the code examples in the online version of this book include a View in Sense link. When
36-
clicked, it will open up a working example of the code in the Sense console.
37-
You do not have to install Marvel, but it will make this book much more
38-
interactive by allowing you to experiment with the code samples on your local
39-
Elasticsearch cluster.
40-
41-
Marvel is available as a plug-in.((("Marvel", "downloading and installing"))) To download and install it, run this command in the Elasticsearch directory:
42-
43-
[source,sh]
44-
--------------------------------------------------
45-
./bin/plugin -i elasticsearch/marvel/latest
46-
--------------------------------------------------
47-
48-
Marvel can also be installed using a https://www.elastic.co/guide/en/marvel/1.3/installation.html[manual process] if you don't have internet connectivity.
49-
50-
You probably don't want Marvel to monitor your local cluster, so you can
51-
disable data collection with this command:
52-
53-
[source,sh]
54-
--------------------------------------------------
55-
echo 'marvel.agent.enabled: false' >> ./config/elasticsearch.yml
56-
--------------------------------------------------
57-
58-
[[running-elasticsearch]]
59-
=== Running Elasticsearch
6028

61-
Elasticsearch is now ready to run. ((("Elasticsearch", "running"))) To start it up in the foreground:
29+
Once you've extracted the archive file, Elasticsearch is ready to run. ((("Elasticsearch", "running"))) To start it up in the foreground:
6230

6331
[source,sh]
6432
--------------------------------------------------
@@ -100,7 +68,10 @@ You should see a response like this:
10068
This means that your Elasticsearch _cluster_ is up and running, and we can
10169
start experimenting with it.
10270

103-
NOTE: A _node_ is a running instance of Elasticsearch.((("nodes", "defined"))) A _cluster_ is ((("clusters", "defined")))a group of
71+
TIP: See that View in Sense link at the bottom of the example? <<sense, Install the Sense console>>
72+
to run the examples in this book against your own Elasticsearch cluster and view the results.
73+
74+
A _node_ is a running instance of Elasticsearch.((("nodes", "defined"))) A _cluster_ is ((("clusters", "defined")))a group of
10475
nodes with the same `cluster.name` that are working together to share data
10576
and to provide failover and scale, although a single node can form a cluster
10677
all by itself.
@@ -110,22 +81,41 @@ like your own name, to stop ((("clusters", "changing default name")))your nodes
11081
the same network with the same name!
11182

11283
You can do this by editing the `elasticsearch.yml` file in the `config/`
113-
directory and then restarting Elasticsearch. When Elasticsearch is running in
114-
the foreground, you can stop it by pressing Ctrl-C; otherwise, you can shut
115-
it down with the `shutdown` API:
84+
directory and then restarting Elasticsearch.
85+
86+
When Elasticsearch is running in the foreground, you can stop it by pressing Ctrl-C.
11687

88+
[[sense]]
89+
==== Installing Sense
90+
Sense is a https://www.elastic.co/guide/en/kibana/current/index.html[Kibana]
91+
app ((("Sense console", "Kibana app"))) that provides an interactive
92+
console for submitting requests to Elasticsearch directly from your browser.
93+
Many of the code examples in the online version of this book include a View in Sense link. When
94+
clicked, it opens up a working example of the code in the Sense console.
95+
You do not have to install Sense, but it will make this book much more
96+
interactive by allowing you to experiment with the code samples on your local
97+
Elasticsearch cluster.
98+
99+
((("Sense", "downloading and installing"))) To install and run Sense:
100+
101+
. Run the following command in the Kibana directory to download and install the Sense app:
102+
+
117103
[source,sh]
118104
--------------------------------------------------
119-
curl -XPOST 'http://localhost:9200/_shutdown'
105+
./bin/kibana plugin --install elastic/sense <1>
120106
--------------------------------------------------
107+
<1> Windows: `bin\kibana.bat plugin --install elastic/sense`.
108+
+
109+
NOTE: You can download Sense from https://download.elastic.co/elastic/sense/sense-latest.tar.gz
110+
to https://www.elastic.co/guide/en/sense/current/installing.html#manual_download[install it on an offline machine].
121111

112+
. Start Kibana.
113+
+
114+
[source,sh]
115+
--------------------------------------------------
116+
./bin/kibana <1>
117+
--------------------------------------------------
118+
<1> Windows: `bin\kibana.bat`.
122119

123-
==== Viewing Marvel and Sense
124-
125-
If you installed the <<marvel,Marvel>> management ((("Marvel", "viewing")))and monitoring tool, you can
126-
view it in a web browser by visiting
127-
http://localhost:9200/_plugin/marvel/.
120+
. Open Sense your web browser by going to `http://localhost:5601/app/sense`.
128121

129-
You can reach the _Sense_ developer((("Sense console (Marvel plugin)", "viewing"))) console either by clicking the ``Marvel
130-
dashboards'' drop-down in Marvel, or by visiting
131-
http://localhost:9200/_plugin/marvel/sense/.

‎010_Intro/15_API.asciidoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,4 @@ GET /_count
128128
--------------------------------------------------
129129
// SENSE: 010_Intro/15_Count.json
130130

131-
In fact, this is the same format that is used by the ((("Marvel", "Sense console")))((("Sense console (Marvel plugin)", "curl requests in")))Sense console that we
132-
installed with <<marvel,Marvel>>. If in the online version of this book, you can open and run this code example in
133-
Sense by clicking the View in Sense link above.
131+
In fact, this is the same format that is used by the ((( "Sense console")))((("Sense console (Kibana app)", "curl requests in"))) <<sense, Sense console>>. If you're viewing the online version of this book, you can open and run this code example in Sense by clicking the View in Sense link above.

‎500_Cluster_Admin/15_marvel.asciidoc

+20-22
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,27 @@
1-
1+
[[marvel]]
22
=== Marvel for Monitoring
33

4-
At the very beginning of the book (<<marvel>>), we encouraged you to install
5-
Marvel,((("Marvel", "monitoring with")))((("clusters", "administration", "Marvel for monitoring"))) a management monitoring tool for Elasticsearch, because it would enable
6-
interactive code samples throughout the book.
7-
8-
If you didn't install Marvel then, we encourage you to install it now. This
9-
chapter introduces a large number of APIs that emit an even larger number
10-
of statistics. These stats track everything from heap memory usage and garbage
11-
collection counts to open file descriptors. These statistics are invaluable
12-
for debugging a misbehaving cluster.
4+
https://www.elastic.co/guide/en/marvel/current/index.html[Marvel] enables
5+
you to easily monitor Elasticsearch through Kibana. You can view your
6+
cluster’s health and performance in real time as well as analyze
7+
past cluster, index, and node metrics.
138

14-
The problem is that these APIs provide a single data point: the statistic
15-
_right now_. Often you'll want to see historical data too, so you can
16-
plot a trend. Knowing memory usage at this instant is helpful, but knowing
17-
memory usage _over time_ is much more useful.
9+
While you can access a large number of statistics through the APIs described
10+
in this chapter, they only show you what's going on at a single point in time.
11+
Knowing memory usage at this instant is helpful, but knowing
12+
memory usage _over time_ is much more useful. Marvel queries and aggregates
13+
the metrics so you can visualize your cluster's
14+
behavior over time, which makes it easy to spot trends.
1815

19-
Furthermore, the output of these APIs can get truly hairy as your cluster grows.
16+
As your cluster grows, the output from the stats APIs can get truly hairy.
2017
Once you have a dozen nodes, let alone a hundred, reading through stacks of JSON
21-
becomes very tedious.
18+
becomes very tedious. Marvel lets your explore the data interactively and
19+
makes it easy to zero in on what's going on with particular nodes or indices.
2220

23-
Marvel periodically polls these APIs and stores the data back in Elasticsearch.
24-
This allows Marvel to query and aggregate the metrics, and then provide interactive
25-
graphs in your browser. There are no proprietary statistics that Marvel exposes;
26-
it uses the same stats APIs that are accessible to you. But it does greatly
27-
simplify the collection and graphing of those statistics.
21+
Marvel uses the same stats APIs that are available to you--it does not expose
22+
any statistics that you can't access through the APIs. However, Marvel greatly
23+
simplifies the collection and visualization of those statistics.
2824

29-
Marvel is free to use in development, so you should definitely try it out!
25+
Marvel is free to use (even in production!), so you should definitely try it out!
26+
For installation instructions, see
27+
https://www.elastic.co/guide/en/marvel/current/getting-started.html[Getting Started with Marvel].

0 commit comments

Comments
 (0)