Skip to content

Commit 7b9f7c7

Browse files
committed
docs: fix markdownlint MD009 and MD060 in README files
1 parent 8f0bac7 commit 7b9f7c7

9 files changed

Lines changed: 138 additions & 178 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sentinel: The Sentinel of Your Microservices
1+
# Sentinel: The Sentinel of Your Microservices
22

33
<img src="https://user-images.githubusercontent.com/9434884/43697219-3cb4ef3a-9975-11e8-9a9c-73f4f537442d.png" alt="Sentinel Logo" width="50%">
44

@@ -18,7 +18,7 @@ to guarantee reliability and resilience for microservices.
1818

1919
Sentinel has the following features:
2020

21-
- **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.
21+
- **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 鈥淪econd 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.
2222
- **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.
2323
- **Widespread open-source ecosystem**: Sentinel provides out-of-box integrations with commonly-used frameworks and libraries such as Spring Cloud, gRPC, Apache Dubbo and Quarkus. You can easily use Sentinel by simply add the adapter dependency to your services.
2424
- **Polyglot support**: Sentinel has provided native support for Java, [Go](https://github.com/alibaba/sentinel-golang), [C++](https://github.com/alibaba/sentinel-cpp) and [Rust](https://github.com/sentinel-group/sentinel-rust).
@@ -35,7 +35,7 @@ Please refer to [OpenSergo](https://opensergo.io/) for details.
3535

3636
See the [Sentinel Website](https://sentinelguard.io/) for the official website of Sentinel.
3737

38-
See the [中文文档](https://sentinelguard.io/zh-cn/docs/introduction.html) for document in Chinese.
38+
See the [涓枃鏂囨。](https://sentinelguard.io/zh-cn/docs/introduction.html) for document in Chinese.
3939

4040
See the [Wiki](https://github.com/alibaba/Sentinel/wiki) for full documentation, examples, blog posts, operational details and other information.
4141

@@ -112,13 +112,13 @@ For more information, please refer to [How To Use](https://sentinelguard.io/en-u
112112
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`).
113113

114114
```plaintext
115-
|--timestamp-|------date time----|-resource-|p |block|s |e|rt |occupied
116-
1529998904000|2018-06-26 15:41:44|HelloWorld|20|0 |20|0|0 |0
117-
1529998905000|2018-06-26 15:41:45|HelloWorld|20|5579 |20|0|728 |0
118-
1529998906000|2018-06-26 15:41:46|HelloWorld|20|15698|20|0|0 |0
119-
1529998907000|2018-06-26 15:41:47|HelloWorld|20|19262|20|0|0 |0
120-
1529998908000|2018-06-26 15:41:48|HelloWorld|20|19502|20|0|0 |0
121-
1529998909000|2018-06-26 15:41:49|HelloWorld|20|18386|20|0|0 |0
115+
|--timestamp-|------date time----|-resource-|p|block|s|e|rt|occupied
116+
1529998904000|2018-06-26 15:41:44|HelloWorld|20|0|20|0|0|0
117+
1529998905000|2018-06-26 15:41:45|HelloWorld|20|5579|20|0|728|0
118+
1529998906000|2018-06-26 15:41:46|HelloWorld|20|15698|20|0|0|0
119+
1529998907000|2018-06-26 15:41:47|HelloWorld|20|19262|20|0|0|0
120+
1529998908000|2018-06-26 15:41:48|HelloWorld|20|19502|20|0|0|0
121+
1529998909000|2018-06-26 15:41:49|HelloWorld|20|18386|20|0|0|0
122122
123123
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.
124124
```
@@ -160,9 +160,9 @@ You can start with the issues labeled with [`good first issue`](https://github.c
160160

161161
## Enterprise Service
162162

163-
If you need Sentinel enterprise service support (Sentinel 企业版), or purchase cloud product services,
163+
If you need Sentinel enterprise service support (Sentinel 浼佷笟鐗?, or purchase cloud product services,
164164
you can join the discussion by the DingTalk group (34754806). It can also be directly activated
165-
and used through the [microservice engine (MSE 微服务引擎) provided by Alibaba Cloud](https://cn.aliyun.com/product/aliware/mse?spm=sentinel-github.index.0.0.0).
165+
and used through the [microservice engine (MSE 寰湇鍔″紩鎿? provided by Alibaba Cloud](https://cn.aliyun.com/product/aliware/mse?spm=sentinel-github.index.0.0.0).
166166

167167
## Credits
168168

@@ -178,13 +178,13 @@ If you are using Sentinel, please [add your company here](https://github.com/ali
178178
![Alibaba Group](https://docs.alibabagroup.com/assets2/images/en/global/logo_header.png)
179179
![AntFin](https://user-images.githubusercontent.com/9434884/90598732-30961c00-e226-11ea-8c86-0b1d7f7875c7.png)
180180
![Taiping Renshou](http://www.cntaiping.com/tplresource/cms/www/taiping/img/home_new/tp_logo_img.png)
181-
![拼多多](http://cdn.pinduoduo.com/assets/img/pdd_logo_v3.png)
182-
![爱奇艺](https://user-images.githubusercontent.com/9434884/90598445-a51c8b00-e225-11ea-9327-3543525f3f2a.png)
181+
![鎷煎澶歖(http://cdn.pinduoduo.com/assets/img/pdd_logo_v3.png)
182+
![鐖卞鑹篯(https://user-images.githubusercontent.com/9434884/90598445-a51c8b00-e225-11ea-9327-3543525f3f2a.png)
183183
![Shunfeng Technology](https://user-images.githubusercontent.com/9434884/48463502-2f48eb80-e817-11e8-984f-2f9b1b789e2d.png)
184-
![二维火](https://user-images.githubusercontent.com/9434884/49358468-bc43de00-f70d-11e8-97fe-0bf05865f29f.png)
184+
![浜岀淮鐏玗(https://user-images.githubusercontent.com/9434884/49358468-bc43de00-f70d-11e8-97fe-0bf05865f29f.png)
185185
![Mandao](https://user-images.githubusercontent.com/9434884/48463559-6cad7900-e817-11e8-87e4-42952b074837.png)
186-
![文轩在线](http://static.winxuancdn.com/css/v2/images/logo.png)
187-
![客如云](https://www.keruyun.com/static/krynew/images/logo.png)
188-
![亲宝宝](https://stlib.qbb6.com/wclt/img/home_hd/version1/title_logo.png)
189-
![金汇金融](https://res.jinhui365.com/r/images/logo2.png?v=1.527)
190-
![闪电购](http://cdn.52shangou.com/shandianbang/official-source/3.1.1/build/images/logo.png)
186+
![鏂囪僵鍦ㄧ嚎](http://static.winxuancdn.com/css/v2/images/logo.png)
187+
![瀹㈠浜慮(https://www.keruyun.com/static/krynew/images/logo.png)
188+
![浜插疂瀹漖(https://stlib.qbb6.com/wclt/img/home_hd/version1/title_logo.png)
189+
![閲戞眹閲戣瀺](https://res.jinhui365.com/r/images/logo2.png?v=1.527)
190+
![闂數璐璢(http://cdn.52shangou.com/shandianbang/official-source/3.1.1/build/images/logo.png)

sentinel-adapter/sentinel-apache-httpclient-adapter/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sentinel Apache Httpclient Adapter
1+
# Sentinel Apache Httpclient Adapter
22

33
## Introduction
44

@@ -32,11 +32,7 @@ CloseableHttpClient httpclient = builder.build();
3232

3333
- `SentinelApacheHttpClientConfig` configuration:
3434

35-
| name | description | type | default value |
36-
| ------ | ------------ | ------ | ------- |
37-
| prefix | customize resource prefix | `String` | `httpclient:` |
38-
| extractor | customize resource extractor | `ApacheHttpClientResourceExtractor` | `DefaultApacheHttpClientResourceExtractor` |
39-
| fallback | handle request when it is blocked | `ApacheHttpClientFallback` | `DefaultApacheHttpClientFallback` |
35+
|name|description|type|default value||------|------------|------|-------||prefix|customize resource prefix|`String`|`httpclient:`||extractor|customize resource extractor|`ApacheHttpClientResourceExtractor`|`DefaultApacheHttpClientResourceExtractor`||fallback|handle request when it is blocked|`ApacheHttpClientFallback`|`DefaultApacheHttpClientFallback`|
4036

4137
### extractor (resource extractor)
4238

sentinel-adapter/sentinel-okhttp-adapter/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sentinel OkHttp Adapter
1+
# Sentinel OkHttp Adapter
22

33
## Introduction
44

@@ -26,11 +26,7 @@ OkHttpClient client = new OkHttpClient.Builder()
2626

2727
`SentinelOkHttpConfig` configuration:
2828

29-
| name | description | type | default value |
30-
| ------ | ------------ | ------ | ------- |
31-
| resourcePrefix | customized resource name prefix | `String` | `okhttp:` |
32-
| resourceExtractor | customized resource extractor | `OkHttpResourceExtractor` | `DefaultOkHttpResourceExtractor` |
33-
| fallback | handle request when it is blocked | `OkHttpFallback` | `DefaultOkHttpFallback` |
29+
|name|description|type|default value||------|------------|------|-------||resourcePrefix|customized resource name prefix|`String`|`okhttp:`||resourceExtractor|customized resource extractor|`OkHttpResourceExtractor`|`DefaultOkHttpResourceExtractor`||fallback|handle request when it is blocked|`OkHttpFallback`|`DefaultOkHttpFallback`|
3430

3531
### Resource Extractor
3632

sentinel-adapter/sentinel-spring-webmvc-adapter/README.md

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sentinel Spring MVC Adapter
1+
# Sentinel Spring MVC Adapter
22

33
## Introduction
44

@@ -91,23 +91,4 @@ config.setBlockExceptionHandler((request, response, e) -> {
9191

9292
- Common configuration in `SentinelWebMvcConfig` and `SentinelWebMvcTotalConfig`:
9393

94-
| name | description | type | default value |
95-
| ------ | ------------ | ------ | ------- |
96-
| `blockExceptionHandler` | The handler that handles the block request | `BlockExceptionHandler` | null (throw out the BlockException) |
97-
| `originParser` | Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request | `RequestOriginParser` | - |
98-
99-
- `SentinelWebMvcConfig` configuration:
100-
101-
| name | description | type | default value |
102-
| ------ | ------------ | ------ | ------- |
103-
| urlCleaner | The `UrlCleaner` interface is designed for clean and unify the URL resource. | `UrlCleaner` | - |
104-
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_entry_attr` |
105-
| httpMethodSpecify | Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`). | `boolean` | `false` |
106-
| webContextUnify | Specify whether unify web context(i.e. use the default context name). | `boolean` | `true` |
107-
108-
- `SentinelWebMvcTotalConfig` configuration:
109-
110-
| name | description | type | default value |
111-
| ------ | ------------ | ------ | ------- |
112-
| totalResourceName | The resource name in `SentinelTotalInterceptor` | `String` | `spring-mvc-total-url-request` |
113-
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_total_entry_attr` |
94+
|name|description|type|default value||------|------------|------|-------||`blockExceptionHandler`|The handler that handles the block request|`BlockExceptionHandler`|null (throw out the BlockException)||`originParser`|Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request|`RequestOriginParser`|-|- `SentinelWebMvcConfig` configuration:|name|description|type|default value||------|------------|------|-------||urlCleaner|The `UrlCleaner` interface is designed for clean and unify the URL resource.|`UrlCleaner`|-||requestAttributeName|Attribute key in request used by Sentinel (internal)|`String`|`$$sentinel_spring_web_entry_attr`||httpMethodSpecify|Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`).|`boolean`|`false`||webContextUnify|Specify whether unify web context(i.e. use the default context name).|`boolean`|`true`|- `SentinelWebMvcTotalConfig` configuration:|name|description|type|default value||------|------------|------|-------||totalResourceName|The resource name in `SentinelTotalInterceptor`|`String`|`spring-mvc-total-url-request`||requestAttributeName|Attribute key in request used by Sentinel (internal)|`String`|`$$sentinel_spring_web_total_entry_attr`|

sentinel-cluster/sentinel-cluster-server-envoy-rls/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sentinel Token Server (Envoy RLS implementation)
1+
# Sentinel Token Server (Envoy RLS implementation)
22

33
This module provides the [Envoy rate limiting gRPC service](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/global_rate_limiting#arch-overview-rate-limit) implementation
44
with Sentinel token server.
@@ -50,11 +50,7 @@ We may also retrieve the converted `FlowRule` via the command API `localhost:871
5050

5151
The configuration list:
5252

53-
| Item (env) | Item (JVM property) | Description | Default Value | Required |
54-
| -------- | -------- | -------- | -------- | -------- |
55-
| `SENTINEL_RLS_GRPC_PORT` | `csp.sentinel.grpc.server.port` | The RLS gRPC server port | **10240** | false |
56-
| `SENTINEL_RLS_RULE_FILE_PATH` | `csp.sentinel.rls.rule.file` | The path of the RLS rule yaml file | - | **true** |
57-
| `SENTINEL_RLS_ACCESS_LOG` | - | Whether to enable the access log (`on` for enable) | off | false |
53+
|Item (env)|Item (JVM property)|Description|Default Value|Required||--------|--------|--------|--------|--------||`SENTINEL_RLS_GRPC_PORT`|`csp.sentinel.grpc.server.port`|The RLS gRPC server port|**10240**|false||`SENTINEL_RLS_RULE_FILE_PATH`|`csp.sentinel.rls.rule.file`|The path of the RLS rule yaml file|-|**true**||`SENTINEL_RLS_ACCESS_LOG`|-|Whether to enable the access log (`on` for enable)|off|false|
5854

5955
## Samples
6056

0 commit comments

Comments
 (0)