Commit graph

128 commits

Author SHA1 Message Date
vincetrumental
05b7664272
correct way of getting node heap size (#85045)
* correct way of getting node heap size

in [[shard-count-recommendation]], we explain that the number of shards should be at most 20 shards per GB of heap. 
but the command to get relevant heap size should be _cat/nodes?v=true&h=heap.max and not _cat/nodes?v=true&h=heap.current . The latter gives the current memory consumption, which is alway moving. Here we need to consider the max allocated heap size (-Xmx)

* Adds heap.max to valid columns

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-05-11 09:59:34 -04:00
David Turner
ff742fcb27
More balanced docs about NFS etc (#85060)
Today we don't really say anything about the requirements for the data
path in terms of correctness, and we specifically say to avoid NFS for
performance reasons. This isn't wholly accurate: some NFS
implementations work just fine. This commit documents a more balanced
position on local vs remote storage.
2022-03-18 13:01:59 +00:00
Tobias Stadler
e3deacf547
[DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
edh-oss
5ef77ef370
Add/update source block delimeters (#83624)
Asciidoc source blocks are to be delimited with four dashes. This adds missing delimiters, and updates some that contained only three dashes. It matters for parsing purposes.
2022-02-11 14:19:30 -05:00
David Turner
7d69f1a974
Oversharding is also indices and fields (#81511)
Today the _Size your shards_ docs focus on shard size and count, but in
fact index count and field count are also important. This commit expands
these docs a bit to cover this observation too.
2021-12-09 08:51:36 +00:00
David Turner
ca65718923
Clarify unassigned.reason docs (#81017)
Today we indicate that the `unassigned.reason` field in various APIs
indicates the reason why a shard is unassigned. This isn't really true,
it tells you some information about the event that caused the shard to
_become_ unassigned (or which most recently changed its routing table
entry while remaining unassigned) but tells you almost nothing about why
the shard _is now_ unassigned and how to fix it. That's what the
allocation explain API is for. This commit clarifies this point in the
docs.

Closes #80892

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2021-11-29 18:47:01 +00:00
Adam Locke
247d124666
[DOCS] Update ES quick start for security ON by default (#80735)
* [DOCS] Update ES quick start for security ON by default

* Remove code.asciidoc, which is part of the overall doc build now

* Update node names for cleanup

* Add note with links to tools

* Add --net elastic network

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-11-17 17:48:07 -05:00
Stef Nestor
bc7c82c6b2
[+DOC] Tasks' Queue backup (#80447)
* Add Tasks queue backup troubleshooting
Co-authored-by: Deb Adair <debadair@elastic.co>
2021-11-10 08:47:16 -07:00
James Rodewig
f4bfdee5db [DOCS] Fix cluster get settings API refs 2021-11-05 17:20:17 -04:00
James Rodewig
58abbe941f
[DOCS] Fix cluster update settings refs (#79580)
The API is named 'cluster update settings,' not 'update cluster settings.'
2021-10-20 13:16:35 -04:00
Nikola Grcevski
055c770083
Deprecation of transient cluster settings (#78794)
This PR changes uses of transient cluster settings to
persistent cluster settings. 

The PR also deprecates the transient settings usage.

Relates to #49540
2021-10-15 13:00:52 -04:00
James Rodewig
9e0299f551
[DOCS] Troubleshoot the flood-stage watermark error (#78519)
Adds troubleshooting steps for the flood-stage watermark error.

Closes #77906.
2021-10-01 08:32:53 -04:00
Stef Nestor
e1062803bb
[DOCS] Use dedicated hosts for ES (#77582)
In production, we recommend you run {es} on a dedicated host or as a primary service.
This adds that best practice to our setup documentation.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-09-21 17:50:21 -04:00
James Rodewig
201a328d0c
[DOCS] Remove shrink snippet from 'Size your shards' (#77593)
The current shrink API snippet doesn't show you how to remove replicas or reduce primary shards.

Rather than duplicate those instructions from the shrink API docs, this removes the snippet. A link to the shrink API and shrink ILM action docs is already provided.

It also updates a delete index API snippet to avoid wildcards. Wildcard expansion for the delete index API is disabled by default in 8.0.
2021-09-14 08:59:41 -04:00
James Rodewig
434843e66c [DOCS] Fix typo 2021-09-10 10:56:37 -04:00
Stef Nestor
95a8c80f3d
[DOCS] Add max open shards error to 'Size your shards' (#77287)
* [+DOC] ERROR: maximum shards open

Appending common error into our Shard sizing docs along w/extra resources commonly viewed from [this Elastic Discuss](https://discuss.elastic.co/t/how-to-fix-hitting-maximum-shards-open-error/200502/2). Top 4 viewed error last 30d on Elastic Discuss.

Kindly assist
- fixing resource links
- I'm debating including [the cluster setting you can temporarily override](https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-cluster.html#cluster-shard-limit), but have left it off so far. Would love your thoughts!

* reorg + edits

* review feedback

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-09-10 09:41:30 -04:00
James Rodewig
e246e1ce53
[DOCS] Remove 'step' from headings (#76753) 2021-08-20 08:52:04 -04:00
Julie Tibshirani
2ddbd62291
Mention match_only_text in disk usage docs (#76416)
* Mention match_only_text in disk usage docs

Previously we explained how to manually disable norms, freqs, and positions. We
now have a ready-made solution in the new `match_only_text` field type.

* Fixing typo and minor grammar changes

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2021-08-13 09:31:09 -04:00
James Rodewig
27d28e1976
[DOCS] Note assumptions for shard size and count recommendations (#76353)
On the "Size your shards" page, the shard size recommendation assumes a time
series use case. Similarly, users shouldn't count nearly empty and rarely used
Enterprise Search system indices against the recommended shard count limit.

Closes #76328.
2021-08-13 08:44:19 -04:00
James Rodewig
55c4138b10
[DOCS] Add docs for rejected requests and high CPU usage (#72640)
Adds docs for rejected requests and high CPU usage.

Closes #72468.

Closes #69868.
2021-08-02 09:11:23 -04:00
James Rodewig
318927341e [DOCS] Remove unneeded screenshot from 'Size your shards' docs 2021-07-27 15:47:10 -04:00
James Rodewig
76938006ab
[DOCS] Note required node roles and data tiers (#74566)
Closes #74528 and #74565
2021-07-07 09:57:32 -04:00
James Rodewig
2fe07014d9
[DOCS] Move ES glossary to Stack docs (#74579)
The ES glossary is now incorporated into the [Elastic glossary](https://www.elastic.co/guide/en/elastic-stack-glossary/current/terms.html).

Depends on https://github.com/elastic/stack-docs/pull/1722 and https://github.com/elastic/docs/pull/2141
2021-06-24 19:04:31 -04:00
James Rodewig
e111c39da0 [DOCS] Remove unneeded on-page TOC 2021-06-17 08:40:56 -04:00
James Rodewig
712dbdc037 Remove unneeded word 2021-06-02 15:12:34 -04:00
James Rodewig
7f93d07ee3
[DOCS] Revise shard size guidelines to 50GB (#73686)
Changes:
* Revises the size your shards guide to use a 50GB shard guideline. This better aligns with our default in the ILM policy UI.
* Updates the language to indicate that the 50GB shard guideline is not a hard limit. Larger shards may work depending on the network and use case.

Reverts some changes added in #71367.
2021-06-02 13:41:40 -04:00
Luca Belluccini
3e41d753e3
[DOCS] Note circuit breakers reject requests with 429 HTTP status code (#69864)
We mention Elasticsearch returns 429 if the circuit breaker trips in https://www.elastic.co/blog/improving-node-resiliency-with-the-real-memory-circuit-breaker, but there is no mention in the docs.

This adds an xref to circuit breaker errors section.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-06-02 10:31:24 -04:00
James Rodewig
c9a09e33e5
[DOCS] Remove _all examples from 'Fix common cluster issues' (#73217)
We plan to deprecate the `_all` wildcard pattern. This removes several
`_all` examples from the 'Fix common cluster issues' guide.
2021-05-19 08:37:16 -04:00
James Rodewig
f8666b930f
[DOCS] Add 'Fix common cluster issues' docs (#72097) 2021-04-28 08:28:51 -04:00
James Rodewig
d94af832c5 [DOCS] Remove uneeded 'How to' from title 2021-04-23 10:07:13 -04:00
James Rodewig
048ad99116 [DOCS] Consistent leading slash in snippets 2021-04-19 16:29:08 -04:00
James Rodewig
b127447548 [DOCS] Fix cat API name 2021-04-06 17:17:05 -04:00
James Rodewig
1f361ad2d1
[DOCS] Update size your shards for max_primary_shard_size (#71367) 2021-04-06 17:08:24 -04:00
James Rodewig
07e9c6aca4 [DOCS] Swap event.original for message 2021-04-06 06:51:58 -04:00
James Rodewig
94d88082ec [DOCS] Swap message for event.original 2021-04-05 13:57:59 -04:00
James Rodewig
c23f001151
[DOCS] Add how-to guide for time series data (#71195) 2021-04-05 13:00:06 -04:00
James Rodewig
e4962994ff
[DOCS] Remove performance warning for script fields (#69309) 2021-02-22 10:05:49 -05:00
James Rodewig
9e7a27e085
[DOCS] Fix heading in disk usage tuning guide (#68519) 2021-02-04 08:52:12 -05:00
Pius
399e11b7e7
[DOCS] Add force merge disclaimer to tuning guide (#68491)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-02-03 16:42:01 -05:00
David Turner
2adeb4a666
Expand and consolidate networking docs (#68051)
Today's network config docs are split into "Network", "HTTP" and
"Transport" pages, with unclear relationships between them. We often
encounter users with weird configs that indicate they don't really
understand how these settings all relate. In fact these pages are all
very interrelated, and the HTTP and Transport pages are almost all only
for advanced users. This commit brings these docs into a single page and
rewords some things to try and guide users away from the advanced
settings unless their configuration needs all the extra complexity.

It also adds a section entitled "Binding and publishing" which clarifies
the meanings of the `bind_host` and `publish_host` parameters. This is
also a common source of confusion amongst users.

It also clarifies that many of these settings accept a list of
addresses, and warns that this may not be what you want. Closes #67956.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2021-02-01 13:06:20 +00:00
James Rodewig
cb3e0051e0
[DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00
James Rodewig
e9c1cded98
[DOCS] Fix outdated heap references (#66646) 2020-12-21 14:01:12 -05:00
James Rodewig
0805ff17a5
[DOCS] Fix redirects and anchors (#65472) (#65474) 2020-11-24 19:59:52 -05:00
Wylie Conlon
10ee0f2878
Clarify field data cache behavior in docs (#64375)
* Clarify that field data cache includes global ordinals
* Describe that the cache should be cleared once the limit is reached
* Clarify that the `_id` field does not supported aggregations anymore
* Fold the `fielddata` mapping parameter page into the `text field docs
* Improve cross-linking
2020-11-20 13:53:23 -08:00
James Rodewig
2ae0d2cb6e
[DOCS] Add xref to data tiers content (#63426) 2020-10-07 13:10:42 -04:00
Rafi Estrada
907d0eb696
[Docs] Correct typo (#63102) 2020-10-02 10:16:26 +02:00
James Rodewig
8bdf36d18b
[DOCS] Document shard sizing guide (#61942)
Revises the current 'How to avoid oversharding' docs to incorporate
information from our [shard sizing blog post][0].

Changes:

* Streamlines introduction
* Adds "Things to remember" section to describe how shards work
* Adds "Guidelines" section based on blog tips
* Creates a "Fix an oversharded cluster" section

[0]: https://www.elastic.co/blog/how-many-shards-should-i-have-in-my-elasticsearch-cluster
2020-09-28 09:24:40 -04:00
James Rodewig
95ff607857 remove xref from heading 2020-09-03 17:48:16 -04:00
James Rodewig
f881a695e1
[DOCS] Add redirects for wildcard and constant keyword (#61815) 2020-09-01 15:32:35 -04:00
James Rodewig
a94e5cb7c4
[DOCS] Replace Wikipedia links with attribute (#61171) 2020-08-17 09:44:24 -04:00