Usage API

Usage API

Provides usage information about the installed X-Pack features.

Request

GET /_xpack/usage

Prerequisites

  • If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Description

This API provides information about which features are currently enabled and available under the current license and some usage statistics.

Query parameters

master_timeout

(Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

  1. GET /_xpack/usage
  1. {
  2.   "security" : {
  3.     "available" : true,
  4.     "enabled" : false
  5.   },
  6.   "monitoring" : {
  7.     "available" : true,
  8.     "enabled" : true,
  9.     "collection_enabled" : false,
  10.     "enabled_exporters" : {
  11.       "local" : 1
  12.     }
  13.   },
  14.   "watcher" : {
  15.       "available" : true,
  16.       "enabled" : true,
  17.       "execution" : {
  18.         "actions" : {
  19.           "_all" : {
  20.             "total" : 0,
  21.             "total_time_in_ms" : 0
  22.           }
  23.         }
  24.       },
  25.     "watch" : {
  26.       "input" : {
  27.         "_all" : {
  28.           "total" : 0,
  29.           "active" : 0
  30.         }
  31.       },
  32.       "trigger" : {
  33.         "_all" : {
  34.           "total" : 0,
  35.           "active" : 0
  36.         }
  37.       }
  38.     },
  39.     "count" : {
  40.       "total" : 0,
  41.       "active" : 0
  42.     }
  43.   },
  44.   "graph" : {
  45.     "available" : true,
  46.     "enabled" : true
  47.   },
  48.   "ml" : {
  49.     "available" : true,
  50.     "enabled" : true,
  51.     "jobs" : {
  52.       "_all" : {
  53.         "count" : 0,
  54.         "detectors" : {
  55.           ...
  56.         },
  57.         "created_by" : { },
  58.         "model_size" : {
  59.           ...
  60.         },
  61.         "forecasts" : {
  62.           "total" : 0,
  63.           "forecasted_jobs" : 0
  64.         }
  65.       }
  66.     },
  67.     "datafeeds" : {
  68.       "_all" : {
  69.         "count" : 0
  70.       }
  71.     },
  72.     "data_frame_analytics_jobs" : {
  73.       "_all" : {
  74.         "count" : 0
  75.       },
  76.       "analysis_counts": { },
  77.       "memory_usage": {
  78.         "peak_usage_bytes": {
  79.           "min": 0.0,
  80.           "max": 0.0,
  81.           "avg": 0.0,
  82.           "total": 0.0
  83.         }
  84.       }
  85.     },
  86.     "inference" : {
  87.       "ingest_processors" : {
  88.         "_all" : {
  89.           "num_docs_processed" : {
  90.             "max" : 0,
  91.             "sum" : 0,
  92.             "min" : 0
  93.           },
  94.           "pipelines" : {
  95.             "count" : 0
  96.           },
  97.           "num_failures" : {
  98.             "max" : 0,
  99.             "sum" : 0,
  100.             "min" : 0
  101.           },
  102.           "time_ms" : {
  103.             "max" : 0,
  104.             "sum" : 0,
  105.             "min" : 0
  106.           }
  107.         }
  108.       },
  109.       "trained_models" : {
  110.         "_all" : {
  111.           "count" : 0
  112.         },
  113.         "count": {
  114.           "total": 1,
  115.           "classification": 0,
  116.           "regression": 0,
  117.           "prepackaged": 1,
  118.           "other": 0
  119.         },
  120.         "model_size_bytes": {
  121.           "min": 0.0,
  122.           "max": 0.0,
  123.           "avg": 0.0,
  124.           "total": 0.0
  125.         },
  126.         "estimated_heap_memory_usage_bytes": {
  127.           "min": 0.0,
  128.           "max": 0.0,
  129.           "avg": 0.0,
  130.           "total": 0.0
  131.         },
  132.         "estimated_operations": {
  133.           "min": 0.0,
  134.           "max": 0.0,
  135.           "avg": 0.0,
  136.           "total": 0.0
  137.         }
  138.       }
  139.     },
  140.     "node_count" : 1
  141.   },
  142.   "logstash" : {
  143.     "available" : true,
  144.     "enabled" : true
  145.   },
  146.   "eql" : {
  147.     "available" : true,
  148.     "enabled" : true
  149.   },
  150.   "sql" : {
  151.     "available" : true,
  152.     "enabled" : true,
  153.     "features" : {
  154.       "having" : 0,
  155.       "subselect" : 0,
  156.       "limit" : 0,
  157.       "orderby" : 0,
  158.       "where" : 0,
  159.       "join" : 0,
  160.       "groupby" : 0,
  161.       "command" : 0,
  162.       "local" : 0
  163.     },
  164.     "queries" : {
  165.       "rest" : {
  166.         "total" : 0,
  167.         "paging" : 0,
  168.         "failed" : 0
  169.       },
  170.       "cli" : {
  171.         "total" : 0,
  172.         "paging" : 0,
  173.         "failed" : 0
  174.       },
  175.       "canvas" : {
  176.         "total" : 0,
  177.         "paging" : 0,
  178.         "failed" : 0
  179.       },
  180.       "odbc" : {
  181.         "total" : 0,
  182.         "paging" : 0,
  183.         "failed" : 0
  184.       },
  185.       "jdbc" : {
  186.         "total" : 0,
  187.         "paging" : 0,
  188.         "failed" : 0
  189.       },
  190.       "odbc32" : {
  191.         "total" : 0,
  192.         "paging" : 0,
  193.         "failed" : 0
  194.       },
  195.       "odbc64" : {
  196.         "total" : 0,
  197.         "paging" : 0,
  198.         "failed" : 0
  199.       },
  200.       "_all" : {
  201.         "total" : 0,
  202.         "paging" : 0,
  203.         "failed" : 0
  204.       },
  205.       "translate" : {
  206.         "count" : 0
  207.       }
  208.     }
  209.   },
  210.   "rollup" : {
  211.     "available" : true,
  212.     "enabled" : true
  213.   },
  214.   "ilm" : {
  215.     "policy_count" : 3,
  216.     "policy_stats" : [
  217.       ...
  218.     ]
  219.   },
  220.   "slm" : {
  221.     "available" : true,
  222.     "enabled" : true
  223.   },
  224.   "ccr" : {
  225.     "available" : true,
  226.     "enabled" : true,
  227.     "follower_indices_count" : 0,
  228.     "auto_follow_patterns_count" : 0
  229.   },
  230.   "enrich" : {
  231.     "available" : true,
  232.     "enabled" : true
  233.   },
  234.   "transform" : {
  235.     "available" : true,
  236.     "enabled" : true
  237.   },
  238.   "voting_only" : {
  239.     "available" : true,
  240.     "enabled" : true
  241.   },
  242.   "searchable_snapshots" : {
  243.     "available" : true,
  244.     "enabled" : true,
  245.     "indices_count" : 0,
  246.     "full_copy_indices_count" : 0,
  247.     "shared_cache_indices_count" : 0
  248.   },
  249.   "frozen_indices" : {
  250.     "available" : true,
  251.     "enabled" : true,
  252.     "indices_count" : 0
  253.   },
  254.   "spatial" : {
  255.     "available" : true,
  256.     "enabled" : true
  257.   },
  258.   "analytics" : {
  259.     "available" : true,
  260.     "enabled" : true,
  261.     "stats": {
  262.       "boxplot_usage" : 0,
  263.       "top_metrics_usage" : 0,
  264.       "normalize_usage" : 0,
  265.       "cumulative_cardinality_usage" : 0,
  266.       "t_test_usage" : 0,
  267.       "rate_usage" : 0,
  268.       "string_stats_usage" : 0,
  269.       "moving_percentiles_usage" : 0,
  270.       "multi_terms_usage" : 0
  271.     }
  272.   },
  273.   "data_streams" : {
  274.     "available" : true,
  275.     "enabled" : true,
  276.     "data_streams" : 0,
  277.     "indices_count" : 0
  278.   },
  279.   "data_tiers" : {
  280.     "available" : true,
  281.     "enabled" : true,
  282.     "data_warm" : {
  283.       "node_count" : 0,
  284.       "index_count" : 0,
  285.       "total_shard_count" : 0,
  286.       "primary_shard_count" : 0,
  287.       "doc_count" : 0,
  288.       "total_size_bytes" : 0,
  289.       "primary_size_bytes" : 0,
  290.       "primary_shard_size_avg_bytes" : 0,
  291.       "primary_shard_size_median_bytes" : 0,
  292.       "primary_shard_size_mad_bytes" : 0
  293.     },
  294.     "data_frozen" : {
  295.       "node_count" : 1,
  296.       "index_count" : 0,
  297.       "total_shard_count" : 0,
  298.       "primary_shard_count" : 0,
  299.       "doc_count" : 0,
  300.       "total_size_bytes" : 0,
  301.       "primary_size_bytes" : 0,
  302.       "primary_shard_size_avg_bytes" : 0,
  303.       "primary_shard_size_median_bytes" : 0,
  304.       "primary_shard_size_mad_bytes" : 0
  305.     },
  306.     "data_cold" : {
  307.       "node_count" : 0,
  308.       "index_count" : 0,
  309.       "total_shard_count" : 0,
  310.       "primary_shard_count" : 0,
  311.       "doc_count" : 0,
  312.       "total_size_bytes" : 0,
  313.       "primary_size_bytes" : 0,
  314.       "primary_shard_size_avg_bytes" : 0,
  315.       "primary_shard_size_median_bytes" : 0,
  316.       "primary_shard_size_mad_bytes" : 0
  317.     },
  318.     "data_content" : {
  319.       "node_count" : 0,
  320.       "index_count" : 0,
  321.       "total_shard_count" : 0,
  322.       "primary_shard_count" : 0,
  323.       "doc_count" : 0,
  324.       "total_size_bytes" : 0,
  325.       "primary_size_bytes" : 0,
  326.       "primary_shard_size_avg_bytes" : 0,
  327.       "primary_shard_size_median_bytes" : 0,
  328.       "primary_shard_size_mad_bytes" : 0
  329.     },
  330.     "data_hot" : {
  331.       "node_count" : 0,
  332.       "index_count" : 0,
  333.       "total_shard_count" : 0,
  334.       "primary_shard_count" : 0,
  335.       "doc_count" : 0,
  336.       "total_size_bytes" : 0,
  337.       "primary_size_bytes" : 0,
  338.       "primary_shard_size_avg_bytes" : 0,
  339.       "primary_shard_size_median_bytes" : 0,
  340.       "primary_shard_size_mad_bytes" : 0
  341.     }
  342.   },
  343.   "aggregate_metric" : {
  344.     "available" : true,
  345.     "enabled" : true
  346.   }
  347. }