Skip to content

Commit c040b1f

Browse files
committed
chore: fix docs templates, fix stability markers, document missing PromQL fallbacks
1 parent e2618e4 commit c040b1f

File tree

17 files changed

+530
-107
lines changed

17 files changed

+530
-107
lines changed

model/alerting/metrics.yaml

Lines changed: 54 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,26 @@ groups:
77
- id: metric.dash0.check.status
88
type: metric
99
metric_name: dash0.check.status
10-
stability: development
10+
stability: stable
1111
brief: >
1212
Encodes the current state of a check as an enum.
1313
note: |
1414
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
1515
The value represents the check's overall status (e.g., ok, degraded, critical).
16+
17+
Deprecated PromQL alias: `dash0_check_status`.
18+
instrument: gauge
19+
unit: "{enum}"
20+
21+
- id: metric.dash0_check_status
22+
type: metric
23+
metric_name: dash0_check_status
24+
stability: stable
25+
deprecated:
26+
reason: renamed
27+
renamed_to: dash0.check.status
28+
brief: >
29+
Deprecated Prometheus alias for `dash0.check.status`.
1630
instrument: gauge
1731
unit: "{enum}"
1832

@@ -22,11 +36,25 @@ groups:
2236
- id: metric.dash0.check.evaluation.outcome
2337
type: metric
2438
metric_name: dash0.check.evaluation.outcome
25-
stability: development
39+
stability: stable
2640
brief: >
2741
Encodes the outcome of check evaluations as an enum.
2842
note: |
2943
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
44+
45+
Deprecated PromQL alias: `dash0_check_evaluation_outcome`.
46+
instrument: gauge
47+
unit: "{enum}"
48+
49+
- id: metric.dash0_check_evaluation_outcome
50+
type: metric
51+
metric_name: dash0_check_evaluation_outcome
52+
stability: stable
53+
deprecated:
54+
reason: renamed
55+
renamed_to: dash0.check.evaluation.outcome
56+
brief: >
57+
Deprecated Prometheus alias for `dash0.check.evaluation.outcome`.
3058
instrument: gauge
3159
unit: "{enum}"
3260

@@ -36,67 +64,52 @@ groups:
3664
- id: metric.dash0.check.evaluation.value
3765
type: metric
3866
metric_name: dash0.check.evaluation.value
39-
stability: development
67+
stability: stable
4068
brief: >
4169
The value returned by a check evaluation.
4270
note: |
4371
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
44-
instrument: gauge
45-
unit: "1"
4672
47-
# ──────────────────────────────────────────────
48-
# dash0.check.threshold.critical
49-
# ──────────────────────────────────────────────
50-
- id: metric.dash0.check.threshold.critical
51-
type: metric
52-
metric_name: dash0.check.threshold.critical
53-
stability: development
54-
brief: >
55-
Threshold above or below which a check evaluation counts as critical.
56-
note: |
57-
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
73+
Deprecated PromQL alias: `dash0_check_evaluation_value`.
5874
instrument: gauge
5975
unit: "1"
6076

61-
# ──────────────────────────────────────────────
62-
# dash0.check.threshold.degraded
63-
# ──────────────────────────────────────────────
64-
- id: metric.dash0.check.threshold.degraded
77+
- id: metric.dash0_check_evaluation_value
6578
type: metric
66-
metric_name: dash0.check.threshold.degraded
67-
stability: development
79+
metric_name: dash0_check_evaluation_value
80+
stability: stable
81+
deprecated:
82+
reason: renamed
83+
renamed_to: dash0.check.evaluation.value
6884
brief: >
69-
Threshold above or below which a check evaluation counts as degraded.
70-
note: |
71-
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
85+
Deprecated Prometheus alias for `dash0.check.evaluation.value`.
7286
instrument: gauge
7387
unit: "1"
7488

75-
# ──────────────────────────────────────────────
76-
# dash0.check.enablement_conditions.value
77-
# ──────────────────────────────────────────────
78-
- id: metric.dash0.check.enablement_conditions.value
79-
type: metric
80-
metric_name: dash0.check.enablement_conditions.value
81-
stability: development
82-
brief: >
83-
Whether the check enablement conditions were met.
84-
note: |
85-
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
86-
The value is a boolean encoded as 0 or 1.
87-
instrument: gauge
88-
unit: "{bool}"
89-
9089
# ──────────────────────────────────────────────
9190
# dash0.issue.status
9291
# ──────────────────────────────────────────────
9392
- id: metric.dash0.issue.status
9493
type: metric
9594
metric_name: dash0.issue.status
96-
stability: development
95+
stability: stable
9796
brief: >
9897
Encodes the current issue status as an enum.
9998
note: |
10099
Emitted by the check evaluation pipeline (scope `dash0-issue-metrics`).
100+
101+
Deprecated PromQL alias: `dash0_issue_status`.
102+
instrument: gauge
103+
unit: "{enum}"
104+
105+
- id: metric.dash0_issue_status
106+
type: metric
107+
metric_name: dash0_issue_status
108+
stability: stable
109+
deprecated:
110+
reason: renamed
111+
renamed_to: dash0.issue.status
112+
brief: >
113+
Deprecated Prometheus alias for `dash0.issue.status`.
101114
instrument: gauge
102115
unit: "{enum}"

