Skip to content

Commit 60bc74f

Browse files
authored
[Docs] Coordinator event metrics (#1272)
* [Docs] Add coordinator event metric document * [Docs] Add coordinator event metric document
1 parent e90034e commit 60bc74f

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

fluss-common/src/main/java/com/alibaba/fluss/metrics/MetricNames.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ public class MetricNames {
4444

4545
// for coordinator event processor
4646
public static final String EVENT_QUEUE_SIZE = "eventQueueSize";
47-
public static final String EVENT_PROCESS_TIME_MS = "eventProcessTimeMs";
4847
public static final String EVENT_QUEUE_TIME_MS = "eventQueueTimeMs";
48+
public static final String EVENT_PROCESSING_TIME_MS = "eventProcessingTimeMs";
4949

5050
// --------------------------------------------------------------------------------------------
5151
// metrics for tablet server

fluss-server/src/main/java/com/alibaba/fluss/server/coordinator/event/CoordinatorEventManager.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public final class CoordinatorEventManager implements EventManager {
5353
private final Lock putLock = new ReentrantLock();
5454

5555
// metrics
56-
private Histogram eventProcessTime;
56+
private Histogram eventProcessingTime;
5757
private Histogram eventQueueTime;
5858

5959
private static final int WINDOW_SIZE = 100;
@@ -68,9 +68,9 @@ public CoordinatorEventManager(
6868
private void registerMetrics() {
6969
coordinatorMetricGroup.gauge(MetricNames.EVENT_QUEUE_SIZE, queue::size);
7070

71-
eventProcessTime =
71+
eventProcessingTime =
7272
coordinatorMetricGroup.histogram(
73-
MetricNames.EVENT_PROCESS_TIME_MS,
73+
MetricNames.EVENT_PROCESSING_TIME_MS,
7474
new DescriptiveStatisticsHistogram(WINDOW_SIZE));
7575

7676
eventQueueTime =
@@ -138,7 +138,7 @@ public void doWork() throws Exception {
138138
log.error("Uncaught error processing event {}.", coordinatorEvent, e);
139139
} finally {
140140
long eventFinishTimeMs = System.currentTimeMillis();
141-
eventProcessTime.update(eventFinishTimeMs - eventStartTimeMs);
141+
eventProcessingTime.update(eventFinishTimeMs - eventStartTimeMs);
142142
}
143143
}
144144
}

website/docs/maintenance/observability/monitor-metrics.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,8 +312,8 @@ Some metrics might not be exposed when using other JVM implementations (e.g. IBM
312312
</thead>
313313
<tbody>
314314
<tr>
315-
<th rowspan="6"><strong>coordinator</strong></th>
316-
<td style={{textAlign: 'center', verticalAlign: 'middle' }} rowspan="6">-</td>
315+
<th rowspan="9"><strong>coordinator</strong></th>
316+
<td style={{textAlign: 'center', verticalAlign: 'middle' }} rowspan="9">-</td>
317317
<td>activeCoordinatorCount</td>
318318
<td>The number of active CoordinatorServer in this cluster.</td>
319319
<td>Gauge</td>
@@ -343,6 +343,21 @@ Some metrics might not be exposed when using other JVM implementations (e.g. IBM
343343
<td>The total number of replicas in the progress to be deleted in this cluster.</td>
344344
<td>Gauge</td>
345345
</tr>
346+
<tr>
347+
<td>eventQueueSize</td>
348+
<td>The number of events waiting to be processed in the queue.</td>
349+
<td>Gauge</td>
350+
</tr>
351+
<tr>
352+
<td>eventQueueTimeMs</td>
353+
<td>The time that an event spent waiting in the queue to be processed.</td>
354+
<td>Histogram</td>
355+
</tr>
356+
<tr>
357+
<td>eventProcessingTimeMs</td>
358+
<td>The time that an event took to be processed.</td>
359+
<td>Histogram</td>
360+
</tr>
346361
</tbody>
347362
</table>
348363

0 commit comments

Comments
 (0)