"Fossies" - the Fresh Open Source Software Archive

Member "elasticsearch-6.8.3/docs/reference/ml/apis/get-datafeed-stats.asciidoc" (29 Aug 2019, 3546 Bytes) of package /linux/www/elasticsearch-6.8.3-src.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming AsciiDoc format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the latest Fossies "Diffs" side-by-side code changes report for "get-datafeed-stats.asciidoc": 6.8.2_vs_6.8.3.

Get {dfeed} statistics API

Get {dfeed} statistics

Retrieves 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.

Important
This API returns a maximum of 10,000 {dfeeds}.

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}.

{api-query-parms-title}

allow_no_datafeeds

(Optional, boolean) Specifies what to do when the request:

  • Contains wildcard expressions and there are no {datafeeds} that match.

  • Contains the _all string or no identifiers and there are no matches.

  • Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

Results

The API returns the following information:

datafeeds

(array) An array of {dfeed} count objects. For more information, see [ml-datafeed-counts].

{api-response-codes-title}

404 (Missing resources)

If allow_no_datafeeds is false, this code indicates that there are no resources that match the request or only partial matches for the request.

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}:

GET _xpack/ml/datafeeds/datafeed-total-requests/_stats

The API returns the following results:

{
  "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": ""
    }
  ]
}