Skip to content

Commit

Permalink
docs: adds additional info for monitoring documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholaskuechler committed Oct 11, 2024
1 parent ddad2a4 commit 6f9cb6d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/user-guide/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,25 @@ UnderStack uses the `kube-prometheus-stack` which is a prometheus + grafana moni
<https://github.com/prometheus-operator/kube-prometheus>

It uses the namespace: `monitoring`

# Accessing Prometheus

Check failure on line 9 in docs/user-guide/monitoring.md

View workflow job for this annotation

GitHub Actions / build

Multiple top-level headings in the same document [Context: "# Accessing Prometheus"]

Prometheus is not exposed publicly so a port-forward needs to be created
and then you'll be able to access the Prometheus UI.

```

Check failure on line 14 in docs/user-guide/monitoring.md

View workflow job for this annotation

GitHub Actions / build

Fenced code blocks should have a language specified [Context: "```"]
kubectl -n monitoring port-forward service/prometheus-operated 9090:9090
```

Once the port-forward is running, you can browse to <http://localhost:9090> to access Prometheus UI.

# Accessing AlertManager

Check failure on line 20 in docs/user-guide/monitoring.md

View workflow job for this annotation

GitHub Actions / build

Multiple top-level headings in the same document [Context: "# Accessing AlertManager"]

AlertManager is not exposed publicly so a port-forward needs to be created
and then you'll be able to access the AlertManager UI.

```

Check failure on line 25 in docs/user-guide/monitoring.md

View workflow job for this annotation

GitHub Actions / build

Fenced code blocks should have a language specified [Context: "```"]
kubectl -n monitoring port-forward service/alertmanager-operated 9093:9093
```

Once the port-forward is running, you can browse to <http://localhost:9093> to access AlertManager UI.

0 comments on commit 6f9cb6d

Please sign in to comment.