Skip to content

Commit c4516f7

Browse files
github-actions[bot]kkraune
github-actions[bot]
and
kkraune
authored
Update 'Metric' reference documentation. (#4334)
Co-authored-by: kkraune <[email protected]>
1 parent e664bc6 commit c4516f7

13 files changed

+9055
-0
lines changed

‎en/reference/clustercontroller-metrics-reference.html‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
# Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
3+
title: "ClusterController Metrics"
4+
---
5+
6+
<table class="table">
7+
<thead>
8+
<tr><th>Name</th><th>Unit</th><th>Description</th></tr>
9+
</thead>
10+
<tbody>
11+
<tr>
12+
<td><p id="cluster-controller_down_count">cluster-controller.down.count</p></td>
13+
<td>node</td>
14+
<td>Number of content nodes down</td>
15+
</tr>
16+
<tr>
17+
<td><p id="cluster-controller_initializing_count">cluster-controller.initializing.count</p></td>
18+
<td>node</td>
19+
<td>Number of content nodes initializing</td>
20+
</tr>
21+
<tr>
22+
<td><p id="cluster-controller_maintenance_count">cluster-controller.maintenance.count</p></td>
23+
<td>node</td>
24+
<td>Number of content nodes in maintenance</td>
25+
</tr>
26+
<tr>
27+
<td><p id="cluster-controller_retired_count">cluster-controller.retired.count</p></td>
28+
<td>node</td>
29+
<td>Number of content nodes that are retired</td>
30+
</tr>
31+
<tr>
32+
<td><p id="cluster-controller_stopping_count">cluster-controller.stopping.count</p></td>
33+
<td>node</td>
34+
<td>Number of content nodes currently stopping</td>
35+
</tr>
36+
<tr>
37+
<td><p id="cluster-controller_up_count">cluster-controller.up.count</p></td>
38+
<td>node</td>
39+
<td>Number of content nodes up</td>
40+
</tr>
41+
<tr>
42+
<td><p id="cluster-controller_cluster-state-change_count">cluster-controller.cluster-state-change.count</p></td>
43+
<td>node</td>
44+
<td>Number of nodes changing state</td>
45+
</tr>
46+
<tr>
47+
<td><p id="cluster-controller_nodes-not-converged">cluster-controller.nodes-not-converged</p></td>
48+
<td>node</td>
49+
<td>Number of nodes not converging to the latest cluster state version</td>
50+
</tr>
51+
<tr>
52+
<td><p id="cluster-controller_stored-document-count">cluster-controller.stored-document-count</p></td>
53+
<td>document</td>
54+
<td>Total number of unique documents stored in the cluster</td>
55+
</tr>
56+
<tr>
57+
<td><p id="cluster-controller_stored-document-bytes">cluster-controller.stored-document-bytes</p></td>
58+
<td>byte</td>
59+
<td>Combined byte size of all unique documents stored in the cluster (not including replication)</td>
60+
</tr>
61+
<tr>
62+
<td><p id="cluster-controller_cluster-buckets-out-of-sync-ratio">cluster-controller.cluster-buckets-out-of-sync-ratio</p></td>
63+
<td>fraction</td>
64+
<td>Ratio of buckets in the cluster currently in need of syncing</td>
65+
</tr>
66+
<tr>
67+
<td><p id="cluster-controller_busy-tick-time-ms">cluster-controller.busy-tick-time-ms</p></td>
68+
<td>millisecond</td>
69+
<td>Time busy</td>
70+
</tr>
71+
<tr>
72+
<td><p id="cluster-controller_idle-tick-time-ms">cluster-controller.idle-tick-time-ms</p></td>
73+
<td>millisecond</td>
74+
<td>Time idle</td>
75+
</tr>
76+
<tr>
77+
<td><p id="cluster-controller_work-ms">cluster-controller.work-ms</p></td>
78+
<td>millisecond</td>
79+
<td>Time used for actual work</td>
80+
</tr>
81+
<tr>
82+
<td><p id="cluster-controller_is-master">cluster-controller.is-master</p></td>
83+
<td>binary</td>
84+
<td>1 if this cluster controller is currently the master, or 0 if not</td>
85+
</tr>
86+
<tr>
87+
<td><p id="cluster-controller_remote-task-queue_size">cluster-controller.remote-task-queue.size</p></td>
88+
<td>operation</td>
89+
<td>Number of remote tasks queued</td>
90+
</tr>
91+
<tr>
92+
<td><p id="cluster-controller_node-event_count">cluster-controller.node-event.count</p></td>
93+
<td>operation</td>
94+
<td>Number of node events</td>
95+
</tr>
96+
<tr>
97+
<td><p id="cluster-controller_resource_usage_nodes_above_limit">cluster-controller.resource_usage.nodes_above_limit</p></td>
98+
<td>node</td>
99+
<td>The number of content nodes above resource limit, blocking feed</td>
100+
</tr>
101+
<tr>
102+
<td><p id="cluster-controller_resource_usage_max_memory_utilization">cluster-controller.resource_usage.max_memory_utilization</p></td>
103+
<td>fraction</td>
104+
<td>Current memory utilisation, for content node with the highest value</td>
105+
</tr>
106+
<tr>
107+
<td><p id="cluster-controller_resource_usage_max_disk_utilization">cluster-controller.resource_usage.max_disk_utilization</p></td>
108+
<td>fraction</td>
109+
<td>Current disk space utilisation, for content node with the highest value</td>
110+
</tr>
111+
<tr>
112+
<td><p id="cluster-controller_resource_usage_memory_limit">cluster-controller.resource_usage.memory_limit</p></td>
113+
<td>fraction</td>
114+
<td>Memory space limit as a fraction of available memory</td>
115+
</tr>
116+
<tr>
117+
<td><p id="cluster-controller_resource_usage_disk_limit">cluster-controller.resource_usage.disk_limit</p></td>
118+
<td>fraction</td>
119+
<td>Disk space limit as a fraction of available disk space</td>
120+
</tr>
121+
<tr>
122+
<td><p id="reindexing_progress">reindexing.progress</p></td>
123+
<td>fraction</td>
124+
<td>Re-indexing progress</td>
125+
</tr>
126+
</tbody>
127+
</table>

0 commit comments

Comments
 (0)