Get circuit breakers statistics Generally available

View as Markdown
GET /_cat/circuit_breaker/{circuit_breaker_patterns}
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/circuit_breaker

GET /_cat/circuit_breaker/{circuit_breaker_patterns}

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Required authorization

  • Cluster privileges: monitor

Path parameters

  • circuit_breaker_patterns string | array[string] Required

    A comma-separated list of regular-expressions to filter the circuit breakers in the output

Query parameters

  • h string | array[string]

    A comma-separated list of columns names to display. It supports simple wildcards.

    Supported values include:

    • node_id (or id): Persistent node ID
    • node_name (or nn): Node name
    • breaker (or br): Breaker name
    • limit (or l): Limit size
    • limit_bytes (or lb): Limit size in bytes
    • estimated (or e): Estimated size
    • estimated_bytes (or eb): Estimated size in bytes
    • tripped (or t): Tripped count
    • overhead (or o): Overhead

    Values are node_id, id, node_name, nn, breaker, br, limit, l, limit_bytes, lb, estimated, e, estimated_bytes, eb, tripped, t, overhead, or o.

  • s string | array[string]

    List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • local boolean

    If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout string

    Period to wait for a connection to the master node.

    External documentation

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • node_id string

      Persistent node ID

    • node_name string

      Node name

    • breaker string

      Breaker name

    • limit string

      Limit size

    • limit_bytes number | string

      Limit size in bytes

      One of:
      number-1 number string-2 string

      Limit size in bytes

      Limit size in bytes

    • estimated string

      Estimated size

    • estimated_bytes number | string

      Estimated size in bytes

      One of:
      number-1 number string-2 string

      Estimated size in bytes

      Estimated size in bytes

    • tripped string

      Tripped count

    • overhead string

      Overhead
GET /_cat/circuit_breaker/{circuit_breaker_patterns} 
GET /_cat/circuit_breaker?v=true&format=json

resp = client.cat.circuit_breaker(
    v=True,
    format="json",
)
const response = await client.cat.circuitBreaker({
  v: "true",
  format: "json",
});
response = client.cat.circuit_breaker(
  v: "true",
  format: "json"
)
$resp = $client->cat()->circuitBreaker([
    "v" => "true",
    "format" => "json",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/circuit_breaker?v=true&format=json"
Response examples (200)
A successful response from `GET /_cat/circuit_breaker?v=true&format=json`. It shows two circuit breakers are active on one node. 
[
  {
    "breaker": "request",
    "estimated": "0b",
    "limit": "614.3mb",
    "node_id": "ozKxpP9oS3SL0Sp-Mfxc6w",
    "tripped": "0"
  },
  {
    "breaker": "fielddata",
    "estimated": "0b",
    "limit": "409.5mb",
    "node_id": "ozKxpP9oS3SL0Sp-Mfxc6w",
    "tripped": "0"
  }
]