Commit graph

122 commits

Author SHA1 Message Date
Dimitrios Liappis
26b78c9850
[DOCS] Warn about impact of large readahead on search (#88007) (#88079)
When using LVM or software raid on Linux the kernel, or specific
distribution rules, may use higher ergonomic defaults for the
readahead of resulting block device(s). This can adversely affect
search performance due to high page cache thrashing, in search
heavy scenarios when mmap is involved.

Add a clarification section in the docs raising awareness about this
value and preferring the lower default.
2022-06-27 10:15:37 -04:00
James Rodewig
53ed187d63
[DOCS] Fix typos (#83895) (#83975)
Co-authored-by: Tobias Stadler <ts.stadler@gmx.de>
2022-02-15 13:05:01 -05:00
James Rodewig
da5fda0622
Add/update source block delimeters (#83624) (#83853)
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.

(cherry picked from commit 5ef77ef370)

Co-authored-by: edh-oss <42759970+edh-oss@users.noreply.github.com>
2022-02-11 15:44:20 -05:00
James Rodewig
eebbc7bff8
[DOCS] Remove 'step' from headings (#76753) (#82614)
(cherry picked from commit e246e1ce53)
2022-01-14 10:32:13 -05:00
David Turner
d85dd2f367
Oversharding is also indices and fields (#81511) (#81574)
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 04:04:00 -05:00
David Turner
f41a6ed615
Clarify unassigned.reason docs (#81017) (#81120)
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>

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2021-11-29 14:44:32 -05:00
Stef Nestor
8dd0217b0c
[+DOC] Tasks' Queue backup (#80447) (#80612)
* Add Tasks queue backup troubleshooting
Co-authored-by: Deb Adair <debadair@elastic.co>
2021-11-10 10:58:58 -05:00
James Rodewig
c651bcfb1b [DOCS] Fix cluster get settings API refs 2021-11-05 17:20:56 -04:00
James Rodewig
58d84cdcc3
[DOCS] Fix cluster update settings refs (#79580) (#79581)
The API is named 'cluster update settings,' not 'update cluster settings.'
2021-10-20 13:25:54 -04:00
Nikola Grcevski
8512037aaa
[7.x] Deprecation of transient cluster settings (#78794) (#79288)
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 19:06:33 -04:00
James Rodewig
3641fd8327
[DOCS] Troubleshoot the flood-stage watermark error (#78519) (#78555)
Adds troubleshooting steps for the flood-stage watermark error.

Closes #77906.
2021-10-01 09:02:55 -04:00
James Rodewig
4f79234a35
[DOCS] Use dedicated hosts for ES (#77582) (#78147)
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>

Co-authored-by: Stef Nestor <steffanie.nestor@gmail.com>
2021-09-21 18:02:54 -04:00
James Rodewig
20e3d4d819
[DOCS] Remove shrink snippet from 'Size your shards' (#77593) (#77696)
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 09:09:25 -04:00
James Rodewig
9339271ed2
[DOCS] Add max open shards error to 'Size your shards' (#77287) (#77556)
Changes:

* Adds a troubleshooting section and documents the `maximum shards open` error.
* Retitles the `Fix an oversharded cluster` to `Reduce a cluster's shard count`.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Stef Nestor <steffanie.nestor@gmail.com>
2021-09-10 11:19:35 -04:00
Julie Tibshirani
bd47e6c151
Mention match_only_text in disk usage docs (#76416) (#76498)
* 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>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2021-08-13 10:12:01 -04:00
James Rodewig
4dc1df4f8a
[DOCS] Note assumptions for shard size and count recommendations (#76353) (#76495)
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:57:16 -04:00
James Rodewig
8ec5c2f9b8
[DOCS] Add docs for rejected requests and high CPU usage (#72640) (#75944)
Adds docs for rejected requests and high CPU usage.

Closes #72468.

Closes #69868.
2021-08-02 09:24:53 -04:00
James Rodewig
518971064d [DOCS] Remove unneeded screenshot from 'Size your shards' docs 2021-07-27 15:47:51 -04:00
James Rodewig
f97d65771f
[DOCS] Note required node roles and data tiers (#74566) (#75048)
Closes #74528 and #74565
2021-07-07 10:06:42 -04:00
James Rodewig
9117b29aff
[DOCS] Move ES glossary to Stack docs (#74579) (#74583)
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:14:24 -04:00
James Rodewig
dfe4dad935 [DOCS] Remove unneeded on-page TOC 2021-06-17 08:41:14 -04:00
James Rodewig
046e8b9327 Remove unneeded word 2021-06-02 15:12:52 -04:00
James Rodewig
2b68086c4a
[DOCS] Revise shard size guidelines to 50GB (#73686) (#73691)
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:58:21 -04:00
James Rodewig
69dc48a688
[DOCS] Note circuit breakers reject requests with 429 HTTP status code (#69864) (#73674)
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>

Co-authored-by: Luca Belluccini <luca.belluccini@elastic.co>
2021-06-02 10:41:47 -04:00
James Rodewig
5ada3993dd
[DOCS] Remove _all examples from 'Fix common cluster issues' (#73217) (#73234)
We plan to deprecate the `_all` wildcard pattern. This removes several
`_all` examples from the 'Fix common cluster issues' guide.
2021-05-19 08:53:56 -04:00
James Rodewig
fef5baa8bc
[DOCS] Add 'Fix common cluster issues' docs (#72097) (#72384) 2021-04-28 08:48:10 -04:00
James Rodewig
83a934e43d [DOCS] Remove uneeded 'How to' from title 2021-04-23 09:59:12 -04:00
James Rodewig
f6fcaa135e [DOCS] Consistent leading slash in snippets 2021-04-19 16:29:27 -04:00
James Rodewig
aaacb796f1
[DOCS] Update size your shards for max_primary_shard_size (#71367) (#71372) 2021-04-07 08:28:10 -04:00
James Rodewig
f27800abbb [DOCS] Swap event.original for message 2021-04-06 06:52:30 -04:00
James Rodewig
53685e9010
[DOCS] Add how-to guide for time series data (#71195) (#71296) 2021-04-05 15:03:20 -04:00
James Rodewig
4d43d3f881
[DOCS] Remove performance warning for script fields (#69309) (#69354) 2021-02-22 10:20:33 -05:00
James Rodewig
211cd8e718
[DOCS] Fix heading in disk usage tuning guide (#68519) (#68521) 2021-02-04 09:05:05 -05:00
James Rodewig
a54720cc1e
[DOCS] Add force merge disclaimer to tuning guide (#68491) (#68495)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Pius <pius@elastic.co>
2021-02-03 16:58:40 -05:00
David Turner
b2861bc804 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:37:29 +00:00
James Rodewig
674210f5df
[DOCS] Make cat API verbose query param explicit (#67300) (#67305) 2021-01-12 08:33:50 -05:00
James Rodewig
8021b7de3c
[DOCS] Fix outdated heap references (#66646) (#66711) 2020-12-21 14:14:05 -05:00
James Rodewig
0d797491eb
[DOCS] Fix redirects and anchors (#65472) (#65475) 2020-11-24 20:00:03 -05:00
Wylie Conlon
4d9f5b1867 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:56:02 -08:00
James Rodewig
819d13f80a
[DOCS] Add xref to data tiers content (#63426) (#63433) 2020-10-07 13:24:43 -04:00
Rafi Estrada
7c122498bd [Docs] Correct typo (#63102) 2020-10-02 10:16:44 +02:00
James Rodewig
b814d10063
[DOCS] Document shard sizing guide (#61942) (#62957)
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:57:39 -04:00
James Rodewig
6fc1bb011e remove xref from heading 2020-09-03 17:49:36 -04:00
James Rodewig
8613bde780
[DOCS] Combine keyword family docs (#61662) (#61813) 2020-09-01 15:32:56 -04:00
James Rodewig
60876a0e32
[DOCS] Replace Wikipedia links with attribute (#61171) (#61209) 2020-08-17 11:27:04 -04:00
James Rodewig
929f1cc9f9
[DOCS] Remove search request body page (#60972) (#60977) 2020-08-11 13:04:07 -04:00
James Rodewig
1b2a015734
[DOCS] Cross-link copy_to and search speed docs (#60926) (#60928) 2020-08-10 15:35:10 -04:00
James Rodewig
a761985fab
[DOCS] Move script and stored fields content to search fields page (#60826) (#60835)
Changes:

* Moves `Retrieve selected fields` to its own page and adds a title abbreviation.
* Adds existing script and stored fields content to `Retrieve selected fields`
* Adds a xref for `Retrieve selected fields` to `Search your data`
* Adds related redirects and updates existing xrefs
2020-08-06 13:06:06 -04:00
James Rodewig
fb599dc343
[DOCS] Add rollups to Tune for disk usage (#60436) (#60542)
Co-authored-by: Leaf-Lin <39002973+Leaf-Lin@users.noreply.github.com>
2020-07-31 16:10:57 -04:00
James Rodewig
771e9f142a
[DOCS] Move search pagination content to one page (#60515) (#60525) 2020-07-31 12:40:40 -04:00