Skip to content

Add docs for new item_count API for field data cache #11037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 29, 2025
Merged

Add docs for new item_count API for field data cache #11037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d8b6c7
fd improvements
Sep 25, 2025
7188a23
Update _search-plugins/caching/field-data-cache.md
kolchfa-aws Sep 29, 2025
61999f3
Update _install-and-configure/configuring-opensearch/index-settings.md
natebower Sep 29, 2025
0af115b
Merge branch 'main' into fd-items-docs
peteralfonsi Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _api-reference/cluster-api/cluster-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,8 @@ response = client.cluster.stats(
},
"fielddata": {
"memory_size_in_bytes": 664,
"evictions": 0
"evictions": 0,
"item_count": 1
},
"query_cache": {
"memory_size_in_bytes": 0,
Expand Down
12 changes: 8 additions & 4 deletions _api-reference/index-apis/stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@ By default, the returned statistics are aggregated in the `primaries` and `total
},
"fielddata": {
"memory_size_in_bytes": 0,
"evictions": 0
"evictions": 0,
"item_count": 0
},
"completion": {
"size_in_bytes": 0
Expand Down Expand Up @@ -507,7 +508,8 @@ By default, the returned statistics are aggregated in the `primaries` and `total
},
"fielddata": {
"memory_size_in_bytes": 0,
"evictions": 0
"evictions": 0,
"item_count": 0
},
"completion": {
"size_in_bytes": 0
Expand Down Expand Up @@ -678,7 +680,8 @@ By default, the returned statistics are aggregated in the `primaries` and `total
},
"fielddata": {
"memory_size_in_bytes": 0,
"evictions": 0
"evictions": 0,
"item_count": 0
},
"completion": {
"size_in_bytes": 0
Expand Down Expand Up @@ -845,7 +848,8 @@ By default, the returned statistics are aggregated in the `primaries` and `total
},
"fielddata": {
"memory_size_in_bytes": 0,
"evictions": 0
"evictions": 0,
"item_count": 0
},
"completion": {
"size_in_bytes": 0
Expand Down
4 changes: 3 additions & 1 deletion _api-reference/nodes-apis/nodes-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,8 @@ Select the arrow to view the example response.
},
"fielddata" : {
"memory_size_in_bytes" : 356,
"evictions" : 0
"evictions" : 0,
"item_count": 1
},
"completion" : {
"size_in_bytes" : 0,
Expand Down Expand Up @@ -1008,6 +1009,7 @@ query_cache.evictions | Integer | The number of evictions from the query cache.
fielddata | Object | Statistics about the field data cache for all shards in the node.
fielddata.memory_size_in_bytes | Integer | The total amount of memory used for the field data cache for all shards in the node.
fielddata.evictions | Integer | The number of evictions in the field data cache.
fielddata.item_count | Integer | The number of items in the field data cache.
fielddata.fields | Object | Contains all field data fields.
completion | Object | Statistics about completions for all shards in the node.
completion.size_in_bytes | Integer | The total amount of memory used for completion for all shards in the node, in bytes.
Expand Down
3 changes: 2 additions & 1 deletion _search-plugins/caching/field-data-cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ The response contains the cache statistics:
"indices" : {
"fielddata" : {
"memory_size_in_bytes" : 0,
"evictions" : 0
"evictions" : 0,
"item_count" : 0
}
}
}
Expand Down
Loading