Skip to content

Commit e0db207

Browse files
committed
cleanup, titles
1 parent bd6fba2 commit e0db207

File tree

6 files changed

+16
-36
lines changed

6 files changed

+16
-36
lines changed

500_Cluster_Admin.asciidoc

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[[cluster-admin]]
2-
== Cluster management and monitoring
32
include::500_Cluster_Admin/10_intro.asciidoc[]
43

54
include::500_Cluster_Admin/15_marvel.asciidoc[]
@@ -9,21 +8,3 @@ include::500_Cluster_Admin/20_health.asciidoc[]
98
include::500_Cluster_Admin/30_node_stats.asciidoc[]
109

1110
include::500_Cluster_Admin/40_other_stats.asciidoc[]
12-
13-
- management
14-
- cluster settings
15-
- dynamically changing logging
16-
- index settings
17-
18-
19-
- monitoring
20-
- marvel
21-
- cluster health
22-
- cluster stats
23-
- node stats / node info
24-
- rejections
25-
- index stats
26-
- hot threads
27-
- pending tasks
28-
29-
- cat api

500_Cluster_Admin/10_intro.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11

2-
3-
2+
== Cluster management and monitoring
43
Elasticsearch is often deployed as a cluster of nodes. There are a variety of
54
APIs that let you manage and monitor the cluster itself, rather than interact
65
with the data stored within the cluster.

500_Cluster_Admin/15_marvel.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
=== Marvel for Monitoring
2+
== Marvel for Monitoring
33

44
At the very beginning of the book (<<marvel>>) we encouraged you to install
55
Marvel, a management monitoring tool for Elasticsearch, because it would enable

500_Cluster_Admin/20_health.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
=== Cluster Health
2+
== Cluster Health
33

44
An Elasticsearch cluster may consist of a single node with a single index. Or it
55
may have a hundred data nodes, three dedicated masters, a few dozen clients nodes
@@ -73,7 +73,7 @@ replicas. For example, an index with 5 shards and 1 replica will have 5 unassig
7373
replicas in a single-node cluster. Unassigned shards will also be present if your
7474
cluster is red (since primaries are missing)
7575

76-
==== Drilling deeper: finding problematic indices
76+
=== Drilling deeper: finding problematic indices
7777

7878
Imagine something goes wrong one day, and you notice that your cluster health
7979
looks like this:
@@ -185,7 +185,7 @@ but due to the verbosity can difficult to work with. Once you know the index
185185
that is having problems, other APIs that we discuss in this chapter will tend
186186
to be more helpful.
187187

188-
==== Blocking for status changes
188+
=== Blocking for status changes
189189

190190
The Cluster Health API has another neat trick which is very useful when building
191191
unit and integration tests, or automated scripts that work with Elasticsearch.

500_Cluster_Admin/30_node_stats.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
=== Monitoring individual nodes
2+
== Monitoring individual nodes
33

44
Cluster Health is at one end of the spectrum -- a very high-level overview of
55
everything in your cluster. The _Node Stats_ API is at the other end. It provides
@@ -43,7 +43,7 @@ host, etc). These values are useful for debugging discovery problems, where
4343
nodes won't join the cluster. Often you'll see that the port being used is wrong,
4444
or the node is binding to the wrong IP address/interface.
4545

46-
==== Indices section
46+
=== Indices section
4747

4848
The indices section lists aggregate statistics for all the indices that reside
4949
on this particular node.
@@ -206,7 +206,7 @@ posting lists, dictionaries and bloom filters. A very large number of segments
206206
will increase the amount of overhead lost to these data structures, and the memory
207207
usage can be a handy metric to gauge that overhead.
208208

209-
==== OS and Process Sections
209+
=== OS and Process Sections
210210

211211
The OS and Process sections are fairly self-explanatory and won't be covered
212212
in great detail. They list basic resource statistics such as CPU and load. The
@@ -222,7 +222,7 @@ monitoring stack. Some stats include:
222222
- Swap usage
223223
- Open file descriptors
224224

225-
==== JVM Section
225+
=== JVM Section
226226

227227
The JVM section contains some critical information about the JVM process which
228228
is running Elasticsearch. Most importantly, it contains garbage collection details,
@@ -390,7 +390,7 @@ Our best advice is to collect collection counts and duration periodically (or us
390390
and keep an eye out for frequent GCs. You can also enable slow-GC logging,
391391
discussed in <<TODO>>
392392

393-
==== Threadpool Section
393+
=== Threadpool Section
394394

395395
Elasticsearch maintains a number of threadpools internally. These threadpools
396396
cooperate to get work done, passing work between each other as necessary. In
@@ -468,7 +468,7 @@ are good to keep an eye on:
468468
- `search`: all search and query requests
469469
- `merging`: threadpool dedicated to managing Lucene merges
470470

471-
==== FS and Network sections
471+
=== FS and Network sections
472472

473473
Continuing down the Node Stats API, you'll see a bunch of statistics about your
474474
filesystem: free space, data directory paths, disk IO stats, etc. If you are
@@ -508,7 +508,7 @@ keep-alive connections are important for performance, since building up and tear
508508
down sockets is expensive (and wastes file descriptors). Make sure your clients
509509
are configured appropriately.
510510

511-
==== Circuit Breaker
511+
=== Circuit Breaker
512512

513513
Finally, we come to the last section: stats about the field data circuit breaker
514514
(introduced in <<circuit_breaker>>):

500_Cluster_Admin/40_other_stats.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
=== Cluster Stats
2+
== Cluster Stats
33

44
The _Cluster Stats_ API provides very similar output to the Node Stats. There
55
is one crucial difference: Node Stats shows you statistics per-node, while
@@ -19,7 +19,7 @@ The API may be invoked with:
1919
GET _cluster/stats
2020
----
2121

22-
=== Index Stats
22+
== Index Stats
2323

2424
So far, we have been looking at _node-centric_ statistics. How much memory does
2525
this node have? How much CPU is being used? How many searches is this node
@@ -60,7 +60,7 @@ operating in different environments.
6060
Index-centric stats are a useful tool to keep in your repertoire, but are not usually
6161
the first tool to reach for.
6262

63-
=== Pending Tasks
63+
== Pending Tasks
6464

6565
There are certain tasks that only the master can perform, such as creating a new
6666
index or moving shards around the cluster. Since a cluster can only have one
@@ -154,7 +154,7 @@ cluster state size.
154154
- Spin up another cluster once a certain threshold has been crossed.
155155
****
156156

157-
==== Cat API
157+
=== Cat API
158158

159159
If you work from the command line often, the _Cat_ APIs will be very helpful
160160
to you. Named after the linux `cat` command, these APIs are designed to be

0 commit comments

Comments
 (0)