moonbitstack/moonzero/breaker

README
U
Balancer
U
BidiCall
U
BidiStreamFactory
U
BidiStreamHandler
U
Breaker
U
Call
U
ClientDeps
U
ClientStreamHandler
U
Clock
U
Conf
U
CorsConf
U
Discovery
U
Endpoint
U
FileEntry
U
Files
U
Group
U
Interceptor
U
Invoker
U
JwtRoute
U
Layer
U
Lease
U
LoadBalancedChannel
U
LogLevel
U
Logger
U
ManualClock
U
Mapper
U
MaxConns
U
MethodTimeout
U
Middleware
U
MiddlewaresConf
U
Once
U
PeriodLimit
U
PeriodResult
U
Pool
U
PrivateKeyConf
U
Promise
U
RedisPeriodLimit
U
RedisTokenLimit
U
Refusal
U
Refused
U
Registrar
U
RequestLog
U
Resolve
U
RestConf
U
RestEngine
U
Ring
U
RouteOptions
U
RoutineGroup
U
RpcChannel
U
RpcClientConf
U
RpcClientMiddlewaresConf
U
RpcCluster
U
RpcGroup
U
RpcHandler
U
RpcMetrics
U
RpcServer
U
RpcServerConf
U
RpcServerMiddlewaresConf
U
Server
U
ServerDeps
U
ServerMetrics
U
ServerStreamHandler
U
Service
U
ServiceConf
U
ServiceGroup
U
Shedder
U
ShutdownCoordinator
U
SignatureConf
U
SignatureInput
U
SignatureKey
U
SignatureVerifier
U
Single
U
StableRunner
U
StatConf
U
TaskRunner
U
Ticket
U
TokenBucket
U
Unavailable
U
Update
U
VerifiedContent
U
View
U
Watcher
V
auth
V
breaker
V
canonical_key
V
chain
V
chunk
V
client_breaker
V
client_duration
V
client_interceptors
V
client_prometheus
V
client_timeout
V
client_tracing
V
content_security
V
cors
V
default_latency_buckets
V
duration_key
V
entry
V
exposition_content_type
V
file_server
V
group_by
V
hold
V
jwt_authorized
V
jwt_sign
V
jwt_verify
V
layer
V
level_name
V
logging
V
logx
V
map_reduce
V
map_reduce_parallel
V
max_conns
V
maxbytes
V
media_type_of
V
message_key
V
metrics
V
metrics_handler
V
mount_metrics
V
not_allowed
V
not_found
V
period_limit
V
period_script
V
plain_text
V
port
V
rate_limit
V
recovery
V
redis_period_limit
V
redis_rate_limit
V
refusal
V
request_id
V
retry
V
retry_with_backoff
V
rpc_port
V
server_auth
V
server_breaker
V
server_interceptors
V
server_prometheus
V
server_recover
V
server_shedding
V
server_stat
V
server_timeout
V
server_tracing
V
set_log_level
V
set_log_sink
V
set_log_writer
V
shedding
V
stamp_key
V
status_code
V
status_name
V
status_of_code
V
structured_logging
V
timed_out
V
timeout
V
token_script
V
too_large
V
too_many
V
trace_clock
V
trace_id_of
V
tracer
V
tracing
V
unavailable
V
verify_signature

moonbitstack/moonzero/breaker does not have a README file

Unavailable

pub suberror Unavailable

Raised by Breaker::run for a call the throttle shed (← go-zero's ErrServiceUnavailable).

Breaker

source

pub struct Breaker {
  core : @moonbitstack/moonward.Breaker
Breaker
  clock : @moonbitstack/moonzero/clock.Clock
Clock
  roll : () -> Double
}

Google SRE's client-side throttling breaker (← go-zero's googleBreaker).

The algorithm is moonward's Breaker; this binds it to a Clock and a source of draws, the shape go-zero's breaker has, so a call site asks with no arguments. go-zero's constants are moonward's preset sre.

Breaker::allow

source

fn Breaker::allow(self : Breaker) -> Promise?

Ask to make one call. Some promise means it may proceed and the caller settles the promise when it finishes; None means the throttle shed it.

Breaker::drop_ratio

source

fn Breaker::drop_ratio(self : Breaker) -> Double

The fraction of new calls the breaker is shedding now, zero while healthy.

Breaker::new

source

fn Breaker::new(clock : @moonbitstack/moonzero/clock.Clock
Clock, rand? : () -> Double, buckets? : Int, bucket_ms? : Int64) -> Breaker

A breaker over a buckets × bucket_ms window (go-zero's ten seconds in forty slices by default) reading time from clock. rand supplies the shed roll as a draw from [0, 1); without it the breaker draws from a system-seeded generator.

Breaker::run

source

fn[T] Breaker::run(self : Breaker, req : () -> T raise) -> T raise

Run req under the breaker (← go-zero's Breaker.Do): a shed call raises Unavailable and req never runs; a raise from req counts as a failure.

Promise

source

pub struct Promise {
  inner : @moonbitstack/moonward.Promise
Promise
  clock : @moonbitstack/moonzero/clock.Clock
Clock
}

The receipt for an admitted call (← go-zero's breaker.Promise).

Promise::accept

source

fn Promise::accept(self : Promise) -> Unit

Promise::reject

source

fn Promise::reject(self : Promise) -> Unit

Source Files

breaker.mbt

Install

Download zip

A service framework for MoonBit.

go-zeromicroservicemicroservicesservice-frameworkframeworkrestrpczrpcgrpcmiddlewarecircuit-breakerrate-limitload-sheddingload-balancingservice-discoverymetricstracingloggingconfigyamljwtsignaturecorsgzipssefile-serverp2csingleflightcacheredissqlprometheusopentelemetrygraceful-shutdownmoonapiservermoonbit

moonbitstack

Apache-2.0