Retrieves the current Watcher metrics Added in 5.5.0

GET /_watcher/stats/{metric}

Path parameters

  • metric string | array[string] Required

    Defines which additional metrics are included in the response.

Query parameters

  • Defines whether stack traces are generated for each watch that is running.

  • metric string | array[string]

    Defines which additional metrics are included in the response.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • _nodes object Required

      Additional properties are allowed.

      Hide _nodes attributes Show _nodes attributes object
      • failures array[object]
        Hide failures attributes Show failures attributes object
        • type string Required

          The type of error

        • reason string

          A human-readable explanation of the error, in english

        • The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • Additional properties are allowed.

        • root_cause array[object]

          Additional properties are allowed.

        • suppressed array[object]

          Additional properties are allowed.

      • total number Required

        Total number of nodes selected by the request.

      • successful number Required

        Number of nodes that responded successfully to the request.

      • failed number Required

        Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

    • cluster_name string Required
    • manually_stopped boolean Required
    • stats array[object] Required
      Hide stats attributes Show stats attributes object
GET /_watcher/stats/{metric}
curl \
 -X GET http://api.example.com/_watcher/stats/{metric}
Response examples (200)
{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "manually_stopped": true,
  "stats": [
    {
      "current_watches": [
        {
          "execution_phase": "awaits_execution",
          "executed_actions": [
            "string"
          ],
          "watch_id": "string",
          "watch_record_id": "string"
        }
      ],
      "execution_thread_pool": {
        "max_size": 42.0,
        "queue_size": 42.0
      },
      "queued_watches": [
        {
          "": "string"
        }
      ],
      "watch_count": 42.0,
      "watcher_state": "stopped",
      "node_id": "string"
    }
  ]
}