From 2110fa51224abc3b67cb3569b348468b5532e7f9 Mon Sep 17 00:00:00 2001
From: Mark Woolley <mw@marknet15.com>
Date: Thu, 3 Nov 2022 11:57:36 +0000
Subject: [PATCH] Add some information on Prometheus metrics (#1966)

---
 docs/detailed-docs.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/detailed-docs.md b/docs/detailed-docs.md
index ad4d1be8..d91753b9 100644
--- a/docs/detailed-docs.md
+++ b/docs/detailed-docs.md
@@ -46,6 +46,7 @@ ToC:
   - [Using without cert-manager](#using-without-cert-manager)
   - [Windows Runners](#setting-up-windows-runners)
   - [Multitenancy](#multitenancy)
+  - [Metrics](#metrics)
 - [Troubleshooting](#troubleshooting)
 - [Contributing](#contributing)
 
@@ -1860,6 +1861,31 @@ when and which varying ARC component(`horizontalrunnerautoscaler-controller`, `r
 > Just don't be surprised you have to repeat `githubAPICredentialsFrom.secretRef.name` settings among two resources!
 
 Please refer to [Deploying Using GitHub App Authentication](#deploying-using-github-app-authentication) for how you could create the Kubernetes secret containing GitHub App credentials.
+  
+### Metrics
+
+The controller also exposes Prometheus metrics on a `/metrics` endpoint. By default this is on port `8443` behind an RBAC proxy.
+
+If needed, the proxy can be disabled in the `values.yml` file:
+
+```diff
+metrics:
+  serviceAnnotations: {}
+  serviceMonitor: false
+  serviceMonitorLabels: {}
++ port: 8080
+  proxy:
++   enabled: false
+```
+
+If Prometheus is available inside the cluster, then add some `podAnnotations` to begin scraping the metrics:
+
+```diff
+podAnnotations:
++ prometheus.io/scrape: "true"
++ prometheus.io/path: /metrics
++ prometheus.io/port: "8080"
+```
 
 # Troubleshooting