Skip to content

Commit d9146d3

Browse files
charlotte-hoblikcharlotte-hoblik
committed
add cat shards -h values
1 parent 7c4997b commit d9146d3

File tree

2 files changed

+382
-5
lines changed

2 files changed

+382
-5
lines changed

‎specification/cat/_types/CatBase.ts‎

Lines changed: 377 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1300,3 +1300,380 @@ export enum CatTransformColumn {
13001300
version
13011301
}
13021302
export type CatTransformColumns = CatTransformColumn | CatTransformColumn[]
1303+
1304+
/** @non_exhaustive */
1305+
export enum CatShardColumn {
1306+
/**
1307+
* The size of completion. For example: `0b`.
1308+
* @aliases cs, completionSize
1309+
*/
1310+
'completion.size',
1311+
/**
1312+
* Disk space used by the shard’s dataset, which may or may not be the size on
1313+
* disk, but includes space used by the shard on object storage. Reported as a size value for example: `5kb`.
1314+
*/
1315+
'dataset.size',
1316+
/**
1317+
* Number of indexed dense vectors.
1318+
* @aliases dvc, denseVectorCount
1319+
*/
1320+
'dense_vector.value_count',
1321+
/**
1322+
* Number of documents in shard, for example: `25`.
1323+
* @aliases d, dc
1324+
*/
1325+
'docs',
1326+
/**
1327+
* Fielddata cache evictions, for example: `0`.
1328+
* @aliases fe, fielddataEvictions
1329+
*/
1330+
'fielddata.evictions',
1331+
/**
1332+
* Used fielddata cache memory, for example: `0b`.
1333+
* @aliases fm, fielddataMemory
1334+
*/
1335+
'fielddata.memory_size',
1336+
/**
1337+
* Number of flushes, for example: `1`.
1338+
* @aliases ft, flushTotal
1339+
*/
1340+
'flush.total',
1341+
/**
1342+
* Time spent in flush, for example: `1`.
1343+
* @aliases ftt, flushTotalTime
1344+
*/
1345+
'flush.total_time',
1346+
/**
1347+
* Number of current get operations, for example: `0`.
1348+
* @aliases gc, getCurrent
1349+
*/
1350+
'get.current',
1351+
/**
1352+
* Time spent in successful gets, for example: `14ms`.
1353+
* @aliases geti, getExistsTime
1354+
*/
1355+
'get.exists_time',
1356+
/**
1357+
* Number of successful get operations, for example: `2`.
1358+
* @aliases geto, getExistsTotal
1359+
*/
1360+
'get.exists_total',
1361+
/**
1362+
* Time spent in failed gets, for example: `0s`.
1363+
* @aliases gmti, getMissingTime
1364+
*/
1365+
'get.missing_time',
1366+
/**
1367+
* Number of failed get operations, for example: `1`.
1368+
* @aliases gmto, getMissingTotal
1369+
*/
1370+
'get.missing_total',
1371+
/**
1372+
* Time spent in get, for example: `14ms`.
1373+
* @aliases gti, getTime
1374+
*/
1375+
'get.time',
1376+
/**
1377+
* Number of get operations, for example: `2`.
1378+
* @aliases gto, getTotal
1379+
*/
1380+
'get.total',
1381+
/**
1382+
* ID of the node, for example: `k0zy`.
1383+
*/
1384+
id,
1385+
/**
1386+
* Name of the index.
1387+
* @aliases i, idx
1388+
*/
1389+
index,
1390+
/**
1391+
* Number of current deletion operations, for example: `0`.
1392+
* @aliases idc, indexingDeleteCurrent
1393+
*/
1394+
'indexing.delete_current',
1395+
/**
1396+
* Time spent in deletions, for example: `2ms`.
1397+
* @aliases idti, indexingDeleteTime
1398+
*/
1399+
'indexing.delete_time',
1400+
/**
1401+
* Number of deletion operations, for example: `2`.
1402+
* @aliases idto, indexingDeleteTotal
1403+
*/
1404+
'indexing.delete_total',
1405+
/**
1406+
* Number of current indexing operations, for example: `0`.
1407+
* @aliases iic, indexingIndexCurrent
1408+
*/
1409+
'indexing.index_current',
1410+
/**
1411+
* Number of failed indexing operations due to version conflict, for example: `0`.
1412+
* @aliases iifvc, indexingIndexFailedDueToVersionConflict
1413+
*/
1414+
'indexing.index_failed_due_to_version_conflict',
1415+
/**
1416+
* Number of failed indexing operations, for example: `0`.
1417+
* @aliases iif, indexingIndexFailed
1418+
*/
1419+
'indexing.index_failed',
1420+
/**
1421+
* Time spent in indexing, such as for example: `134ms`.
1422+
* @aliases iiti, indexingIndexTime
1423+
*/
1424+
'indexing.index_time',
1425+
/**
1426+
* Number of indexing operations, for example: `1`.
1427+
* @aliases iito, indexingIndexTotal
1428+
*/
1429+
'indexing.index_total',
1430+
/**
1431+
* IP address of the node, for example: `127.0.1.1`.
1432+
*/
1433+
ip,
1434+
/**
1435+
* Number of current merge operations, for example: `0`.
1436+
* @aliases mc, mergesCurrent
1437+
*/
1438+
'merges.current',
1439+
/**
1440+
* Number of current merging documents, for example: `0`.
1441+
* @aliases mcd, mergesCurrentDocs
1442+
*/
1443+
'merges.current_docs',
1444+
/**
1445+
* Size of current merges, for example: `0b`.
1446+
* @aliases mcs, mergesCurrentSize
1447+
*/
1448+
'merges.current_size',
1449+
/**
1450+
* Number of completed merge operations, for example: `0`.
1451+
* @aliases mt, mergesTotal
1452+
*/
1453+
'merges.total',
1454+
/**
1455+
* Number of merged documents, for example: `0`.
1456+
* @aliases mtd, mergesTotalDocs
1457+
*/
1458+
'merges.total_docs',
1459+
/**
1460+
* Size of current merges, for example: `0b`.
1461+
* @aliases mts, mergesTotalSize
1462+
*/
1463+
'merges.total_size',
1464+
/**
1465+
* Time spent merging documents, for example: `0s`.
1466+
* @aliases mtt, mergesTotalTime
1467+
*/
1468+
'merges.total_time',
1469+
/**
1470+
* Node name, for example: `I8hydUG`.
1471+
* @aliases n
1472+
*/
1473+
node,
1474+
/**
1475+
* Shard type. Returned values are `primary` or `replica`.
1476+
* @aliases p, pr, primaryOrReplica
1477+
*/
1478+
prirep,
1479+
/**
1480+
* Query cache evictions, for example: `0`.
1481+
* @aliases qce, queryCacheEvictions
1482+
*/
1483+
'query_cache.evictions',
1484+
/**
1485+
* Used query cache memory, for example: `0b`.
1486+
* @aliases qcm, queryCacheMemory
1487+
*/
1488+
'query_cache.memory_size',
1489+
/**
1490+
* Type of recovery source.
1491+
* @aliases rs
1492+
*/
1493+
'recoverysource.type',
1494+
/**
1495+
* Time spent in refreshes, for example: `91ms`.
1496+
* @aliases rti, refreshTime
1497+
*/
1498+
'refresh.time',
1499+
/**
1500+
* Number of refreshes, for example: `16`.
1501+
* @aliases rto, refreshTotal
1502+
*/
1503+
'refresh.total',
1504+
/**
1505+
* Current fetch phase operations, for example: `0`.
1506+
* @aliases sfc, searchFetchCurrent
1507+
*/
1508+
'search.fetch_current',
1509+
/**
1510+
* Time spent in fetch phase, for example: `37ms`.
1511+
* @aliases sfti, searchFetchTime
1512+
*/
1513+
'search.fetch_time',
1514+
/**
1515+
* Number of fetch operations, for example: `7`.
1516+
* @aliases sfto, searchFetchTotal
1517+
*/
1518+
'search.fetch_total',
1519+
/**
1520+
* Open search contexts, for example: `0`.
1521+
* @aliases so, searchOpenContexts
1522+
*/
1523+
'search.open_contexts',
1524+
/**
1525+
* Current query phase operations, for example: `0`.
1526+
* @aliases sqc, searchQueryCurrent
1527+
*/
1528+
'search.query_current',
1529+
/**
1530+
* Time spent in query phase, for example: `43ms`.
1531+
* @aliases sqti, searchQueryTime
1532+
*/
1533+
'search.query_time',
1534+
/**
1535+
* Number of query operations, for example: `9`.
1536+
* @aliases sqto, searchQueryTotal
1537+
*/
1538+
'search.query_total',
1539+
/**
1540+
* Open scroll contexts, for example: `2`.
1541+
* @aliases scc, searchScrollCurrent
1542+
*/
1543+
'search.scroll_current',
1544+
/**
1545+
* Time scroll contexts held open, for example: `2m`.
1546+
* @aliases scti, searchScrollTime
1547+
*/
1548+
'search.scroll_time',
1549+
/**
1550+
* Completed scroll contexts, for example: `1`.
1551+
* @aliases scto, searchScrollTotal
1552+
*/
1553+
'search.scroll_total',
1554+
/**
1555+
* Number of segments, for example: `4`.
1556+
* @aliases sc, segmentsCount
1557+
*/
1558+
'segments.count',
1559+
/**
1560+
* Memory used by fixed bit sets for nested object field types and type filters for types referred in join fields, for example: `1.0kb`.
1561+
* @aliases sfbm, fixedBitsetMemory
1562+
*/
1563+
'segments.fixed_bitset_memory',
1564+
/**
1565+
* Memory used by index writer, for example: `18mb`.
1566+
* @aliases siwm, segmentsIndexWriterMemory
1567+
*/
1568+
'segments.index_writer_memory',
1569+
/**
1570+
* Memory used by segments, for example: `1.4kb`.
1571+
* @aliases sm, segmentsMemory
1572+
*/
1573+
'segments.memory',
1574+
/**
1575+
* Memory used by version map, for example: `1.0kb`.
1576+
* @aliases svmm, segmentsVersionMapMemory
1577+
*/
1578+
'segments.version_map_memory',
1579+
/**
1580+
* Global checkpoint.
1581+
* @aliases sqg, globalCheckpoint
1582+
*/
1583+
'seq_no.global_checkpoint',
1584+
/**
1585+
* Local checkpoint.
1586+
* @aliases sql, localCheckpoint
1587+
*/
1588+
'seq_no.local_checkpoint',
1589+
/**
1590+
* Maximum sequence number.
1591+
* @aliases sqm, maxSeqNo
1592+
*/
1593+
'seq_no.max',
1594+
/**
1595+
* Name of the shard.
1596+
* @aliases s, sh
1597+
*/
1598+
'shard',
1599+
/**
1600+
* Number of indexed [sparse vectors](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/sparse-vector).
1601+
* @aliases svc, sparseVectorCount
1602+
*/
1603+
'dsparse_vector.value_count',
1604+
/**
1605+
* State of the shard. Returned values are:
1606+
* * `INITIALIZING`: The shard is recovering from a peer shard or gateway.
1607+
* * `RELOCATING`: The shard is relocating.
1608+
* * `STARTED`: The shard has started.
1609+
* * `UNASSIGNED`: The shard is not assigned to any node.
1610+
* @aliases st
1611+
*/
1612+
'state',
1613+
/**
1614+
* Disk space used by the shard, for example: `5kb`.
1615+
* @aliases sto
1616+
*/
1617+
'store',
1618+
/**
1619+
* Number of current suggest operations, for example: `0`.
1620+
* @aliases suc, suggestCurrent
1621+
*/
1622+
'suggest.current',
1623+
/**
1624+
* Time spent in suggest, for example: `0`.
1625+
* @aliases suti, suggestTime
1626+
*/
1627+
'suggest.time',
1628+
/**
1629+
* Number of suggest operations, for example: `0`.
1630+
* @aliases suto, suggestTotal
1631+
*/
1632+
'suggest.total',
1633+
/**
1634+
* Sync ID of the shard.
1635+
*/
1636+
sync_id,
1637+
/**
1638+
* Time at which the shard became unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).
1639+
* @aliases ua
1640+
*/
1641+
'unassigned.at',
1642+
/**
1643+
* Details about why the shard became unassigned. This does not explain why the shard is currently unassigned. To understand why a shard
1644+
* is not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API.
1645+
* @aliases ud
1646+
*/
1647+
'unassigned.details',
1648+
/**
1649+
* Time at which the shard was requested to be unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).
1650+
* @aliases uf
1651+
*/
1652+
'unassigned.for',
1653+
/**
1654+
* Indicates the reason for the last change to the state of this unassigned shard. This does not explain why the shard is currently unassigned.
1655+
* To understand why a shard is not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API. Returned values include:
1656+
*
1657+
* `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.
1658+
* `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.
1659+
* `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.
1660+
* `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.
1661+
* `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the Cluster reroute API.
1662+
* `INDEX_CLOSED`: Unassigned because the index was closed.
1663+
* `INDEX_CREATED`: Unassigned as a result of an API creation of an index.
1664+
* `INDEX_REOPENED`: Unassigned as a result of opening a closed index.
1665+
* `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the Cluster reroute API.
1666+
* `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.
1667+
* `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.
1668+
* `NODE_RESTARTING`: Similar to NODE_LEFT, except that the node was registered as restarting using the Node shutdown API.
1669+
* `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.
1670+
* `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.
1671+
* `REINITIALIZED`: When a shard moves from started back to initializing.
1672+
* `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.
1673+
* `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command.
1674+
* @aliases ur
1675+
*/
1676+
'unassigned.reason',
1677+
}
1678+
export type CatShardColumns = CatShardColumn | CatShardColumn[]
1679+

0 commit comments

Comments
 (0)