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 (16,945 stars) (2,739 forks)user submission
area/alertingarea/monitoringhelp wantedkind/feature-request

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

Tech stack
gokubernetesdocker
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
5
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
KubeSphere architecturePrometheus metricsGo programmingKubernetes monitoring
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
This feature request aims to add metrics for KubeSphere's core components (ks apiserver, ks controller manager). The implementation is broad and requires understanding of the existing codebase and metrics infrastructure. Start by examining the repository structure (e.g., pkg/apiserver, pkg/controller) to identify where to instrument metrics. Review the Prometheus client library usage in the project and check for existing metrics patterns. Consider looking at how similar Kubernetes ecosystem projects (e.g., Kubernetes itself) expose custom metrics. The issue has no detailed specification, so clarifying the required metrics (e.g., request counts, error rates) through comments would be a first step.