Commit graph

272 commits

Author SHA1 Message Date
Liam Thompson
28a1a4df5f
Update recovery.asciidoc (#114889) (#121217)
(cherry picked from commit d8874b6524)

Co-authored-by: Paulo <paulletilly@gmail.com>
2025-01-30 04:44:33 +11:00
shainaraskas
f4e2537ed0
[8.17] [DOCS] Concept cleanup 2 - ES settings (#119373) (#119643) 2025-01-10 10:31:05 -05:00
Lisa Cawley
ebceb76d49
[DOCS] More links to new API site (#119377) (#119418)
(cherry picked from commit ba8beecdb0)
2024-12-31 20:21:46 +00:00
Lisa Cawley
f6a2a991d5
[DOCS] Link to new API site (#119038) (#119360)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-12-31 04:18:27 +11:00
Slobodan Adamović
4b9ffa0b0e
[DOCS] _cat/shards: clarify required permissions for restricted indices (#115650) (#115804)
Clarify security requirements when requesting detailed shard information
for restricted indices.

(cherry picked from commit 023c856c24)
2024-10-29 06:59:37 +11:00
Pooya Salehi
2c648e7a30
Document _cat/indices behavior when encountering source only indices (#114884) (#114919)
Closes https://github.com/elastic/elasticsearch/issues/114546
2024-10-17 02:03:08 +11:00
Simon Cooper
ceb9deff89
Use deprecation logger for CLDR date format specifiers (#112917)
The addition of the logger requires several updates to tests to deal with the possible warning, or muting if there is not way to specify an allowed (but not mandatory) warning
2024-09-19 15:50:37 +01:00
Stef Nestor
a5dad1fe0e
(Doc+) CAT Nodes default columns (#112715) (#112772)
👋 howdy, team!

1. Related to https://github.com/elastic/dev/issues/2631, highlights customers are usually seeking `heap.percent` instead of `ram.percent`
2. Aligns the claimed "(Default)" columns in doc to what returned for v8.15.1 test cluster
2024-09-12 07:54:54 +10:00
Luke Whiting
0426e1fbd5
(API) Cluster Health report unassigned_primary_shards (#111727) (#112024)
This PR adds a count of currently unassigned primary shards to both the
`/_cat/health` and `/_cluster/health` endpoints. This is to aid cluster
administrators in estimating the time remaining for a cluster to go from
RED to YELLOW status as per enchancement request #111727.

Tests and doc updates are in place with this PR and manual testing with
`./gradlew run` has been conducted on the endpoints to ensure correct
output.

## Known Limitations * Testing   * Due to limitations in the YAML REST
test framework skip functionality, YAML REST tests for this endpoint are
disabled when running a mixed version cluster by using a cluster version
number synthetic feature to skip when any member of the cluster is not
at a version greater than when this change is due to be introduced
2024-09-02 20:00:06 +10:00
shainaraskas
50bccf5609
Round up shard allocation / recovery / relocation concepts (#109943) 2024-07-25 14:44:57 -04:00
Ed Savage
c214457b39
[ML] Handle the "output memory allocator bytes" field (#109653)
Handle the "output memory allocator bytes" field if and only if it is present in the model size stats, as reported by the C++ backend.

This PR _must_ be merged prior to the corresponding `ml-cpp` one, to keep CI tests happy.
2024-06-18 15:25:05 +12:00
Kathleen DeRusso
8529bf71f6
Add SparseVectorStats (#108793)
* Add SparseVectorStats

* Update to use mappings in engine

* Update to be unique to primary shards

* Fix doc

* Fix null error in test

* Cleanup

* fix yaml

* remove comment

* add version to yaml

* Revert whitespace changes to stats doc

* fix yml test

* Checkstyle

* Fix NPE in test

* Update docs/changelog/108793.yaml

* Add link to sparse_vector field type in docs

* PR feedback

* Flesh out test a bit more

* PR feedback - alphabetize placement in docs

* Fix doc change
2024-06-17 11:42:14 -04:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Ievgen Degtiarenko
92f6197819
Add index forecasts to /_cat/allocation output (#97561)
This change adds shard size and ingest load forecasts to /_cat/allocation output
2024-03-12 12:36:25 +01:00
Stef Nestor
aba546d023
(API+) CAT Nodes alias for shard header to match CAT Allocation (#105847)
👋 howdy, team!  

Will you kindly consider adding `shards` as an alias to
`shard_stats.total_count` column for CAT Nodes to match its naming from
CAT Allocation? (The tests returned clean without changes which I hadn't
expected, so please let me know if I missed something.)

**Example**: To avoid running the default CAT Nodes & CAT Allocation
separately, you can run CAT Nodes

```
GET _cat/nodes?v&s=master,name&h=name,id,master,node.role,cpu,heap.percent,disk.*,sstc,uptime
```

Where `sstc` is `shards` from CAT Allocation. This is a 👶 API (+ its
doc) change to make the output more intuitive.
2024-03-05 12:10:58 -05:00
David Turner
4b1909a47b
Expose roles by default in cat allocation API (#101753)
In #96994 we added a column for node roles to the `GET _cat/allocation`
API but left it hidden by default to avoid changing behaviour. In fact
it's ok to change the behaviour of the CAT APIs since they're only
intended for human consumption, and it's awfully useful to see the node
roles in this API response, so this commit makes this column display by
default.
2023-11-07 16:35:34 -05:00
Lee Hinman
815d596daa
Add 'dataset' size to cat indices and cat shards (#98622)
* Add 'dataset' size to cat indices and cat shards

This adds the `dataset` computed size for the `/_cat/indices` and `/_cat/shards` APIs. This new
column is reported by default.

Resolves #95092
2023-08-22 15:36:32 -06:00
Jim Ferenczi
a5d21ce800
Add the total dense vector count in the indices stats output (#98275)
This change adds the total dense vector count to the output of the indices stats.
This is useful for observability in order to track the number of indexed vectors
in a cluster.

---------

Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com>
2023-08-11 23:17:38 +09:00
Ievgen Degtiarenko
bd7c0f55e5
Add shard_stats.total_count column description to /_cat/nodes docs. (#97549)
This column was implemented previously but not added to the docs. It might be
helpful to list it when troubleshooting cluster balance.
2023-07-11 10:09:04 +02:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/setup/restart-cluster.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/sql/endpoints/translate.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
Abdon Pijpelink
6e0071c510
[DOCS] Add documentation for cat component templates (#95035) 2023-04-05 16:51:11 +02:00
Iraklis Psaroudakis
ad8d064de5
Redefine section on sizing data nodes (#90274)
Now that we have the estimated field mappings heap overhead
in nodes stats, we can refer to them in the guide for sizing
data nodes appropriately.

Relates to #86639
2022-09-30 12:37:21 +03:00
Leaf-Lin
44c8d19b6d
Update snapshots.asciidoc (#87584)
Adding a typo ``` in the doc
2022-08-02 11:24:31 +02:00
Ryan Ernst
eed8da3919
Move the ingest attachment processor to the default distribution (#87989)
The ingest attachment processor is currently available as a plugin. This
commit moves the processor to the default distribution so it is always
available.
2022-06-28 02:10:36 -04:00
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
Armin Braun
f887ac22b4
Remove NIO Transport Plugin (#82085)
Removes NIO transport.
2022-04-12 11:00:26 +02:00
Tobias Stadler
e3deacf547
[DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
István Zoltán Szabó
a1d9d04c0e
[DOCS] Adds disclaimer to cat APIs (#83382)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-02-04 08:55:19 +01:00
Armin Braun
0b66c14b7e
Use Netty4 Transport in Internal Cluster Tests (#82088)
Removing the mock nio transport and replacing its usage with the netty transport to make tests
with a more realistic transport implementation. This way improves the real world coverage for
the Netty transport, makes our tests more realistic and saves lots of code.
In particular, coverage on the rather complicated throttling/chunking in the netty message handler
is really ice to have.
The downside of this change is that we lose the slow transport thread warnings that the mock transport
outputs. This isn't a big deal these days in my opinion as we have slow logging in other places
now that makes up for this (we didn't when initially adding the slow logging) and that contains
far more detailed information on what exactly was slow.
Other than that, the mock transport does not come with any features we don't also have in the Netty
transport at this point.
2022-01-17 12:34:35 +01: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
Lisa Cawley
f3a69ae4b1
[DOCS] Adds missing query parameters to ML APIs (#80863) 2021-11-22 09:25:01 -08:00
James Rodewig
f56a0f4b66
[DOCS] Remove testenv annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00
Stef Nestor
5929b48883
Update ThreadPoolTypes (#78882)
Hey team! In local testing, I was returning `fixed_auto_queue_size` from `GET _cat/thread_pool?v&h=nn,n,active,type` & wasn't sure how to interpret. From [this doc](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html#cat-thread-pool-query-params) it appears to be an unexpected value, but from [this code](https://github.com/elastic/elasticsearch/blob/master/server/src/main/java/org/elasticsearch/threadpool/ThreadPool.java#L83-L86) it should exist as well as `direct` (has note to remove in 9.0 but that's a ways off).
2021-10-13 13:42:14 -04:00
David Turner
d2bb6ebb69
Get-templates APIs don't support lists (#78989)
We document that `GET /_index_template/...` accepts a comma-separated
list of template names but in fact today this API accepts only a single
name or pattern. Likewise `GET /_cat/templates/...` (at least it didn't
until #78829 but that's not released yet). This commit fixes the docs to
indicate these APIs accept only a single template name and also adds
some extra validation to reject requests containing a `,` since such a
request cannot match any actual templates.

It also adjusts `GET /_cat/templates` to use the filtering built into
`TransportGetComposableIndexTemplateAction` rather than retrieving all
templates and then filtering them on the coordinating node.
2021-10-13 12:13:06 +01:00
James Rodewig
cfae69717a
[DOCS] Update anchor and add redirect for aliases (#77349)
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
2021-09-07 09:42:42 -04:00
Adrien Grand
d15445e0f3
Remove usage of RAM accounting of segments (#75674)
This is a pre-requisite for the upgrade to Lucene 9, which removes the ability to estimate RAM usage of segments.
2021-07-29 08:36:09 +02:00
Lisa Cawley
3c76bcb3a5
[DOCS] Fixes links to machine learning concepts (#75194) 2021-07-09 13:09:03 -07:00
James Rodewig
1de9bd4d2a
[DOCS] Update <alias> parameter for cat aliases API (#73526) 2021-05-28 10:03:46 -04:00
James Rodewig
5729bb8d49
[DOCS] Update alias references (#73427)
Updates several `index aliases` references to `aliases`.
2021-05-27 16:00:57 -04:00
James Rodewig
b1ad71b077
[DOCS] Add alias guide (#73062)
Creates a guide for aliases. We can use this guide to house concepts, examples,
and tips for aliases.
2021-05-25 11:52:16 -04:00
Yang Cheng
7458b472cd
[Doc]Missing xpack role in cat transforms (#73310) 2021-05-25 08:44:59 -07:00
James Rodewig
693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
Yannick Welsch
529c6227fe
Support include_unloaded_segments in node stats (#69682)
Adds support for the include_unloaded_segments flag in node stats, which helps with understanding resource usage of
shared_cache-style searchable snapshots on a per-node basis.
2021-03-01 17:18:47 +01:00
James Rodewig
a453a9267d
[DOCS] Add frozen node to cat nodes API (#69228) 2021-02-22 11:24:21 -05:00
James Rodewig
14ea0072e9
[DOCS] Update priority recommendation for index templates (#69006) 2021-02-16 10:53:28 -05:00
Hendrik Muhs
54ed2e37d9
[Transform] implement retention policy to delete data from a transform (#67832)
add a retention policy to transform to delete data that is considered outdated as part of a
transform checkpoint.

fixes #67916
2021-02-08 15:06:15 +01:00
James Rodewig
5476d8a6e0
[DOCS] Document cat allocation API response properties (#65635) 2021-02-03 12:58:35 -05:00
Hendrik Muhs
cf08c0e6ab
[Transform] refactor cat transform to show more useful information (#68232)
Refactoring of cat transform to show more relevant information. The current cat transform shows a
lot of configuration details, however cat should show operationally useful information. This PR
changes the defaults and also adds when transform did a search last.
2021-02-02 07:29:20 +01:00
James Rodewig
b7388316b9
[DOCS] Add security privileges to cat API docs (#67467) 2021-01-20 10:19:20 -05:00
James Rodewig
cb3e0051e0
[DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00