Skip to content

Commit 42d828b

Browse files
committed
util/metric: add some commentary to the Metadata proto
Release note: None
1 parent a10bae0 commit 42d828b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

pkg/util/metric/metric.proto

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,21 @@ message Metadata {
8989
TTL = 15;
9090
EXPIRATIONS = 16;
9191
}
92-
92+
9393
// if essential is true, the metric is required to be included in
9494
// a DB Console dashboard, in our public docs, and in all tsdump
9595
// exports.
96+
//
97+
// The initial list of essential metrics was based on the "100 essential
98+
// metrics" that can be found at
99+
// https://github.com/cockroachlabs/cockroachdb-runbook-template/blob/main/monitoring-alerts/monitoring-dashboard-custom.md
96100
required bool essential = 9 [(gogoproto.nullable) = false];
97101
// category is the dashboard category of this metric. This is
98102
// required if `essential` is true.
99103
required Category category = 11 [(gogoproto.nullable) = false];
100104
// how_to_use is an extended description of how to use this metric
101105
// with a running cluster. This is required if `essential` is true.
102106
required string how_to_use = 12 [(gogoproto.nullable) = false];
107+
108+
// Next ID: 10 (then 13).
103109
}

0 commit comments

Comments
 (0)