Kuadrant / Kuadrant/kuadrant-operator

Update the Platform Engineer dashboard with gateway/policy status information

Open
#437 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
94
Forks
89
Avg merge
3d 4h
Merged PRs (30d)
43

Description

* This will primarily be about showing the state of Gateways and Policies, and will depend on separate work (ISSUES IN STATUS EPIC TBD).
* Update the [gateway-api-state-metrics](https://github.com/Kuadrant/gateway-api-state-metrics) project to have example config for reporting any new status information as metrics. Depends on ISSUES IN STATUS EPIC TBD

May also depend on https://github.com/Kuadrant/docs.kuadrant.io/issues/72

In OpenShift, it can be useful to have a direct link to the resource (e.g. RateLimitPolicy) so it can be viewed in full through Openshift console.

The dashboard should be included in the unified kuadrant release process such that:
- it can be sourced at a specific version
- it can be imported directly as is, or taken and modified (the raw json/yaml is easily available)

Dashboards will have tooltips on the panels created, to aid users on what the panels are meant to show to allow them gain more knowledge to be able to customize them.
Add new metrics & labels/dimensions to kuadrant components where needed to support the above dashboards

Recommendation is to follow through the API Quickstart and modify the dashboard in grafana directly.
Then export it as json when changes have been made.

Contributor guide

Open the contributing guide

Research direction

Start with the closed pull request #494, the API Quickstart, and the gateway-api-state-metrics project. Review the existing dashboard and the separate status work before determining the required Gateway and Policy metrics, labels, links, tooltips, and release packaging. Done means the versioned dashboard can be imported or modified directly, with exported JSON available and supporting metrics documented or configured.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, grafana, kubernetes
Domain
cloud, devops, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.