Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 3.1 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Stats API

The Stats API provides basic statistics about ML Commons, such as the number of running tasks. To monitor machine learning workflows using more detailed time-series metrics, see Monitoring machine learning workflows.

Gets statistics related to the number of tasks.

Endpoints

GET /_plugins/_ml/stats
GET /_plugins/_ml/stats/<stat>
GET /_plugins/_ml/<nodeId>/stats/
GET /_plugins/_ml/<nodeId>/stats/<stat>

Example request: Get all stats for all nodes

GET /_plugins/_ml/stats

Example response

{
  "zbduvgCCSOeu6cfbQhTpnQ" : {
    "ml_executing_task_count" : 0
  },
  "54xOe0w8Qjyze00UuLDfdA" : {
    "ml_executing_task_count" : 0
  },
  "UJiykI7bTKiCpR-rqLYHyw" : {
    "ml_executing_task_count" : 0
  },
  "zj2_NgIbTP-StNlGZJlxdg" : {
    "ml_executing_task_count" : 0
  },
  "jjqFrlW7QWmni1tRnb_7Dg" : {
    "ml_executing_task_count" : 0
  },
  "3pSSjl5PSVqzv5-hBdFqyA" : {
    "ml_executing_task_count" : 0
  },
  "A_IiqoloTDK01uZvCjREaA" : {
    "ml_executing_task_count" : 0
  }
}

Example request: Get all stats for a specific node

GET /_plugins/_ml/<nodeId>/stats/

Example request: Get a specified stat for a specific node

GET /_plugins/_ml/<nodeId>/stats/<stat>

Example request: Get a specified stat for all nodes

GET /_plugins/_ml/stats/<stat>

350 characters left

Have a question? .

Want to contribute? or .