Skip to content
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.

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

refactor(apiserver): don't need to fail the request when querying podmetrics failed #226

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Dec 3, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced error handling in the API server for improved resilience during pod metrics retrieval.
    • The API can now gracefully handle transient states without blocking responses.
  • Bug Fixes

    • Adjusted error handling to prevent failures from impacting overall API functionality.

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The changes in the apiserver.go file enhance error handling and control flow within the API server's methods. The getPods method now logs errors when pod metrics cannot be retrieved, allowing the processing of subsequent pods to continue. In the getPodMetrics method, adjustments ensure that a "not found" error from the metrics server results in a nil return for metrics instead of propagating the error. These modifications improve the API's robustness without altering method signatures or data structures.

Changes

File Change Summary
pkg/apiserver/apiserver.go Enhanced error handling in getPods and getPodMetrics methods; logging errors and allowing continued processing of pods.

Poem

In the server's heart, where metrics play,
A rabbit hops in a graceful way.
Errors logged, no pods in despair,
With each little hop, we show we care.
Smooth flows and grace, a joyful dance,
In the code's embrace, we take our chance! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
pkg/apiserver/apiserver.go (2)

331-332: LGTM! Consider enhancing the error message

The error handling improvement aligns well with the PR objective, making the API more resilient by preventing pod metrics retrieval failures from blocking the entire response.

Consider making the error message more specific about the impact:

-				klog.Errorf("failed to get pod metrics for pod %s/%s: %v", namespace, pod.Name, err)
+				klog.Errorf("failed to get pod metrics for pod %s/%s (continuing without metrics): %v", namespace, pod.Name, err)

399-406: LGTM! Consider simplifying the error handling

The special handling for NotFound errors is appropriate and well-documented. However, the code structure could be simplified.

Consider this more concise version:

 func (s *Server) getPodMetrics(ctx context.Context, namespace, name string) (*podmetricsv1beta1.PodMetrics, error) {
 	var podMetrics podmetricsv1beta1.PodMetrics
 	err := s.Get(ctx, client.ObjectKey{Namespace: namespace, Name: name}, &podMetrics)
-
-	// It's possible when the pod just started, the metrics-server hasn't collected the metrics yet.
-	if apierrors.IsNotFound(err) {
-		return nil, nil
-	}
-
-	if err != nil {
+	// Return nil when metrics are not found (possible when pod just started)
+	if err != nil && !errors.IsNotFound(err) {
 		return nil, err
 	}
-	return &podMetrics, nil
+	if err == nil {
+		return &podMetrics, nil
+	}
+	return nil, nil
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3b0b025 and 5145c61.

📒 Files selected for processing (1)
  • pkg/apiserver/apiserver.go (3 hunks)

pkg/apiserver/apiserver.go Show resolved Hide resolved
@zyy17 zyy17 merged commit 8670e57 into GreptimeTeam:main Dec 3, 2024
5 checks passed
@zyy17 zyy17 deleted the refactor/dont-return-error branch December 3, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants