Add some information on Prometheus metrics (#1966)
This commit is contained in:
parent
9eae9ac75f
commit
2110fa5122
|
|
@ -46,6 +46,7 @@ ToC:
|
||||||
- [Using without cert-manager](#using-without-cert-manager)
|
- [Using without cert-manager](#using-without-cert-manager)
|
||||||
- [Windows Runners](#setting-up-windows-runners)
|
- [Windows Runners](#setting-up-windows-runners)
|
||||||
- [Multitenancy](#multitenancy)
|
- [Multitenancy](#multitenancy)
|
||||||
|
- [Metrics](#metrics)
|
||||||
- [Troubleshooting](#troubleshooting)
|
- [Troubleshooting](#troubleshooting)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
|
|
@ -1861,6 +1862,31 @@ when and which varying ARC component(`horizontalrunnerautoscaler-controller`, `r
|
||||||
|
|
||||||
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.
|
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
|
# Troubleshooting
|
||||||
|
|
||||||
See [troubleshooting guide](../TROUBLESHOOTING.md) for solutions to various problems people have run into consistently.
|
See [troubleshooting guide](../TROUBLESHOOTING.md) for solutions to various problems people have run into consistently.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue