Skip to content

Commit ddd2642

Browse files
binbin0325binbin0325
authored
Fix ci (alibaba#536)
1 parent 9262c31 commit ddd2642

24 files changed

+229
-223
lines changed

‎api/doc.go

+39-40
Original file line numberDiff line numberDiff line change
@@ -21,44 +21,43 @@
2121
//
2222
// Here is the example code to use Sentinel:
2323
//
24-
// import sentinel "github.com/alibaba/sentinel-golang/api"
25-
//
26-
// err := sentinel.InitDefault()
27-
// if err != nil {
28-
// log.Fatal(err)
29-
// }
30-
//
31-
// //Load sentinel rules
32-
// _, err = flow.LoadRules([]*flow.Rule{
33-
// {
34-
// Resource: "some-test",
35-
// MetricType: flow.QPS,
36-
// Threshold: 10,
37-
// ControlBehavior: flow.Reject,
38-
// },
39-
// })
40-
// if err != nil {
41-
// log.Fatalf("Unexpected error: %+v", err)
42-
// return
43-
// }
44-
// ch := make(chan struct{})
45-
// for i := 0; i < 10; i++ {
46-
// go func() {
47-
// for {
48-
// e, b := sentinel.Entry("some-test", sentinel.WithTrafficType(base.Inbound))
49-
// if b != nil {
50-
// // Blocked. We could get the block reason from the BlockError.
51-
// time.Sleep(time.Duration(rand.Uint64()%10) * time.Millisecond)
52-
// } else {
53-
// // Passed, wrap the logic here.
54-
// fmt.Println(util.CurrentTimeMillis(), "passed")
55-
// time.Sleep(time.Duration(rand.Uint64()%10) * time.Millisecond)
56-
// // Be sure the entry is exited finally.
57-
// e.Exit()
58-
// }
59-
// }
60-
// }()
61-
// }
62-
// <-ch
63-
//
24+
// import sentinel "github.com/alibaba/sentinel-golang/api"
25+
//
26+
// err := sentinel.InitDefault()
27+
// if err != nil {
28+
// log.Fatal(err)
29+
// }
30+
//
31+
// //Load sentinel rules
32+
// _, err = flow.LoadRules([]*flow.Rule{
33+
// {
34+
// Resource: "some-test",
35+
// MetricType: flow.QPS,
36+
// Threshold: 10,
37+
// ControlBehavior: flow.Reject,
38+
// },
39+
// })
40+
// if err != nil {
41+
// log.Fatalf("Unexpected error: %+v", err)
42+
// return
43+
// }
44+
// ch := make(chan struct{})
45+
// for i := 0; i < 10; i++ {
46+
// go func() {
47+
// for {
48+
// e, b := sentinel.Entry("some-test", sentinel.WithTrafficType(base.Inbound))
49+
// if b != nil {
50+
// // Blocked. We could get the block reason from the BlockError.
51+
// time.Sleep(time.Duration(rand.Uint64()%10) * time.Millisecond)
52+
// } else {
53+
// // Passed, wrap the logic here.
54+
// fmt.Println(util.CurrentTimeMillis(), "passed")
55+
// time.Sleep(time.Duration(rand.Uint64()%10) * time.Millisecond)
56+
// // Be sure the entry is exited finally.
57+
// e.Exit()
58+
// }
59+
// }
60+
// }()
61+
// }
62+
// <-ch
6463
package api

‎api/init.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ import (
2828
)
2929

3030
// Initialization func initialize the Sentinel's runtime environment, including:
31-
// 1. override global config, from manually config or yaml file or env variable
32-
// 2. override global logger
33-
// 3. initiate core component async task, including: metric log, system statistic...
31+
// 1. override global config, from manually config or yaml file or env variable
32+
// 2. override global logger
33+
// 3. initiate core component async task, including: metric log, system statistic...
34+
//
3435
// InitDefault initializes Sentinel using the configuration from system
3536
// environment and the default value.
3637
func InitDefault() error {

‎core/circuitbreaker/circuit_breaker.go

+16-17
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,19 @@ import (
2626
"github.com/pkg/errors"
2727
)
2828

29+
// Circuit Breaker State Machine:
2930
//
30-
// Circuit Breaker State Machine:
31-
//
32-
// switch to open based on rule
33-
// +-----------------------------------------------------------------------+
34-
// | |
35-
// | v
36-
// +----------------+ +----------------+ Probe +----------------+
37-
// | | | |<----------------| |
38-
// | | Probe succeed | | | |
39-
// | Closed |<------------------| HalfOpen | | Open |
40-
// | | | | Probe failed | |
41-
// | | | +---------------->| |
42-
// +----------------+ +----------------+ +----------------+
31+
// switch to open based on rule
32+
// +-----------------------------------------------------------------------+
33+
// | |
34+
// | v
35+
// +----------------+ +----------------+ Probe +----------------+
36+
// | | | |<----------------| |
37+
// | | Probe succeed | | | |
38+
// | Closed |<------------------| HalfOpen | | Open |
39+
// | | | | Probe failed | |
40+
// | | | +---------------->| |
41+
// +----------------+ +----------------+ +----------------+
4342
type State int32
4443

4544
const (
@@ -126,7 +125,7 @@ type CircuitBreaker interface {
126125
OnRequestComplete(rtt uint64, err error)
127126
}
128127

129-
//================================= circuitBreakerBase ====================================
128+
// ================================= circuitBreakerBase ====================================
130129
// circuitBreakerBase encompasses the common fields of circuit breaker.
131130
type circuitBreakerBase struct {
132131
rule *Rule
@@ -245,7 +244,7 @@ func (b *circuitBreakerBase) fromHalfOpenToClosed() bool {
245244
return false
246245
}
247246

248-
//================================= slowRtCircuitBreaker ====================================
247+
// ================================= slowRtCircuitBreaker ====================================
249248
type slowRtCircuitBreaker struct {
250249
circuitBreakerBase
251250
stat *slowRequestLeapArray
@@ -437,7 +436,7 @@ func (s *slowRequestLeapArray) allCounter() []*slowRequestCounter {
437436
return ret
438437
}
439438

440-
//================================= errorRatioCircuitBreaker ====================================
439+
// ================================= errorRatioCircuitBreaker ====================================
441440
type errorRatioCircuitBreaker struct {
442441
circuitBreakerBase
443442
minRequestAmount uint64
@@ -622,7 +621,7 @@ func (s *errorCounterLeapArray) allCounter() []*errorCounter {
622621
return ret
623622
}
624623

625-
//================================= errorCountCircuitBreaker ====================================
624+
// ================================= errorCountCircuitBreaker ====================================
626625
type errorCountCircuitBreaker struct {
627626
circuitBreakerBase
628627
minRequestAmount uint64

‎core/circuitbreaker/doc.go

+88-89
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
// Sentinel circuit breaker module supports three strategies:
1919
//
2020
// 1. SlowRequestRatio: the ratio of slow response time entry(entry's response time is great than max slow response time) exceeds the threshold. The following entry to resource will be broken.
21-
// In SlowRequestRatio strategy, user must set max response time.
21+
// In SlowRequestRatio strategy, user must set max response time.
2222
// 2. ErrorRatio: the ratio of error entry exceeds the threshold. The following entry to resource will be broken.
2323
// 3. ErrorCount: the number of error entry exceeds the threshold. The following entry to resource will be broken.
2424
//
@@ -32,97 +32,96 @@
3232
//
3333
// Sentinel circuit breaker provides the listener to observe events of state changes.
3434
//
35-
// type StateChangeListener interface {
36-
// OnTransformToClosed(prev State, rule Rule)
35+
// type StateChangeListener interface {
36+
// OnTransformToClosed(prev State, rule Rule)
3737
//
38-
// OnTransformToOpen(prev State, rule Rule, snapshot interface{})
38+
// OnTransformToOpen(prev State, rule Rule, snapshot interface{})
3939
//
40-
// OnTransformToHalfOpen(prev State, rule Rule)
41-
// }
40+
// OnTransformToHalfOpen(prev State, rule Rule)
41+
// }
4242
//
4343
// Here is the example code to use circuit breaker:
4444
//
45-
// type stateChangeTestListener struct {}
46-
//
47-
// func (s *stateChangeTestListener) OnTransformToClosed(prev circuitbreaker.State, rule circuitbreaker.Rule) {
48-
// fmt.Printf("rule.steategy: %+v, From %s to Closed, time: %d\n", rule.Strategy, prev.String(), util.CurrentTimeMillis())
49-
// }
50-
//
51-
// func (s *stateChangeTestListener) OnTransformToOpen(prev circuitbreaker.State, rule circuitbreaker.Rule, snapshot interface{}) {
52-
// fmt.Printf("rule.steategy: %+v, From %s to Open, snapshot: %.2f, time: %d\n", rule.Strategy, prev.String(), snapshot, util.CurrentTimeMillis())
53-
// }
54-
//
55-
// func (s *stateChangeTestListener) OnTransformToHalfOpen(prev circuitbreaker.State, rule circuitbreaker.Rule) {
56-
// fmt.Printf("rule.steategy: %+v, From %s to Half-Open, time: %d\n", rule.Strategy, prev.String(), util.CurrentTimeMillis())
57-
// }
58-
//
59-
// func main() {
60-
// err := sentinel.InitDefault()
61-
// if err != nil {
62-
// log.Fatal(err)
63-
// }
64-
// ch := make(chan struct{})
65-
// // Register a state change listener so that we could observer the state change of the internal circuit breaker.
66-
// circuitbreaker.RegisterStateChangeListeners(&stateChangeTestListener{})
67-
//
68-
// _, err = circuitbreaker.LoadRules([]*circuitbreaker.Rule{
69-
// // Statistic time span=10s, recoveryTimeout=3s, slowRtUpperBound=50ms, maxSlowRequestRatio=50%
70-
// {
71-
// Resource: "abc",
72-
// Strategy: circuitbreaker.SlowRequestRatio,
73-
// RetryTimeoutMs: 3000,
74-
// MinRequestAmount: 10,
75-
// StatIntervalMs: 10000,
76-
// MaxAllowedRtMs: 50,
77-
// Threshold: 0.5,
78-
// },
79-
// // Statistic time span=10s, recoveryTimeout=3s, maxErrorRatio=50%
80-
// {
81-
// Resource: "abc",
82-
// Strategy: circuitbreaker.ErrorRatio,
83-
// RetryTimeoutMs: 3000,
84-
// MinRequestAmount: 10,
85-
// StatIntervalMs: 10000,
86-
// Threshold: 0.5,
87-
// },
88-
// })
89-
// if err != nil {
90-
// log.Fatal(err)
91-
// }
92-
//
93-
// fmt.Println("Sentinel Go circuit breaking demo is running. You may see the pass/block metric in the metric log.")
94-
// go func() {
95-
// for {
96-
// e, b := sentinel.Entry("abc")
97-
// if b != nil {
98-
// //fmt.Println("g1blocked")
99-
// time.Sleep(time.Duration(rand.Uint64()%20) * time.Millisecond)
100-
// } else {
101-
// if rand.Uint64()%20 > 9 {
102-
// // Record current invocation as error.
103-
// sentinel.TraceError(e, errors.New("biz error"))
104-
// }
105-
// //fmt.Println("g1passed")
106-
// time.Sleep(time.Duration(rand.Uint64()%80+10) * time.Millisecond)
107-
// e.Exit()
108-
// }
109-
// }
110-
// }()
111-
//
112-
// go func() {
113-
// for {
114-
// e, b := sentinel.Entry("abc")
115-
// if b != nil {
116-
// //fmt.Println("g2blocked")
117-
// time.Sleep(time.Duration(rand.Uint64()%20) * time.Millisecond)
118-
// } else {
119-
// //fmt.Println("g2passed")
120-
// time.Sleep(time.Duration(rand.Uint64()%80) * time.Millisecond)
121-
// e.Exit()
122-
// }
123-
// }
124-
// }()
125-
// <-ch
126-
// }
127-
//
45+
// type stateChangeTestListener struct {}
46+
//
47+
// func (s *stateChangeTestListener) OnTransformToClosed(prev circuitbreaker.State, rule circuitbreaker.Rule) {
48+
// fmt.Printf("rule.steategy: %+v, From %s to Closed, time: %d\n", rule.Strategy, prev.String(), util.CurrentTimeMillis())
49+
// }
50+
//
51+
// func (s *stateChangeTestListener) OnTransformToOpen(prev circuitbreaker.State, rule circuitbreaker.Rule, snapshot interface{}) {
52+
// fmt.Printf("rule.steategy: %+v, From %s to Open, snapshot: %.2f, time: %d\n", rule.Strategy, prev.String(), snapshot, util.CurrentTimeMillis())
53+
// }
54+
//
55+
// func (s *stateChangeTestListener) OnTransformToHalfOpen(prev circuitbreaker.State, rule circuitbreaker.Rule) {
56+
// fmt.Printf("rule.steategy: %+v, From %s to Half-Open, time: %d\n", rule.Strategy, prev.String(), util.CurrentTimeMillis())
57+
// }
58+
//
59+
// func main() {
60+
// err := sentinel.InitDefault()
61+
// if err != nil {
62+
// log.Fatal(err)
63+
// }
64+
// ch := make(chan struct{})
65+
// // Register a state change listener so that we could observer the state change of the internal circuit breaker.
66+
// circuitbreaker.RegisterStateChangeListeners(&stateChangeTestListener{})
67+
//
68+
// _, err = circuitbreaker.LoadRules([]*circuitbreaker.Rule{
69+
// // Statistic time span=10s, recoveryTimeout=3s, slowRtUpperBound=50ms, maxSlowRequestRatio=50%
70+
// {
71+
// Resource: "abc",
72+
// Strategy: circuitbreaker.SlowRequestRatio,
73+
// RetryTimeoutMs: 3000,
74+
// MinRequestAmount: 10,
75+
// StatIntervalMs: 10000,
76+
// MaxAllowedRtMs: 50,
77+
// Threshold: 0.5,
78+
// },
79+
// // Statistic time span=10s, recoveryTimeout=3s, maxErrorRatio=50%
80+
// {
81+
// Resource: "abc",
82+
// Strategy: circuitbreaker.ErrorRatio,
83+
// RetryTimeoutMs: 3000,
84+
// MinRequestAmount: 10,
85+
// StatIntervalMs: 10000,
86+
// Threshold: 0.5,
87+
// },
88+
// })
89+
// if err != nil {
90+
// log.Fatal(err)
91+
// }
92+
//
93+
// fmt.Println("Sentinel Go circuit breaking demo is running. You may see the pass/block metric in the metric log.")
94+
// go func() {
95+
// for {
96+
// e, b := sentinel.Entry("abc")
97+
// if b != nil {
98+
// //fmt.Println("g1blocked")
99+
// time.Sleep(time.Duration(rand.Uint64()%20) * time.Millisecond)
100+
// } else {
101+
// if rand.Uint64()%20 > 9 {
102+
// // Record current invocation as error.
103+
// sentinel.TraceError(e, errors.New("biz error"))
104+
// }
105+
// //fmt.Println("g1passed")
106+
// time.Sleep(time.Duration(rand.Uint64()%80+10) * time.Millisecond)
107+
// e.Exit()
108+
// }
109+
// }
110+
// }()
111+
//
112+
// go func() {
113+
// for {
114+
// e, b := sentinel.Entry("abc")
115+
// if b != nil {
116+
// //fmt.Println("g2blocked")
117+
// time.Sleep(time.Duration(rand.Uint64()%20) * time.Millisecond)
118+
// } else {
119+
// //fmt.Println("g2passed")
120+
// time.Sleep(time.Duration(rand.Uint64()%80) * time.Millisecond)
121+
// e.Exit()
122+
// }
123+
// }
124+
// }()
125+
// <-ch
126+
// }
128127
package circuitbreaker

‎core/circuitbreaker/rule_manager.go

+4-2
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ func init() {
8888
// GetRulesOfResource returns specific resource's rules based on copy.
8989
// It doesn't take effect for circuit breaker module if user changes the rule.
9090
// GetRulesOfResource need to compete circuit breaker module's global lock and the high performance losses of copy,
91-
// reduce or do not call GetRulesOfResource frequently if possible
91+
//
92+
// reduce or do not call GetRulesOfResource frequently if possible
9293
func GetRulesOfResource(resource string) []Rule {
9394
updateMux.RLock()
9495
resRules, ok := breakerRules[resource]
@@ -106,7 +107,8 @@ func GetRulesOfResource(resource string) []Rule {
106107
// GetRules returns all the rules based on copy.
107108
// It doesn't take effect for circuit breaker module if user changes the rule.
108109
// GetRules need to compete circuit breaker module's global lock and the high performance losses of copy,
109-
// reduce or do not call GetRules if possible
110+
//
111+
// reduce or do not call GetRules if possible
110112
func GetRules() []Rule {
111113
updateMux.RLock()
112114
rules := rulesFrom(breakerRules)

‎core/flow/doc.go

-1
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,4 @@
2626
//
2727
// 1. The function both SetTrafficShapingGenerator and RemoveTrafficShapingGenerator is not thread safe.
2828
// 2. Users can not override the Sentinel supported TrafficShapingController.
29-
//
3029
package flow

‎core/flow/tc_adaptive.go

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
// If the watermark is less than Rule.MemLowWaterMarkBytes, the threshold is Rule.LowMemUsageThreshold.
1212
// If the watermark is greater than Rule.MemHighWaterMarkBytes, the threshold is Rule.HighMemUsageThreshold.
1313
// Otherwise, the threshold is ((watermark - MemLowWaterMarkBytes)/(MemHighWaterMarkBytes - MemLowWaterMarkBytes)) *
14+
//
1415
// (HighMemUsageThreshold - LowMemUsageThreshold) + LowMemUsageThreshold.
1516
type MemoryAdaptiveTrafficShapingCalculator struct {
1617
owner *TrafficShapingController

0 commit comments

Comments
 (0)