Skip to content

Commit e64295e

Browse files
florence-crlflorence-crl
committed
In essential-metrics.md, (1) added metric_link variable to replace underscores and periods with hyphens in metric name, (2) added category Expiration of license and certificates.
Replaced available-metrics-not-in-metrics-list.csv with available-metrics-not-in-metrics-list.yaml with labeled_name and essential: true. In essential-alerts.md, fixed link.
1 parent 368df41 commit e64295e

File tree

4 files changed

+173
-21
lines changed

4 files changed

+173
-21
lines changed

‎src/current/_data/v25.3/metrics/available-metrics-not-in-metrics-list.csv

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎src/current/_data/v25.3/metrics/available-metrics-not-in-metrics-list.yaml

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
- metric_id: seconds.until.enterprise.license.expiry
2+
description: Seconds until enterprise license expiry (0 if no license present or running without enterprise features)
3+
y-axis label: License Expiration
4+
type: GAUGE
5+
unit: TIMESTAMP_SEC
6+
how_to_use: See Description.
7+
essential: true
8+
- metric_id: security.certificate.expiration.ca
9+
labeled_name: 'security.certificate.expiration{certificate_type=ca}'
10+
description: Expiration for the CA certificate. 0 means no certificate or error.
11+
y-axis label: Certificate Expiration
12+
type: GAUGE
13+
unit: TIMESTAMP_SEC
14+
how_to_use: See Description.
15+
essential: true
16+
- metric_id: security.certificate.expiration.client-ca
17+
labeled_name: 'security.certificate.expiration{certificate_type=client-ca}'
18+
description: Expiration for the client CA certificate. 0 means no certificate or error.
19+
y-axis label: Certificate Expiration
20+
type: GAUGE
21+
unit: TIMESTAMP_SEC
22+
how_to_use: See Description.
23+
essential: true
24+
- metric_id: security.certificate.expiration.client
25+
labeled_name: 'security.certificate.expiration{certificate_type=client}'
26+
description: Minimum expiration for client certificates, labeled by SQL user. 0 means no certificate or error.
27+
y-axis label: Certificate Expiration
28+
type: GAUGE
29+
unit: TIMESTAMP_SEC
30+
how_to_use: See Description.
31+
essential: true
32+
- metric_id: security.certificate.expiration.ui-ca
33+
labeled_name: 'security.certificate.expiration{certificate_type=ui-ca}'
34+
description: Expiration for the UI CA certificate. 0 means no certificate or error.
35+
y-axis label: Certificate Expiration
36+
type: GAUGE
37+
unit: TIMESTAMP_SEC
38+
how_to_use: See Description.
39+
essential: true
40+
- metric_id: security.certificate.expiration.node
41+
labeled_name: 'security.certificate.expiration{certificate_type=node}'
42+
description: Expiration for the node certificate. 0 means no certificate or error.
43+
y-axis label: Certificate Expiration
44+
type: GAUGE
45+
unit: TIMESTAMP_SEC
46+
how_to_use: See Description.
47+
essential: true
48+
- metric_id: security.certificate.expiration.node-client
49+
labeled_name: 'security.certificate.expiration{certificate_type=node-client}'
50+
description: Expiration for the node's client certificate. 0 means no certificate or error.
51+
y-axis label: Certificate Expiration
52+
type: GAUGE
53+
unit: TIMESTAMP_SEC
54+
how_to_use: See Description.
55+
essential: true
56+
- metric_id: security.certificate.expiration.ui
57+
labeled_name: 'security.certificate.expiration{certificate_type=ui}'
58+
description: Expiration for the UI certificate. 0 means no certificate or error.
59+
y-axis label: Certificate Expiration
60+
type: GAUGE
61+
unit: TIMESTAMP_SEC
62+
how_to_use: See Description.
63+
essential: true
64+
- metric_id: security.certificate.expiration.ca-client-tenant
65+
labeled_name: 'security.certificate.expiration{certificate_type=ca-client-tenant}'
66+
description: Expiration for the Tenant Client CA certificate. 0 means no certificate or error.
67+
y-axis label: Certificate Expiration
68+
type: GAUGE
69+
unit: TIMESTAMP_SEC
70+
how_to_use: See Description.
71+
essential: true
72+
- metric_id: security.certificate.expiration.client-tenant
73+
labeled_name: 'security.certificate.expiration{certificate_type=client-tenant}'
74+
description: Expiration for the Tenant Client certificate. 0 means no certificate or error.
75+
y-axis label: Certificate Expiration
76+
type: GAUGE
77+
unit: TIMESTAMP_SEC
78+
how_to_use: See Description.
79+
essential: true
80+
- metric_id: security.certificate.ttl.ca
81+
description: Seconds till expiration for the CA certificate. 0 means expired, no certificate or error.
82+
y-axis label: Certificate TTL
83+
type: GAUGE
84+
unit: TIMESTAMP_SEC
85+
how_to_use: See Description.
86+
- metric_id: security.certificate.ttl.client-ca
87+
description: Seconds till expiration for the client CA certificate. 0 means expired, no certificate or error.
88+
y-axis label: Certificate TTL
89+
type: GAUGE
90+
unit: TIMESTAMP_SEC
91+
how_to_use: See Description.
92+
- metric_id: security.certificate.ttl.client
93+
description: Seconds till expiration for the client certificates, labeled by SQL user. 0 means expired, no certificate or error.
94+
y-axis label: Certificate TTL
95+
type: GAUGE
96+
unit: TIMESTAMP_SEC
97+
how_to_use: See Description.
98+
- metric_id: security.certificate.ttl.ui-ca
99+
description: Seconds till expiration for the UI CA certificate. 0 means expired, no certificate or error.
100+
y-axis label: Certificate TTL
101+
type: GAUGE
102+
unit: TIMESTAMP_SEC
103+
how_to_use: See Description.
104+
- metric_id: security.certificate.ttl.node
105+
description: Seconds till expiration for the node certificate. 0 means expired, no certificate or error.
106+
y-axis label: Certificate TTL
107+
type: GAUGE
108+
unit: TIMESTAMP_SEC
109+
how_to_use: See Description.
110+
- metric_id: security.certificate.ttl.node-client
111+
description: Seconds till expiration for the node's client certificate. 0 means expired, no certificate or error.
112+
y-axis label: Certificate TTL
113+
type: GAUGE
114+
unit: TIMESTAMP_SEC
115+
how_to_use: See Description.
116+
- metric_id: security.certificate.ttl.ui
117+
description: Seconds till expiration for the UI certificate. 0 means expired, no certificate or error.
118+
y-axis label: Certificate TTL
119+
type: GAUGE
120+
unit: TIMESTAMP_SEC
121+
how_to_use: See Description.
122+
- metric_id: security.certificate.ttl.ca-client-tenant
123+
description: Seconds till expiration for the Tenant Client CA certificate. 0 means expired, no certificate or error.
124+
y-axis label: Certificate TTL
125+
type: GAUGE
126+
unit: TIMESTAMP_SEC
127+
how_to_use: See Description.
128+
- metric_id: security.certificate.ttl.client-tenant
129+
description: Seconds till expiration for the Tenant Client certificate. 0 means expired, no certificate or error.
130+
y-axis label: Certificate TTL
131+
type: GAUGE
132+
unit: TIMESTAMP_SEC
133+
how_to_use: See Description.

