101 lines
2.5 KiB
Plaintext
101 lines
2.5 KiB
Plaintext
[role="xpack"]
|
|
[[ml-get-datafeed-stats]]
|
|
=== Get {dfeed-cap} Statistics API
|
|
++++
|
|
<titleabbrev>Get {dfeed-cap} Statistics</titleabbrev>
|
|
++++
|
|
|
|
This API enables you to retrieve usage information for {dfeeds}.
|
|
|
|
|
|
==== Request
|
|
|
|
|
|
`GET _xpack/ml/datafeeds/<feed_id>/_stats` +
|
|
|
|
`GET _xpack/ml/datafeeds/<feed_id>,<feed_id>/_stats` +
|
|
|
|
`GET _xpack/ml/datafeeds/_stats` +
|
|
|
|
`GET _xpack/ml/datafeeds/_all/_stats` +
|
|
|
|
|
|
|
|
==== Description
|
|
|
|
You can get statistics for multiple {dfeeds} in a single API request by using a
|
|
comma-separated list of {dfeeds} or a wildcard expression. You can get
|
|
statistics for all {dfeeds} by using `_all`, by specifying `*` as the
|
|
`<feed_id>`, or by omitting the `<feed_id>`.
|
|
|
|
If the {dfeed} is stopped, the only information you receive is the
|
|
`datafeed_id` and the `state`.
|
|
|
|
|
|
==== Path Parameters
|
|
|
|
`feed_id`::
|
|
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
|
|
wildcard expression. If you do not specify one of these options, the API
|
|
returns statistics for all {dfeeds}.
|
|
|
|
|
|
==== Results
|
|
|
|
The API returns the following information:
|
|
|
|
`datafeeds`::
|
|
(array) An array of {dfeed} count objects.
|
|
For more information, see <<ml-datafeed-counts>>.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
|
|
privileges to use this API. For more information, see
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example gets usage information for the
|
|
`datafeed-total-requests` {dfeed}:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _xpack/ml/datafeeds/datafeed-total-requests/_stats
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:server_metrics_startdf]
|
|
|
|
The API returns the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"datafeeds": [
|
|
{
|
|
"datafeed_id": "datafeed-total-requests",
|
|
"state": "started",
|
|
"node": {
|
|
"id": "2spCyo1pRi2Ajo-j-_dnPX",
|
|
"name": "node-0",
|
|
"ephemeral_id": "hoXMLZB0RWKfR9UPPUCxXX",
|
|
"transport_address": "127.0.0.1:9300",
|
|
"attributes": {
|
|
"ml.machine_memory": "17179869184",
|
|
"ml.max_open_jobs": "20",
|
|
"ml.enabled": "true"
|
|
}
|
|
},
|
|
"assignment_explanation": ""
|
|
}
|
|
]
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"2spCyo1pRi2Ajo-j-_dnPX"/$body.$_path/]
|
|
// TESTRESPONSE[s/"node-0"/$body.$_path/]
|
|
// TESTRESPONSE[s/"hoXMLZB0RWKfR9UPPUCxXX"/$body.$_path/]
|
|
// TESTRESPONSE[s/"127.0.0.1:9300"/$body.$_path/]
|
|
// TESTRESPONSE[s/"17179869184"/$body.datafeeds.0.node.attributes.ml\\.machine_memory/]
|