docs: Add metrics reference

Generated with a dedicated Makefile rule. Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
cilium · Feb 20, 2024 · 58fc00c · 58fc00c
1 parent c315ad2
commit 58fc00c
Show file tree

Hide file tree

Showing 3 changed files with 215 additions and 1 deletion.
diff --git a/.gitattributes b/.gitattributes
@@ -7,4 +7,5 @@
 # docs
 /docs/content/en/docs/reference/helm-chart.md linguist-generated
 /docs/content/en/docs/reference/grpc-api.md linguist-generated
+/docs/content/en/docs/reference/metrics.md linguist-generated
 /docs/data/tetragon_flags.yaml linguist-generated
diff --git a/Makefile b/Makefile
@@ -414,4 +414,16 @@ kind-install-tetragon:
 	./contrib/localdev/install-tetragon.sh --image cilium/tetragon:latest --operator cilium/tetragon-operator:latest
 
 .PHONY: kind-setup
-kind-setup: images kind kind-install-tetragon
+kind-setup: images kind kind-install-tetragon
+
+METRICS_DOCS_PATH := docs/content/en/docs/reference/metrics.md
+
+.PHONY: metrics-docs
+metrics-docs: tetra
+	echo '---' > $(METRICS_DOCS_PATH)
+	echo 'title: "Metrics Reference"' >> $(METRICS_DOCS_PATH)
+	echo 'description: >' >> $(METRICS_DOCS_PATH)
+	echo '  This reference documents Prometheus metrics exposed by Tetragon.' >> $(METRICS_DOCS_PATH)
+	echo 'weight: 4' >> $(METRICS_DOCS_PATH)
+	echo '---' >> $(METRICS_DOCS_PATH)
+	$(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs tetragon >> $(METRICS_DOCS_PATH)
diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md