feat: Add metrics setup documentation

Signed-off-by: Eugene Doudine <eugene.doudine@octopus.com>

Author: dudinea

Makefile

@@ -234,6 +234,11 @@ openapigen:
 notification-docs:
 	./hack/generate-notification-docs.sh
 
+.PHONY: metrics-docs
+metrics-docs:
+	cp samples/metrics/argocd-monorepo-controller-sm.yaml ./docs/
+	cp samples/metrics/argocd-monorepo-repo-server-sm.yaml 	./docs/
+
 
 .PHONY: clientgen
 clientgen:

docs/argocd-monorepo-controller-sm.yaml

@@ -0,0 +1,22 @@
+---
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: argocd-monorepo-controller
+  labels:
+    app.kubernetes.io/name: argocd-monorepo-controller
+    app.kubernetes.io/component: monorepo-controller
+    app.kubernetes.io/part-of: argocd
+    release: prometheus-operator
+spec:
+  endpoints:
+    - port: metrics
+      interval: 30s
+      path: /metrics
+      honorLabels: false
+  namespaceSelector:
+    matchNames:
+      - argocd
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: argocd-monorepo-controller-metrics

docs/argocd-monorepo-repo-server-sm.yaml

@@ -0,0 +1,23 @@
+---
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: argocd-monorepo-repo-server
+  labels:
+    app.kubernetes.io/name: argocd-monorepo-repo-server
+    app.kubernetes.io/component: monorepo-repo-server
+    app.kubernetes.io/part-of: argocd
+    release: prometheus-operator
+spec:
+  endpoints:
+    - port: metrics
+      interval: 30s
+      path: /metrics
+      honorLabels: false
+  namespaceSelector:
+    matchNames:
+      - argocd
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: argocd-monorepo-repo-server
+

docs/metrics.md

@@ -0,0 +1,22 @@
+# Monorepo Controller Metrics
+
+Both Monorepo Controller and Monorepo Repo Server expose Prometheus metrics
+
+
+## Prometheus Operator
+
+If using Prometheus Operator, the following ServiceMonitor [example
+manifests](https://github.com/argoproj-labs/argocd-monorepo-controller/tree/main/samples/metrics) can be used.  Add a namespace where Argo CD is installed
+and change `metadata.labels.release` to the name of label selected by
+your Prometheus.
+
+```yaml
+{!docs/argocd-monorepo-controller-sm.yaml!}
+```
+
+```yaml
+{!docs/argocd-monorepo-controller-sm.yaml!}
+```
+
+
+

mkdocs.yml

@@ -24,6 +24,7 @@ nav:
     - "Monorepo Controller Configuration": monorepo_controller_conf.md
     - "Monorepo Repo Server Configuration": monorepo_repo_server_conf.md
     - Notifications: notifications.md
+    - "Metrics": metrics.md
 - Acknowledgements: acknowledgements.md
 
 - Releases ⧉: https://github.com/argoproj-labs/argocd-monorepo-controller/releases