kubesphere/kubesphere

[Feature Request]Metrics for KubeSphere

Open

#4,494 opened on Dec 1, 2021

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Go (2,739 forks)user submission
area/alertingarea/monitoringhelp wantedkind/feature-request

Repository metrics

Stars
 (16,945 stars)
PR merge metrics
 (Avg merge 1h 3m) (1 merged PR in 30d)

Description

What's it about? Currently, there are no metrics about KubeSphere itself, we have no idea what's inside ks-apiserver/ks-controller-manager, and thus there is no way to set alerts on abnormal metrics, such as 5xx errors. Adding metrics to KubeSphere requires a lot of effort, but I think it's worth it.

What's the reason why we need it? I believe this feature would help users to capture abnormal metrics and take precautions.

Area Suggestion /area alerting /area monitoring /kind feature-request

Contributor guide

Research direction
Investigate existing metric frameworks like Prometheus client golang, identify components (ks apiserver, ks controller manager), and implement custom metrics for request errors, latency, etc. Start with one component and follow community patterns.
Tech stack
go
Domain
backendinfrastructureobservability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoKubernetesPrometheus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25