README
¶
Sentinel: The Sentinel of Your Microservices
Introduction
As distributed systems become increasingly popular, the reliability between services is becoming more important than ever before. Sentinel takes "flow" as breakthrough point, and works on multiple fields including flow control, traffic shaping, concurrency limiting, circuit breaking and system adaptive overload protection, to guarantee reliability and resiliency of microservices.
Sentinel provides the following features:
- Rich applicable scenarios: Sentinel has been wildly used in Alibaba, and has covered almost all the core-scenarios in Double-11 (11.11) Shopping Festivals in the past 10 years, such as “Second Kill” which needs to limit burst flow traffic to meet the system capacity, throttling, circuit breaking for unreliable downstream services, distributed rate limiting, etc.
- Real-time monitoring: Sentinel also provides real-time monitoring ability. You can see the runtime information of a single machine in real-time, and pump the metrics to outside metric components like Prometheus.
- Cloud-native ecosystem: Sentinel Go provides out-of-box integrations with cloud-native components.
Documentation
See the 中文文档 for the document in Chinese.
See the Wiki for full documentation, examples, blog posts, and other information.
If you are using Sentinel, please leave a comment here to tell us your scenario to make Sentinel better. It's also encouraged to add the link of your blog post, tutorial, demo or customized components to Awesome Sentinel.
Sub-projects
Bugs and Feedback
For bug report, questions and discussions please submit GitHub Issues.
Contributing
Contributions are always welcomed! Please see CONTRIBUTING for detailed guidelines.
You can start with the issues labeled with good first issue.
Communication
- DingTalk Group (钉钉群): 23339422
- Gitter
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides the topmost fundamental APIs for users using sentinel-golang.
|
Package api provides the topmost fundamental APIs for users using sentinel-golang. |
|
core
|
|
|
circuitbreaker
Package circuitbreaker implements the circuit breaker pattern, which provides stability and prevents cascading failures in distributed systems.
|
Package circuitbreaker implements the circuit breaker pattern, which provides stability and prevents cascading failures in distributed systems. |
|
config
Package config provides general configuration mechanism.
|
Package config provides general configuration mechanism. |
|
flow
Package flow implements the flow shaping control.
|
Package flow implements the flow shaping control. |
|
hotspot
Package hotspot provides implementation of "hot-spot" (frequent) parameter flow control.
|
Package hotspot provides implementation of "hot-spot" (frequent) parameter flow control. |
|
isolation
Package isolation provides implementation of concurrency limiting (semaphore isolation).
|
Package isolation provides implementation of concurrency limiting (semaphore isolation). |
|
stat/base
Package stat/base provides fundamental data structures of statistics.
|
Package stat/base provides fundamental data structures of statistics. |
|
system
Package system provides implementation of adaptive system protection.
|
Package system provides implementation of adaptive system protection. |
|
example
|
|
|
circuitbreaker/error_count
command
|
|
|
circuitbreaker/error_ratio
command
|
|
|
circuitbreaker/slow_rt_ratio
command
|
|
|
flow/memory_adaptive
command
|
|
|
flow/qps
command
|
|
|
flow/warm_up
command
|
|
|
hotspot_param_flow/concurrency
command
|
|
|
hotspot_param_flow/qps_reject
command
|
|
|
isolation
command
|
|
|
exporter
|
|
|
ext
|
|
|
datasource
Package ext/datasource provides interfaces and helper classes of dynamic data-source.
|
Package ext/datasource provides interfaces and helper classes of dynamic data-source. |
|
pkg
|
|
|
adapters/echo
module
|
|
|
adapters/fiber
module
|
|
|
adapters/gear
module
|
|
|
adapters/gin
module
|
|
|
adapters/go-zero
module
|
|
|
adapters/goframe
module
|
|
|
adapters/grpc
module
|
|
|
adapters/hertz
module
|
|
|
adapters/iris
module
|
|
|
adapters/kitex
module
|
|
|
adapters/micro
module
|
|
|
datasource/apollo
module
|
|
|
datasource/consul
module
|
|
|
datasource/etcdv3
module
|
|
|
datasource/k8s
module
|
|
|
datasource/nacos
module
|
|
|
tests
|
|