‎src/current/_includes/v25.3/essential-alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ Changefeed has fallen behind. This is determined by the end-to-end lag between a
483483
Changefeed jobs should not be paused for a long time because [the protected timestamp prevents garbage collection]({% link {{ page.version.version }}/protect-changefeed-data.md %}). To protect against an operational error, this alert guards against an inadvertently forgotten pause.
484484

485485
**Metric**
486-
<br>[`jobs.changefeed.currently_paused`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#changefeed-currently-paused)
486+
<br>[`jobs.changefeed.currently_paused`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#jobs-changefeed-currently-paused)
487487

488488
**Rule**
489489
<br>WARNING: `jobs.changefeed.currently_paused` is greater than `0` for more than `15 minutes`

‎src/current/_includes/v25.3/essential-metrics.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,10 @@ The **Usage** column explains why each metric is important to visualize and how
133133
{% assign input_metric = metric.name | append: ".total" %}
134134
{% assign match7 = metrics_datadog | where: "datadog_id", input_metric | first %}
135135
136+
{% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}
137+
136138
<tr>
137-
<td><div id="{{ metric.name }}" class="anchored"><code>{{ metric.name }}</code></div>
139+
<td><div id="{{ metric_link }}" class="anchored"><code>{{ metric.name }}</code></div>
138140
<br>{% if metric.labeled_name %}<code>metrics</code> endpoint:<br><code>{{ metric.labeled_name }}</code>{% endif %}
139141
</td>
140142
<td>
@@ -161,6 +163,42 @@ The **Usage** column explains why each metric is important to visualize and how
161163
{% endif %}{% comment %}if category_name != ""{% endcomment %}
162164
{% endfor %}{% comment %}for category_name in category_names_array{% endcomment %}
163165

166+
{% comment %} Add category for metrics that are not in metrics.yaml{% endcomment %}
167+
{% if include.deployment == 'self-hosted' %}
168+
{% assign essential_metrics = site.data[version].metrics.available-metrics-not-in-metrics-list | where: "essential", true %}
169+
## Expiration of license and certificates
170+
171+
<table markdown="1">
172+
<thead>
173+
<tr>
174+
<th>CockroachDB Metric Name</th>
175+
<th>[Datadog Integration Metric Name]({{ datadog_link }})<br>(add `{{ datadog_prefix }}.` prefix)</th>
176+
<th>Description</th>
177+
<th>Usage</th>
178+
</tr>
179+
</thead>
180+
<tbody>
181+
182+
{% for metric in essential_metrics %}
183+
184+
{% assign metric_link = metric.metric_id | replace: "_", "-" | replace: ".", "-" %}
185+
186+
<tr>
187+
<td><div id="{{ metric_link }}" class="anchored"><code>{{ metric.metric_id }}</code></div>
188+
<br>{% if metric.labeled_name %}<code>metrics</code> endpoint:<br><code>{{ metric.labeled_name }}</code>{% endif %}
189+
</td>
190+
<td><code>{{ metric.metric_id }}</code>
191+
</td>
192+
<td>{{ metric.description }}</td>
193+
<td>{{ metric.how_to_use }}</td>
194+
</tr>
195+
196+
{% endfor %}{% comment %}for metric in essential_metrics{% endcomment %}
197+
198+
</tbody>
199+
</table>
200+
{% endif %}{% comment %}if include.deployment == 'self-hosted'{% endcomment %}
201+
164202
## See also
165203

166204
- [Available Metrics]({% link {{ page.version.version }}/metrics.md %}#available-metrics)

0 commit comments

Comments
 (0)