Skip to content

Document observability #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Michael Vittrup Larsen (michaelvl) merged 2 commits into from
Jun 22, 2023
Merged

Document observability #204

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a99f9e3
Document observability
michaelvl Jun 16, 2023
4e0b9ef
Update doc/installing.md
michaelvl Jun 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions doc/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,24 @@ helm upgrade -i bifrost-gateway-controller-helm oci://ghcr.io/tv2-oss/bifrost-ga
In addition to the *bifrost-gateway-controller*, you will need
blueprints defining datapath implementations. See [Example
GatewayClassBlueprints](../blueprints/README.md).

## Metrics and Observability

The controller provides [standard controller
metrics](https://book.kubebuilder.io/reference/metrics-reference.html)
and the Helm chart provides a
[ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor)
for integration with systems that understand these.

Observability of Gateway-API resources is possbile through [Custom
Resource State
Metrics](https://github.com/kubernetes/kube-state-metrics/blob/main/docs/customresourcestate-metrics.md)
through kube-state-metrics. An example configuration for deploying
kube-state-metrics is [provided
here](test-data/kube-state-metrics-values.yaml). Generally, this
configuration provides condition status for `GatewayClass`, `Gateway`
and `HTTPRoute` resources.

An SLI for e.g. `Gateway` resources can be created from the metric
`gateway_conditions` and watching for `Gateway`s without the
`Programmed` condition.
2 changes: 2 additions & 0 deletions test-data/kube-state-metrics-values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
collectors: []

resources:
limits:
cpu: 100m
Expand Down