Skip to content

Commit 56523cf

Browse files
committed
om2: add data model diagram
Signed-off-by: bwplotka <bwplotka@gmail.com>
1 parent b8fc35f commit 56523cf

4 files changed

Lines changed: 17 additions & 4 deletions

File tree

.mdox.validator.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
version: 1
22

3-
# Don't check external URLs, they can time-out a lot (rate limits).
3+
explicitLocalValidators: true
44
validators:
5+
# Don't check external URLs for now, they can time-out a lot (rate limits), so they require extra cache setup.
56
- type: ignore
6-
regex: http(s|)://.*
7+
regex: http(s|)://.*
8+
# In docs assets are referenced in links as /assets/..., but the true path is ./public/assets/...
9+
- type: local
10+
regex: "/assets/.*"
11+
anchor: "/public"
12+
- type: local
13+
regex: ".*"

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MD_FILES_TO_FORMAT=docs/specs/om/open_metrics_spec_2_0.md
33

44
MDOX="mdox"
55
$(MDOX):
6-
@go install github.com/bwplotka/mdox@v0.9.0
6+
@go install github.com/bwplotka/mdox@d22b1d641c9b4b7a54c95d279231abe6e5e892fd
77

88
.PHONY: help
99
help: ## Displays help.
@@ -13,7 +13,7 @@ help: ## Displays help.
1313
fmt: ## Format docs.
1414
fmt: $(MDOX)
1515
@echo "Formatting markdown files..."
16-
@$(MDOX) fmt --links.validate $(MD_FILES_TO_FORMAT)
16+
@$(MDOX) fmt --links.validate --links.validate.config-file=./.mdox.validator.yaml $(MD_FILES_TO_FORMAT)
1717

1818
.PHONY: check
1919
check: ## Checks if doc is formatter and links are correct (don't check external links).

docs/specs/om/open_metrics_spec_2_0.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ Common examples of metric time series would be network interface counters, devic
6868

6969
This section MUST be read together with the ABNF section. In case of disagreements between the two, the ABNF's restrictions MUST take precedence. This reduces repetition as the text wire format MUST be supported.
7070

71+
<!---
72+
# Diagram source: https://docs.google.com/presentation/d/1ovDkQVm84zo5ktWZVm5XosLS2YMRgdSJCevVivAlLW0/edit?slide=id.g3cfc897512e_0_291#slide=id.g3cfc897512e_0_291
73+
-->
74+
75+
![om2_datamodel.png](/assets/docs/om2_datamodel.png)
76+
7177
### Data Types
7278

7379
#### Values
129 KB
Loading

0 commit comments

Comments
 (0)