Skip to content

Commit cb98b32

Browse files
committed
fix(om2): move mermaid diagram outside the spec
Currently it only renders correctly in github, not the website, so we want to switch to pre-rendering into some picture that the markdown can include. Preferably SVG. Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
1 parent c97e629 commit cb98b32

2 files changed

Lines changed: 49 additions & 50 deletions

File tree

docs/specs/om/open_metrics_spec_2_0.md

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -72,56 +72,6 @@ The word "RESERVED" is used in this document to designate values, names, or fiel
7272

7373
This section MUST be read together with the ABNF section. In case of disagreements between the two, the ABNF's restrictions MUST take precedence.
7474

75-
```mermaid
76-
classDiagram
77-
class MetricSet
78-
class MetricFamily
79-
class MetricFamilyType {
80-
<<enumeration>>
81-
gauge
82-
counter
83-
stateset
84-
info
85-
histogram
86-
gaugehistogram
87-
summary
88-
unknown
89-
}
90-
class Metric
91-
class LabelSet
92-
class Label
93-
class Sample
94-
class Timestamp
95-
class Exemplar
96-
class SampleValue {
97-
<<abstract>>
98-
}
99-
class Number
100-
class CompositeValue
101-
class HistogramValue
102-
class GaugeHistogramValue
103-
class SummaryValue
104-
105-
MetricSet "1" --> "0..*" MetricFamily
106-
MetricFamily "1" --> "1" MetricFamilyType : type
107-
MetricFamily "1" --> "0..*" Metric
108-
Metric "1" --> "1" LabelSet
109-
Metric "1" --> "1..*" Sample
110-
LabelSet "1" --> "0..*" Label
111-
Sample --> "1" SampleValue : value
112-
Sample --> "0..1" Timestamp : timestamp
113-
Sample --> "0..1" Timestamp : start timestamp
114-
Sample --> "0..*" Exemplar
115-
SampleValue <|-- Number
116-
SampleValue <|-- CompositeValue
117-
CompositeValue <|-- HistogramValue
118-
CompositeValue <|-- GaugeHistogramValue
119-
CompositeValue <|-- SummaryValue
120-
Exemplar --> "1" LabelSet
121-
Exemplar --> "1" Number : value
122-
Exemplar --> "1" Timestamp
123-
```
124-
12575
### Data Types
12676

12777
#### Sample Values
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
```mermaid
2+
classDiagram
3+
class MetricSet
4+
class MetricFamily
5+
class MetricFamilyType {
6+
<<enumeration>>
7+
gauge
8+
counter
9+
stateset
10+
info
11+
histogram
12+
gaugehistogram
13+
summary
14+
unknown
15+
}
16+
class Metric
17+
class LabelSet
18+
class Label
19+
class Sample
20+
class Timestamp
21+
class Exemplar
22+
class SampleValue {
23+
<<abstract>>
24+
}
25+
class Number
26+
class CompositeValue
27+
class HistogramValue
28+
class GaugeHistogramValue
29+
class SummaryValue
30+
31+
MetricSet "1" --> "0..*" MetricFamily
32+
MetricFamily "1" --> "1" MetricFamilyType : type
33+
MetricFamily "1" --> "0..*" Metric
34+
Metric "1" --> "1" LabelSet
35+
Metric "1" --> "1..*" Sample
36+
LabelSet "1" --> "0..*" Label
37+
Sample --> "1" SampleValue : value
38+
Sample --> "0..1" Timestamp : timestamp
39+
Sample --> "0..1" Timestamp : start timestamp
40+
Sample --> "0..*" Exemplar
41+
SampleValue <|-- Number
42+
SampleValue <|-- CompositeValue
43+
CompositeValue <|-- HistogramValue
44+
CompositeValue <|-- GaugeHistogramValue
45+
CompositeValue <|-- SummaryValue
46+
Exemplar --> "1" LabelSet
47+
Exemplar --> "1" Number : value
48+
Exemplar --> "1" Timestamp
49+
```

0 commit comments

Comments
 (0)