model/deployment/entities.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ groups:
99
stability: development
1010
name: deployment
1111
brief: >
12-
Compat deployment entity, allowing additional optional attributes to pass validation
12+
Mock entity for compatibility with Weaver, allowing additional optional attributes to pass validation
1313
attributes:
1414
- ref: deployment.name
1515
requirement_level: recommended

model/logging/metrics.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ groups:
77
- id: metric.dash0.logs
88
type: metric
99
metric_name: dash0.logs
10-
stability: development
10+
stability: stable
1111
brief: >
1212
Counts the number of log records ingested by Dash0.
1313
note: |
@@ -25,7 +25,7 @@ groups:
2525
- id: metric.dash0_logs_total
2626
type: metric
2727
metric_name: dash0_logs_total
28-
stability: development
28+
stability: stable
2929
deprecated:
3030
reason: renamed
3131
renamed_to: dash0.logs

model/metrics/metrics.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,29 @@ groups:
77
- id: metric.dash0.metrics.datapoints
88
type: metric
99
metric_name: dash0.metrics.datapoints
10-
stability: development
10+
stability: stable
1111
brief: >
1212
Counts the number of metric data points ingested by Dash0.
1313
note: |
1414
`dash0.metrics.datapoints` is a synthetic metric: it is not stored as a metric
1515
time series, but computed on-the-fly from the ingested metrics data. It can be
1616
filtered and grouped by any metric or resource attribute.
1717
18+
Deprecated PromQL alias: `dash0_metrics_datapoints_total`.
19+
1820
Synthetic metrics do not expose attributes by default. Attributes are
1921
materialised through PromQL aggregations.
2022
instrument: counter
2123
unit: "{metric_datapoint}"
24+
25+
- id: metric.dash0_metrics_datapoints_total
26+
type: metric
27+
metric_name: dash0_metrics_datapoints_total
28+
stability: stable
29+
deprecated:
30+
reason: renamed
31+
renamed_to: dash0.metrics.datapoints
32+
brief: >
33+
Deprecated Prometheus alias for `dash0.metrics.datapoints`.
34+
instrument: counter
35+
unit: "{metric_datapoint}"

model/registry/log-attributes.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ groups:
88
attributes:
99
- id: dash0.log.message
1010
type: string
11-
stability: development
11+
stability: stable
1212
brief: >
1313
Extracted or normalised log message text.
1414
note: |
@@ -20,7 +20,7 @@ groups:
2020

2121
- id: dash0.log.pattern
2222
type: string
23-
stability: development
23+
stability: stable
2424
brief: >
2525
Identifier of the log pattern template matched by this log record.
2626
note: |
@@ -32,7 +32,7 @@ groups:
3232

3333
- id: dash0.log.ai.attributes_inferred
3434
type: boolean
35-
stability: development
35+
stability: stable
3636
brief: >
3737
Indicates that log attributes were inferred by the AI log parser.
3838
note: |
@@ -43,7 +43,7 @@ groups:
4343
4444
- id: dash0.log.ai.message_inferred
4545
type: boolean
46-
stability: development
46+
stability: stable
4747
brief: >
4848
Indicates that the log message was inferred by the AI log parser.
4949
note: |
@@ -54,7 +54,7 @@ groups:
5454
5555
- id: dash0.log.ai.severity_inferred
5656
type: boolean
57-
stability: development
57+
stability: stable
5858
brief: >
5959
Indicates that the log severity was inferred by the AI log parser.
6060
note: |

model/registry/operation-attributes.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ groups:
88
attributes:
99
- id: dash0.operation.name
1010
type: string
11-
stability: development
11+
stability: stable
1212
brief: >
1313
Human-readable name for the logical operation a span belongs to.
1414
note: |
@@ -22,7 +22,7 @@ groups:
2222

2323
- id: dash0.operation.type
2424
type: string
25-
stability: development
25+
stability: stable
2626
brief: >
2727
The type of the logical operation a span belongs to.
2828
note: |

0 commit comments

Comments
 (0)