Commit graph

429 commits

Author SHA1 Message Date
Michael Peterson
f656e210d9
Clarify the behavior of remote/info and resolve/cluster for connected status of remotes (#118993) (#121194) 2025-01-30 02:33:47 +11:00
Stanislav Malyshev
4012aec905
Add ESQL telemetry collection (#119474) (#119479)
* Add ESQL telemetry collection

(cherry picked from commit 0292905ef6)

# Conflicts:
#	server/src/main/java/org/elasticsearch/TransportVersions.java
2025-01-03 09:30:28 +11:00
Lisa Cawley
86d568ff26
[DOCS] More links to new API site (#119377) (#119417)
(cherry picked from commit ba8beecdb0)
2024-12-31 20:19:47 +00:00
Lisa Cawley
f2e457ccdb
[DOCS] Link to new API site (#119038) (#119361)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-12-31 04:18:27 +11:00
Martijn van Groningen
4b3ecd3358
[8.x] Add source mode stats to MappingStats (#117694)
Backporting #117463 to 8.x branch.
2024-11-28 12:07:26 +01:00
Stef Nestor
c0292825c9
(Doc+) link videos for allocation and ilm (#116880) (#117097)
* (Doc+) link videos for allocation and ilm

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-11-20 09:10:55 +11:00
David Turner
b88e9a6947
Add link to MAX_RETRY allocation explain docs (#115099)
Backport of #113657 to `8.x`

Co-authored-by: matthewabbott <ttobbatam@gmail.com>
2024-10-29 01:45:01 +11:00
David Turner
7e02a7cd36
Clarify status of response to voting config API (#115714) (#115732)
These APIs return no body, just a status code. This commit clarifies
that in the docs.

Closes #115462
2024-10-28 17:33:56 +11:00
Panagiotis Bailis
3256f8bf90
Add telemetry for retrievers (#114109) (#114474) 2024-10-10 20:18:02 +11:00
Benjamin Trent
f057ff72c4
Add more dense_vector details for cluster stats field stats (#113607) (#113884)
This adds some more counts for dense_vector field mapping stats. This
allows for seeing the number of mappings with a given element type,
similarity, or index type.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-10-03 23:16:22 +10:00
Stanislav Malyshev
029cd94677
Implement remote cluster CCS telemetry (#112478) (#113814)
* Add remote cluster stats to _cluster/stats
* Implement remote cluster stats polling
* Add docs for the include_remotes part

(cherry picked from commit b26d81c713)
2024-10-01 04:52:59 +10:00
Luke Whiting
4ea42afb78
Note in docs about interpreting IO stats when running in docker (#113676) (#113685)
* Note in docs about incorrect IO stats when running in docker

* Update docs/reference/cluster/nodes-stats.asciidoc



* Requested PR changes to wording

* Update docs/reference/cluster/nodes-stats.asciidoc



---------

Co-authored-by: David Turner <david.turner@elastic.co>
2024-09-27 22:57:58 +10:00
Stanislav Malyshev
9081a951d5
Implement CCS telemetry export as part of _cluster/stats (#112310)
* Implement CCS telemetry export as part of _cluster/stats
2024-09-10 09:31:06 -06: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
David Turner
f150e2c11d
Add telemetry for repository usage (#112133)
Adds to the `GET _cluster/stats` endpoint information about the snapshot
repositories in use, including their types, whether they are read-only
or read-write, and for Azure repositories the kind of credentials in
use.
2024-08-27 23:34:02 +10:00
Stef Nestor
f37440f441
(Doc+) Allocation Explain Examples: THROTTLED, MAX_RETRY (#111558)
Adds [Allocation Explain examples](https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html#cluster-allocation-explain-api-examples) for `THROTTLED` and `MAX_RETRY`. Also formats sub TOC so that we can after link code message to those docs.
2024-08-22 08:16:36 -06:00
Stef Nestor
c1019d4c5d
(Doc+) Link API doc to parent object - part1 (#111951)
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-08-20 14:58:18 -06:00
Larisa Motova
9ac0718d90
Add docs for shard level stats in node stats (#111082)
Fixes #111081
2024-08-13 14:59:03 +03:00
Nhat Nguyen
f275dff609
Add Lucene segment-level fields stats (#111123)
This change returns the total number of fields at the segment level, 
allowing for a more accurate estimate of the memory used by Lucene. The
new estimate is expected to be closer to the actual memory usage than
the current estimate using the index-level field count, due to the
non-trivial overhead incurred by each Lucene segment. Two new fields are
introduced: total_segment_fields, which is the total number of fields at
the segment level, and average_fields_per_segment. The overhead per
field in segments with fewer fields is larger than in segments with many
fields.
2024-07-23 08:52:39 -07: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
Alexander Reelsen
4de67ad7f0
DocsStats: Add human readable bytesize (#109720)
This adds support for the `human` parameter for DocsStats, as it was
missing. Sample

```
GET _cluster/stats?human&filter_path=indices.docs
```
2024-06-15 08:20:04 +10:00
Annie Hansen
582c6c0400
(DOC +) Add resolutions to Allocation Explain examples (#108263)
* (DOC +) Add resolutions to Allocation Explain examples

* Update docs/reference/cluster/allocation-explain.asciidoc

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

* Update docs/reference/cluster/allocation-explain.asciidoc

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

* Update docs/reference/cluster/allocation-explain.asciidoc

Co-authored-by: David Turner <david.turner@elastic.co>

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
2024-05-22 14:39:27 -06:00
Parker Timmins
3662d12c9f
Return ingest byte stats even when 0-valued (#108796)
Change the ingest byte stats to always be returned
whether or not they have a value of 0. Add human readable
form of byte stats. Update docs to reflect changes.
2024-05-20 10:52:16 -05:00
Parker Timmins
298c6492a5
Make ingest byte stat names more descriptive (#108786)
Current ingest byte stat fields could easily be confused.
Add more descriptive name to make it clear that they do not
count all docs processed by the pipeline.
2024-05-17 12:03:42 -05:00
Larisa Motova
a01baa3d79
Include doc size info in ingest stats (#107240)
Add ingested_in_bytes and produced_in_bytes stats to pipeline ingest stats.
These track how many bytes are ingested and produced by a given pipeline.
For efficiency, these stats are recorded for the first pipeline to process a 
document. Thus, if a pipeline is called as a final pipeline after a default pipeline,
as a pipeline processor, and after a reroute request, a document will not 
contribute to the stats for that pipeline. If a given pipeline has 0 bytes recorded
for both of these stats, due to not being the first pipeline to run any doc, these
stats will not appear in the pipeline's entry in ingest stats.
2024-05-17 08:53:24 -05:00
Nick Tindall
3ecdd77e97
[DOCS] Align docs to implementation for timeout parameters (#108593)
* [DOCS] Fix documentation for timeout-related parameters

Closes #108224
2024-05-16 13:05:39 +10:00
Liam Thompson
9a62dba53c
[DOCS] Remove remaining beta flags for RCS (#108201) 2024-05-03 09:12:37 +02:00
David Turner
f9c414c5e3
Fix up hot threads timeout docs (#107692)
The hot threads API does not support a `?master_timeout` parameter, and
the `?timeout` parameter is not an ack timeout and defaults to an
infinite wait. This commit fixes the incorrect docs.
2024-04-22 08:45:00 -04:00
Howard
dcb248a013
Add node stats effective watermark thresholds docs (#107668)
Relates https://github.com/elastic/elasticsearch/pull/107244
2024-04-21 15:31:11 +01: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
Artem Prigoda
6a300509cd
Add metric for calculating index flush time excluding waiting on locks (#107196)
Add a new `total_time_excluding_waiting_on_lock metric` to the index flush stats that measures the flushing time excluding waiting on the flush lock. This metrics provides a more granular view on flush performance and without the overhead of flush throttling.

Resolves ES-7201
2024-04-12 15:04:08 +02:00
Volodymyr Krasnikov
0faac52ac4
Metric for rejected indexing primary operations (per document) (#107080)
* Fix number of rejected primary operations

* Update docs/changelog/107080.yaml

* Update test

* Add metric 'es.indexing.primary_operations.document.rejections.ratio' + test

* rm useless changelog

* update docs

* use -1 as a default version on unsupported version
2024-04-07 21:09:58 -07:00
David Turner
7ee63dfd51
Expand docs on reset desired balance API (#106921)
Explains its purpose and surrounding context a little more, including a
note that this should never be necessary (i.e. if you find you need it,
that's a bug).
2024-04-02 04:18:59 -04:00
Parker Timmins
e59dd0b60e
Add total size in bytes to doc stats (#106840) 2024-03-29 09:40:37 -05:00
Yang Wang
5632380ecd
[Doc] Trivial correction for shard allocator choice (#106216)
Relates: #105894
2024-03-12 18:34:22 +11:00
Ievgen Degtiarenko
5e52059947
Add allocation stats (#105894)
This change attempts to add allocation section to the node stats in
order to simplify unbalanced clusters debugging. It is required for
https://github.com/elastic/elasticsearch/pull/97561
2024-03-11 11:07:56 -04:00
Stef Nestor
18a509a18f
(DOC+) Node Stats fs.available reflects XFS quotas (#106085)
Moving https://github.com/elastic/elasticsearch/pull/103472 here.

---

👋 howdy, team!

Could we include "XFS quotas" as an example for "depending on OS or process level restrictions" for this doc's searchability for users to better understand how to investigate this potential lever's impact?

TIA!
2024-03-08 10:19:27 -05:00
Liam Thompson
52b027e44b
[DOCS] Fix bullet in get-desired-balance ref (#105819)
Fix formatting
2024-02-29 09:32:50 +01:00
Lorenzo Dematté
0e328dbfc8
DesiredNode: deprecate node_version field and make it optional (unused) in current parser (#104209)
Deprecated node_version field, made it optional(unused) in new parser
Added deprecation warning handler for mixed cluster
Split tests for old vs. current format
2024-01-29 14:09:45 +01:00
Ievgen Degtiarenko
70ecb12556
Add undesired shard count (#101426)
This change add undesired shard (ones that are allocated not on the desired
node) counts to the api output.
2023-11-02 09:44:48 +01:00
Simon Cooper
3f32affbb6
Add component info versions to node info in a pluggable way (#99631)
This adds a `ComponentVersionNumber` service interface for modules to provide version numbers for individual components to be reported inside node info. Initial implementations for `MlConfigVersion` and `TransformConfigVersion` are provided.
2023-09-21 17:08:43 +01:00
Simon Cooper
8726f1653f
Add IndexVersion to node info (#99515)
This adds index_version field to node info, so we can read it in bwc tests to determine the index version we are upgrading from
2023-09-14 10:09:51 +01:00
Yang Wang
ebe4fe9f15
[Doc] Add links to the new API key based remote cluster page (#99115)
This PR adds links to the new API key based remote cluster page in
multiple places.

Relates: #98330
2023-09-01 06:08:49 -04:00
Dianna Hohensee
a25e176692
Add node "roles" to allocation explain response (#98550)
Report node "roles" in the /_cluster/allocation/explain response.
Nodes with limited sets of roles may affect shard distribution in ways
users did not originally consider, so it is helpful to surface this
information along with node allocation decision explanations.
2023-08-23 08:30:35 -04:00
Yang Wang
b337f9b6f3
[Docs] Misc doc update for RCS 2.0 (#98472)
This PR adds docs for the following items: * Remote indices privileges *
Remote cluster network settings * Remote cluster security settings * New
privileges * New response field for RemoteInfo API

List of preview pages: * [Remote indices in defining
roles](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/defining-roles.html#roles-remote-indices-priv)
* [Remote indices in PutRole
API](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-api-put-role.html#security-api-put-role-request-body)
* [Remote cluster server SSL
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-settings.html#_remote_cluster_server_api_key_based_model_tlsssl_settings)
* [Remote cluster client SSL
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-settings.html#_remote_cluster_client_api_key_based_model_tlsssl_settings)
* [Remote cluster network
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/modules-network.html#remote-cluster-network-settings)
and
[here](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/modules-network.html#common-network-settings)
* [Remote cluster credentials
setting](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/remote-clusters-settings.html)
* [New
privileges](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-privileges.html)
* [New response field for RemoteInfo
API](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html#cluster-remote-info-api-response-body)
2023-08-15 20:11:21 -04: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
Carlos Delgado
8e64359fb1
Change cluster stats synonyms keys (#98126) 2023-08-04 17:28:12 +02:00
Abdon Pijpelink
efc0cb5422
[DOCS] Node stats API: fix descriptions of 'cache_size' and 'cache_count' (#98092) 2023-08-03 09:45:22 +02:00
Carlos Delgado
e300319afb
Synonym Rules APIs docs (#98064) 2023-08-02 14:11:30 +02:00
Carlos Delgado
c0a99baef5
Add synonyms sets information to cluster stats (#97900) 2023-07-27 21:25:24 +02:00