Skip to content

Commit de5e436

Browse files
committed
Update LTR stats endpoint to /_plugins/_ltr/stats
Signed-off-by: Christoph Lee <christoph28@gmail.com>
1 parent 76b8a05 commit de5e436

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

_search-plugins/ltr/advanced-functionality.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -323,11 +323,11 @@ flag to the `sltr` query that is the target of feature score logging, as shown i
323323
You can use the Stats API to retrieve the plugin's overall status and statistics. To do this, send the following request:
324324

325325
```json
326-
GET /_ltr/_stats
326+
GET /_plugins/_ltr/stats
327327
```
328328
{% include copy-curl.html %}
329329

330-
The response includes information about the cluster, configured stores, and cache statistics for various plugin components:
330+
The response includes information about the cluster, configured stores, cache statistics for various plugin components, and request counts:
331331

332332
```json
333333
{
@@ -370,7 +370,9 @@ The response includes information about the cluster, configured stores, and cach
370370
"entry_count":0,
371371
"memory_usage_in_bytes":0
372372
}
373-
}
373+
},
374+
"request_total_count": 0,
375+
"request_error_count": 0
374376
}
375377
}
376378
}
@@ -380,15 +382,25 @@ The response includes information about the cluster, configured stores, and cach
380382
You can use filters to retrieve a single statistic by sending the following request:
381383

382384
```json
383-
GET /_ltr/_stats/{stat}
385+
GET /_plugins/_ltr/stats/{stat}
384386
```
385387
{% include copy-curl.html %}
386388

389+
The following table lists the available `{stat}` values.
390+
391+
Stat | Description
392+
:--- | :---
393+
`stores` | Information about configured feature stores.
394+
`status` | The overall plugin status.
395+
`cache` | Per-node cache statistics for various plugin components (features, feature sets, and models).
396+
`request_total_count` | Per-node counter of the number of LTR queries executed.
397+
`request_error_count` | Per-node counter of the number of LTR queries that failed.
398+
387399
You can limit the information to a single node in the cluster by sending the following requests:
388400

389401
```json
390-
GET /_ltr/_stats/nodes/{nodeId}
391-
GET /_ltr/_stats/{stat}/nodes/{nodeId}
402+
GET /_plugins/_ltr/{nodeId}/stats
403+
GET /_plugins/_ltr/{nodeId}/stats/{stat}
392404
```
393405
{% include copy-curl.html %}
394406

0 commit comments

Comments
 (0)