Skip to content

Commit e98592a

Browse files
add cat thead_pool -h values
1 parent d9146d3 commit e98592a

File tree

2 files changed

+107
-4
lines changed

2 files changed

+107
-4
lines changed

specification/cat/_types/CatBase.ts

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,3 +1677,106 @@ export enum CatShardColumn {
16771677
}
16781678
export type CatShardColumns = CatShardColumn | CatShardColumn[]
16791679

1680+
/** @non_exhaustive */
1681+
export enum CatThreadPoolColumn {
1682+
/**
1683+
* Number of active threads in the current thread pool.
1684+
* @aliases a
1685+
*/
1686+
active,
1687+
/**
1688+
* Number of tasks completed by the thread pool executor.
1689+
* @aliases c
1690+
*/
1691+
completed,
1692+
/**
1693+
* Configured core number of active threads allowed in the current thread pool.
1694+
* @aliases cr
1695+
*/
1696+
core,
1697+
/**
1698+
* Ephemeral node ID.
1699+
* @aliases eid
1700+
*/
1701+
ephemeral_id,
1702+
/**
1703+
* Hostname for the current node.
1704+
* @aliases h
1705+
*/
1706+
host,
1707+
/**
1708+
* IP address for the current node.
1709+
* @aliases i
1710+
*/
1711+
ip,
1712+
/**
1713+
* Configured keep alive time for threads.
1714+
* @aliases k
1715+
*/
1716+
keep_alive,
1717+
/**
1718+
* Highest number of active threads in the current thread pool.
1719+
* @aliases l
1720+
*/
1721+
largest,
1722+
/**
1723+
* Configured maximum number of active threads allowed in the current thread pool.
1724+
* @aliases mx
1725+
*/
1726+
max,
1727+
/**
1728+
* Name of the thread pool, such as `analyze` or `generic`.
1729+
*/
1730+
name,
1731+
/**
1732+
* ID of the node, such as `k0zy`.
1733+
* @aliases id
1734+
*/
1735+
node_id,
1736+
/**
1737+
* Node name, such as `I8hydUG`.
1738+
*/
1739+
node_name,
1740+
/**
1741+
* Process ID of the running node.
1742+
* @aliases p
1743+
*/
1744+
pid,
1745+
/**
1746+
* Number of threads in the current thread pool.
1747+
* @aliases psz
1748+
*/
1749+
pool_size,
1750+
/**
1751+
* Bound transport port for the current node.
1752+
* @aliases po
1753+
*/
1754+
port,
1755+
/**
1756+
* Number of tasks in the queue for the current thread pool.
1757+
* @aliases q
1758+
*/
1759+
queue,
1760+
/**
1761+
* Maximum number of tasks permitted in the queue for the current thread pool.
1762+
* @aliases qs
1763+
*/
1764+
queue_size,
1765+
/**
1766+
* Number of tasks rejected by the thread pool executor.
1767+
* @aliases r
1768+
*/
1769+
rejected,
1770+
/**
1771+
* Configured fixed number of active threads allowed in the current thread pool.
1772+
* @aliases sz
1773+
*/
1774+
size,
1775+
/**
1776+
* Type of thread pool. Returned values are `fixed`, `fixed_auto_queue_size`, `direct`, or `scaling`.
1777+
* @aliases t
1778+
*/
1779+
type,
1780+
}
1781+
export type CatThreadPoolColumns = CatThreadPoolColumn | CatThreadPoolColumn[]
1782+

specification/cat/thread_pool/CatThreadPoolRequest.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
import { Names } from '@_types/common'
2121
import { Duration, TimeUnit } from '@_types/Time'
22-
import { CatRequestBase } from '@cat/_types/CatBase'
22+
import { CatThreadPoolColumn, CatRequestBase } from '@cat/_types/CatBase'
2323

2424
/**
2525
* Get thread pool statistics.
@@ -55,9 +55,9 @@ export interface Request extends CatRequestBase {
5555
/**
5656
* List of columns to appear in the response. Supports simple wildcards.
5757
*/
58-
h?: Names
58+
h?: CatThreadPoolColumn
5959
/**
60-
* List of columns that determine how the table should be sorted.
60+
* A comma-separated list of column names or aliases that determines the sort order.
6161
* Sorting defaults to ascending and can be changed by setting `:asc`
6262
* or `:desc` as a suffix to the column name.
6363
*/
@@ -75,7 +75,7 @@ export interface Request extends CatRequestBase {
7575
*/
7676
local?: boolean
7777
/**
78-
* Period to wait for a connection to the master node.
78+
* The period to wait for a connection to the master node.
7979
* @server_default 30s
8080
*/
8181
master_timeout?: Duration

0 commit comments

Comments
 (0)