moonbitstack/moonzero/breaker

README
U
Balancer
U
BidiCall
U
BidiStreamFactory
U
BidiStreamHandler
U
Breaker
U
ClientStreamHandler
U
Clock
U
Conf
U
ConfigError
U
ConsulClient
U
ConsulDiscovery
U
ConsulError
U
ConsulHttp
U
ConsulResponse
U
CorsConf
U
CounterVec
U
Endpoint
U
EtcdClient
U
EtcdDeleteRangeRequest
U
EtcdDeleteRangeResponse
U
EtcdDiscovery
U
EtcdError
U
EtcdEvent
U
EtcdEventType
U
EtcdKeyValue
U
EtcdLeaseGrantRequest
U
EtcdLeaseGrantResponse
U
EtcdLeaseKeepAliveRequest
U
EtcdLeaseKeepAliveResponse
U
EtcdPutRequest
U
EtcdPutResponse
U
EtcdRangeRequest
U
EtcdRangeResponse
U
EtcdWatchCancelRequest
U
EtcdWatchCreateRequest
U
EtcdWatchRequest
U
EtcdWatchResponse
U
Group
U
Histogram
U
InMemoryRegistry
U
Layer
U
LoadBalancedChannel
U
LogLevel
U
Logger
U
ManualClock
U
MaxConns
U
Middleware
U
MiddlewaresConf
U
PeriodLimit
U
PeriodResult
U
PersistentRegistry
U
PrivateKeyConf
U
Promise
U
RedisClient
U
RedisConn
U
RedisDiscovery
U
RedisError
U
RedisPeriodLimit
U
RedisScript
U
RedisTokenLimit
U
Refusal
U
RegistryEvent
U
RequestLog
U
Resolve
U
RespError
U
RespReader
U
RespValue
U
RestConf
U
RestEngine
U
RoundRobin
U
RpcChannel
U
RpcCluster
U
RpcGroup
U
RpcHandler
U
RpcServer
U
RpcServerConf
U
Server
U
ServerMetrics
U
ServerStreamHandler
U
ServiceConf
U
Shedder
U
ShutdownCoordinator
U
SignatureConf
U
Ticket
U
TokenBucket
U
TraceContext
U
Unavailable
U
WeightedRoundRobin
V
auth
V
breaker
V
canonical_key
V
consul_check_id
V
consul_parse_health
V
consul_register_body
V
cors
V
default_latency_buckets
V
duration_key
V
entry
V
etcd_prefix_end
V
etcd_service_prefix
V
exposition_content_type
V
generate_span_id
V
generate_trace_id
V
jwt_authorized
V
jwt_sign
V
jwt_verify
V
level_name
V
logging
V
logx
V
max_conns
V
maxbytes
V
message_key
V
metrics
V
metrics_handler
V
mount_metrics
V
next_trace_context
V
parse_traceparent
V
period_limit
V
period_script
V
pick_first
V
plain_text
V
port
V
rate_limit
V
recovery
V
redis_instance_key
V
redis_period_limit
V
redis_rate_limit
V
redis_service_pattern
V
redis_service_prefix
V
refusal
V
request_id
V
resolve_one
V
resp_command
V
resp_encode_command
V
resp_kind
V
rpc_port
V
set_log_level
V
set_log_sink
V
set_log_writer
V
shedding
V
stamp_key
V
status_of_code
V
structured_logging
V
timed_out
V
timeout
V
token_script
V
too_large
V
too_many
V
tracing
V
unavailable

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 after go-zero: config-driven REST engine and middleware over moonapi, zRPC over moonrpc, discovery on etcd, consul and redis, and go-zero's breaker, shedder and limiters over moonward.

go-zeromicroserviceservermiddlewaremoonapimoonbit