Skip to content

Commit f909189

Browse files
committed
Add docs on prometheus
1 parent f9e2713 commit f909189

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -1687,6 +1687,28 @@ a volume, add `enable_resize = true` to its specs map. You can then increase the
16871687
The corresponding volume will be expanded by the cloud provider and the filesystem will be
16881688
extended by Puppet.
16891689
1690+
### 10.15 Access Prometheus' expression browser
1691+
1692+
Prometheus is an open-source systems monitoring and alerting toolkit. It is installed by default
1693+
in Magic Castle. Every instance exposes their usage metrics and some services do to. To explore
1694+
and visualize this data, it possible to access the [expression browser](https://prometheus.io/docs/visualization/browser/).
1695+
1696+
From inside the cluster, it is typically available at `http://mgmt1:9090`. Given DNS is configured
1697+
for your cluster, you can add the following snippet to your [hieradata](#413-hieradata-optional). to access the expression browser
1698+
from Internet.
1699+
1700+
```yaml
1701+
lookup_options:
1702+
profile::reverse_proxy::subdomains:
1703+
merge: 'hash'
1704+
profile::reverse_proxy::subdomains:
1705+
metrics: "%{lookup('terraform.tag_ip.mgmt.0')}:9090"
1706+
profile::reverse_proxy::remote_ips:
1707+
metrics: ['<REPLACE_BY_YOUR_OWN_IP>']
1708+
```
1709+
1710+
Prometheus will then be available at `http://metrics.your-cluster.yourdomain.tld/`.
1711+
16901712
## 11. Customize Magic Castle Terraform Files
16911713
16921714
You can modify the Terraform module files in the folder named after your cloud

0 commit comments

Comments
 (0)