<img src="https://user-images.githubusercontent.com/9434884/43697219-3cb4ef3a-9975-11e8-9a9c-73f4f537442d.png" alt="Sentinel Logo" width="50%">
# Sentinel: The Sentinel of Your Microservices
[![Sentinel CI](https://github.com/alibaba/Sentinel/actions/workflows/ci.yml/badge.svg)](https://github.com/alibaba/Sentinel/actions/workflows/ci.yml)
[![Codecov](https://codecov.io/gh/alibaba/Sentinel/branch/master/graph/badge.svg)](https://codecov.io/gh/alibaba/Sentinel)
[![Maven Central](https://img.shields.io/maven-central/v/com.alibaba.csp/sentinel-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:com.alibaba.csp%20AND%20a:sentinel-core)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Gitter](https://badges.gitter.im/alibaba/Sentinel.svg)](https://gitter.im/alibaba/Sentinel)
## 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**, **circuit breaking** and **system adaptive protection**, to guarantee reliability and resilience for microservices.
Sentinel has 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, message peak clipping and valley fills, circuit breaking for unreliable downstream services, cluster flow control, 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 the aggregated runtime info of a cluster with less than 500 nodes.
- **Widespread open-source ecosystem**: Sentinel provides out-of-box integrations with commonly-used frameworks and libraries such as Spring Cloud, Dubbo and gRPC. You can easily use Sentinel by simply add the adapter dependency to your services.
- **Polyglot support**: Sentinel has provided native support for Java, [Go](https://github.com/alibaba/sentinel-golang) and [C++](https://github.com/alibaba/sentinel-cpp).
- **Various SPI extensions**: Sentinel provides easy-to-use SPI extension interfaces that allow you to quickly customize your logic, for example, custom rule management, adapting data sources, and so on.
Features overview:
![features-of-sentinel](./doc/image/sentinel-features-overview-en.png)
The community is working on the specification of traffic governance and fault-tolerance.
Please refer to [OpenSergo](https://opensergo.io/) for details.
## Documentation
See the [Sentinel Website](https://sentinelguard.io/) for the official website of Sentinel.
See the [中文文档](https://sentinelguard.io/zh-cn/docs/logs.html) for document in Chinese.
See the [Wiki](https://github.com/alibaba/Sentinel/wiki) for full documentation, examples, blog posts, operational details and other information.
Sentinel provides integration modules for various open-source frameworks
(e.g. Spring Cloud, Apache Dubbo, gRPC, Quarkus, Spring WebFlux, Reactor) and service mesh.
You can refer to [the document](https://sentinelguard.io/en-us/docs/open-source-framework-integrations.html) for more information.
If you are using Sentinel, please [**leave a comment here**](https://github.com/alibaba/Sentinel/issues/18) 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**](./doc/awesome-sentinel.md).
## Ecosystem Landscape
![ecosystem-landscape](./doc/image/sentinel-opensource-eco-landscape-en.png)
## Quick Start
Below is a simple demo that guides new users to use Sentinel in just 3 steps. It also shows how to monitor this demo using the dashboard.
### 1. Add Dependency
**Note:** Sentinel requires JDK 1.8 or later.
If you're using Maven, just add the following dependency in `pom.xml`.
```xml
<!-- replace here with the latest version -->
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-core</artifactId>
<version>1.8.6</version>
</dependency>
```
If not, you can download JAR in [Maven Center Repository](https://mvnrepository.com/artifact/com.alibaba.csp/sentinel-core).
### 2. Define Resource
Wrap your code snippet via Sentinel API: `SphU.entry(resourceName)`.
In below example, it is `System.out.println("hello world");`:
```java
try (Entry entry = SphU.entry("HelloWorld")) {
// Your business logic here.
System.out.println("hello world");
} catch (BlockException e) {
// Handle rejected request.
e.printStackTrace();
}
// try-with-resources auto exit
```
So far the code modification is done. We've also provided [annotation support module](https://github.com/alibaba/Sentinel/blob/master/sentinel-extension/sentinel-annotation-aspectj/README.md) to define resource easier.
### 3. Define Rules
If we want to limit the access times of the resource, we can **set rules to the resource**.
The following code defines a rule that limits access to the resource to 20 times per second at the maximum.
```java
List<FlowRule> rules = new ArrayList<>();
FlowRule rule = new FlowRule();
rule.setResource("HelloWorld");
// set limit qps to 20
rule.setCount(20);
rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
rules.add(rule);
FlowRuleManager.loadRules(rules);
```
For more information, please refer to [How To Use](https://sentinelguard.io/en-us/docs/basic-api-resource-rule.html).
### 4. Check the Result
After running the demo for a while, you can see the following records in `~/logs/csp/${appName}-metrics.log.{date}` (When using the default `DateFileLogHandler`).
```
|--timestamp-|------date time----|-resource-|p |block|s |e|rt |occupied
1529998904000|2018-06-26 15:41:44|HelloWorld|20|0 |20|0|0 |0
1529998905000|2018-06-26 15:41:45|HelloWorld|20|5579 |20|0|728 |0
1529998906000|2018-06-26 15:41:46|HelloWorld|20|15698|20|0|0 |0
1529998907000|2018-06-26 15:41:47|HelloWorld|20|19262|20|0|0 |0
1529998908000|2018-06-26 15:41:48|HelloWorld|20|19502|20|0|0 |0
1529998909000|2018-06-26 15:41:49|HelloWorld|20|18386|20|0|0 |0
p stands for incoming request, block for blocked by rules, s for success handled by Sentinel, e for exception count, rt for average response time (ms), occupied stands for occupiedPassQps since 1.5.0 which enable us booking more than 1 shot when entering.
```
This shows that the demo can print "hello world" 20 times per second.
More examples and information can be found in the [How To Use](https://sentinelguard.io/en-us/docs/basic-api-resource-rule.html) section.
The working principles of Sentinel can be found in [How it works](https://sentinelguard.io/en-us/docs/basic-implementation.html) section.
Samples can be found in the [sentinel-demo](https://github.com/alibaba/Sentinel/tree/master/sentinel-demo) module.
### 5. Start Dashboard
> Note: Java 8 is required for building or running the dashboard.
Sentinel also provides a simple dashboard application, on which you can monitor the clients and configure the rules in real time.
![dashboard](https://user-images.githubusercontent.com/9434884/55449295-84866d80-55fd-11e9-94e5-d3441f4a2b63.png)
For details please refer to [Dashboard](https://github.com/alibaba/Sentinel/wiki/Dashboard).
## Trouble Shooting and Logs
Sentinel will generate logs for troubleshooting and real-time monitoring.
All the information can be found in [logs](https://sentinelguard.io/en-us/docs/logs.html).
## Bugs and Feedback
For bug report, questions and discussions please submit [GitHub Issues](https://github.com/alibaba/sentinel/issues).
Contact us via [Gitter](https://gitter.im/alibaba/Sentinel) or [Email](mailto:sentinel@linux.alibaba.com).
## Contributing
Contributions are alw
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
Sentinel-1.8.6-Nacos作为持久化数据源 (2666个子文件)
com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinitionChangeObserver 93B
com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinitionChangeObserver 82B
com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinitionChangeObserver 81B
BUILD 115B
org.apache.dubbo.rpc.cluster.filter.ClusterFilter 199B
com.alibaba.csp.sentinel.cluster.client.ClusterTokenClient 65B
mvnw.cmd 6KB
com.alibaba.csp.sentinel.transport.CommandCenter 69B
com.alibaba.csp.sentinel.transport.CommandCenter 66B
com.alibaba.csp.sentinel.transport.CommandCenter 65B
com.alibaba.csp.sentinel.command.CommandHandler 1KB
com.alibaba.csp.sentinel.command.CommandHandler 928B
com.alibaba.csp.sentinel.command.CommandHandler 373B
com.alibaba.csp.sentinel.command.CommandHandler 148B
com.alibaba.csp.sentinel.command.CommandHandler 146B
com.alibaba.csp.sentinel.command.CommandHandler 86B
com.alibaba.csp.sentinel.command.CommandHandler 63B
com.alibaba.csp.sentinel.command.CommandHandlerInterceptor 172B
com.alibaba.csp.sentinel.command.CommandHandlerInterceptor 76B
bootstrap.min.css 97KB
app.css 45KB
main.css 36KB
font-awesome.min.css 30KB
page.css 6KB
timeline.css 3KB
license-stat.csv 856B
Dockerfile 264B
.dockerignore 53B
com.alibaba.csp.sentinel.cluster.server.EmbeddedClusterTokenServer 66B
spring.factories 157B
com.alibaba.dubbo.rpc.Filter 295B
org.apache.dubbo.rpc.Filter 295B
com.alipay.sofa.rpc.filter.Filter 257B
com.weibo.api.motan.filter.Filter 133B
org.apache.dubbo.rpc.Filter 99B
slots.gif 154KB
.gitignore 376B
.gitignore 295B
.gitignore 18B
com.alibaba.csp.sentinel.transport.HeartbeatSender 73B
com.alibaba.csp.sentinel.transport.HeartbeatSender 70B
com.alibaba.csp.sentinel.transport.HeartbeatSender 64B
index_dev.htm 1KB
index.htm 902B
flow-rule-dialog.html 10KB
cluster-server-assign-dialog.html 9KB
flow-rule-dialog.html 8KB
param-flow-rule-dialog.html 8KB
cluster_app_assign_manage.html 6KB
identity.html 6KB
metric.html 6KB
param_flow.html 6KB
cluster_app_server_list.html 5KB
flow_v1.html 5KB
degrade-rule-dialog.html 5KB
identity.html 5KB
sidebar.html 5KB
flow_v2.html 5KB
authority.html 4KB
system.html 4KB
degrade.html 4KB
cluster_single_config.html 4KB
system-rule-dialog.html 4KB
cluster_app_server_overview.html 4KB
index.html 4KB
flow.html 4KB
api.html 4KB
cluster_app_client_list.html 3KB
machine.html 3KB
authority-rule-dialog.html 3KB
api-dialog.html 3KB
cluster-client-config-dialog.html 2KB
cluster-server-connection-detail-dialog.html 2KB
client.html 2KB
server.html 2KB
login.html 2KB
pagination.tpl.html 1KB
confirm-dialog.html 915B
header.html 589B
sidebar-search.html 332B
home.html 255B
main.html 215B
favicon.ico 17KB
sentinel-datasource-eureka.iml 19KB
sentinel-jax-rs-quarkus-adapter-deployment.iml 18KB
sentinel-demo-quarkus.iml 17KB
sentinel-jax-rs-adapter.iml 16KB
sentinel-zuul-adapter.iml 13KB
sentinel-demo-jax-rs.iml 13KB
sentinel-dashboard.iml 12KB
sentinel-spring-cloud-gateway-adapter.iml 12KB
sentinel-demo-zuul-gateway.iml 12KB
sentinel-zuul2-adapter.iml 11KB
sentinel-demo-zuul2-gateway.iml 11KB
sentinel-datasource-spring-cloud-config.iml 11KB
sentinel-annotation-quarkus-adapter-deployment.iml 11KB
sentinel-spring-webflux-adapter.iml 10KB
sentinel-native-image-quarkus-adapter-deployment.iml 9KB
sentinel-demo-spring-cloud-gateway.iml 9KB
sentinel-spring-webmvc-adapter.iml 9KB
共 2666 条
- 1
- 2
- 3
- 4
- 5
- 6
- 27
资源评论
小安灬
- 粉丝: 47
- 资源: 27
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功