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

Add Comprehensive Circuit Breaker User Guide for KMesh Kernel-Native Implementation #110

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DeshDeepakKant
Copy link
Contributor

Description

During the Open Source Promotion Plan (OSPP), KMesh has successfully implemented a circuit breaker mechanism in Kernel-Native mode. However, the current documentation lacks a comprehensive user guide to help developers understand and utilize this feature effectively.

Objectives

  • Create comprehensive documentation
  • Explain circuit breaker configuration
  • Provide implementation details
  • Include usage examples and best practices

Key Components

  • Technical overview
  • Configuration guide
  • Code snippets
  • Troubleshooting tips

@kmesh-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign lizhencheng9527 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for kmesh-net ready!

Name Link
🔨 Latest commit 4bc5264
🔍 Latest deploy log https://app.netlify.com/sites/kmesh-net/deploys/6792c183236cc2000812b9c5
😎 Deploy Preview https://deploy-preview-110--kmesh-net.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -0,0 +1,253 @@
---
draft: false
linktitle: Circuit Breaker
Copy link
Contributor

Choose a reason for hiding this comment

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

Pls add Chinese guide too.

Copy link
Member

Choose a reason for hiding this comment

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

@DeshDeepakKant Is not from China, he does not speak Chinese

spec:
containers:
- name: service
image: your-service-image
Copy link
Member

Choose a reason for hiding this comment

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

We should provide a runnable application, please refer to other guide


```bash
# Install hey load testing tool
go install github.com/rakyll/hey@latest
Copy link
Member

Choose a reason for hiding this comment

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

go install github.com/rakyll/hey@latest

# Generate load
hey -n 1000 -c 50 http://sample-service/endpoint
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure how ciercuit breaking work as this is run from a binary, how is the client managed by kmesh


```bash
# View KMesh circuit breaker logs
kubectl logs -n kmesh -l app=kmesh circuit-breaker
Copy link
Member

Choose a reason for hiding this comment

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

?

-n kmesh-system

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hzxuzhonghu Thank you for the review. I have made the changes and pushed them. The updates are running smoothly and have been verified on my end. If any further adjustments are needed, please let me know.

Additionally, I've attached some terminal logs for your reference. Could you please confirm if everything looks correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screenshot from 2025-01-23 19-37-36
Screenshot from 2025-01-23 19-37-18

@LiZhenCheng9527
Copy link
Contributor

Can you be sure that what you are submitting is verified by yourself?
This issue makes us consider whether to assign the LFX project to you.

@DeshDeepakKant DeshDeepakKant force-pushed the docs/circuit-breaker branch 2 times, most recently from 5295889 to 2545431 Compare January 23, 2025 22:23
…uide

- Implement detailed documentation for Circuit Breaker feature
- Include technical implementation details
- Provide configuration examples and best practices
- Cover troubleshooting and monitoring aspects

Signed-off-by: Desh Deepak Kant <deshdeepakkant@gmail.com>
Closes kmesh-net#103
Signed-off-by: DeshDeepakKant <deshdeepakkant@gmail.com>
Signed-off-by: DeshDeepakKant <deshdeepakkant@gmail.com>
Signed-off-by: DeshDeepakKant <deshdeepakkant@gmail.com>
@kmesh-bot
Copy link
Collaborator

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

  • 949453f docs(circuit-breaker): Add comprehensive KMesh Circuit Breaker user guide

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

fortio load -c 2 -qps 20 -t 30s http://test-service
```

### Analyzing Results
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you show the results as well?
Logs or metrics are fine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants