Skip to content

Commit 0e148b8

Browse files
authored
typo fix in document (#329)
1 parent da3082a commit 0e148b8

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ EaseProbe supports notification delivery to the following:
7676

7777
> **Note**:
7878
>
79-
> 1) The notification is **Edge-Triggered Mode** by default, if you want to config it as **Level-Triggered Mode** with different interval and max notification, please refer to the manual - [Altering Interval](./docs/Manual.md#112-alerting-interval).
79+
> 1) The notification is **Edge-Triggered Mode** by default, if you want to config it as **Level-Triggered Mode** with different interval and max notification, please refer to the manual - [Alerting Interval](./docs/Manual.md#112-alerting-interval).
8080
>
8181
> 2) Windows platforms do not support syslog as notification method.
8282

docs/Manual.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ EaseProbe has the following major modules:
3535
- [1.8 Host](#18-host)
3636
- [1.9 Native Client](#19-native-client)
3737
- [1.9.1 Redis](#191-redis)
38-
- [1.9.2 MySQL](#192-msyql)
38+
- [1.9.2 MySQL](#192-mysql)
3939
- [1.9.3 MongoDB](#193-mongodb)
4040
- [1.9.4 Memcache](#194-memcache)
4141
- [1.9.5 Kafka](#195-kafka)
@@ -144,7 +144,7 @@ The following is an example of the alerting interval for HTTP Probe:
144144
http:
145145
- name: Web Service
146146
url: http://example.com:1080
147-
alter:
147+
alert:
148148
strategy: regular
149149
factor: 1
150150
max: 3
@@ -153,7 +153,7 @@ The following is an example of the alerting interval for HTTP Probe:
153153
> **Note**:
154154
>
155155
> 1. The default strategy is regular and the max time is 1, this would be the same as the old behavior - edge trigger.
156-
> 2. The altering interval is aligned with the probe interval, it is triggered by the probe failure.
156+
> 2. The alerting interval is aligned with the probe interval, it is triggered by the probe failure.
157157
> 3. The alerting interval configuration can be configured in the global settings `settings.probe`, and the probe's own configuration will override the global settings.
158158

159159
#### 1.1.2.1 Regular Strategy
@@ -167,7 +167,7 @@ The formula is:
167167
For example:
168168

169169
```yaml
170-
alter:
170+
alert:
171171
strategy: regular
172172
factor: 1
173173
max: 10
@@ -194,7 +194,7 @@ The formula is:
194194
For example:
195195

196196
```yaml
197-
alter:
197+
alert:
198198
strategy: increment
199199
factor: 1
200200
max: 10
@@ -221,7 +221,7 @@ The formula is:
221221
For example:
222222

223223
```yaml
224-
alter:
224+
alert:
225225
strategy: exponent
226226
factor: 1
227227
max: 10
@@ -1874,10 +1874,10 @@ settings:
18741874
interval: 1m # probe every minute for all probes
18751875
failure: 2 # number of consecutive failed probes needed to determine the status down, default: 1
18761876
success: 1 # number of consecutive successful probes needed to determine the status up, default: 1
1877-
alert: # alter interval for all probes
1877+
alert: # alert interval for all probes
18781878
strategy: "regular" # it can be "regular", "increment" or "exponent", default: "regular"
18791879
factor: 1 # the factor of the interval, default: 1
1880-
max: 5 # the max of the alter, default: 1
1880+
max: 5 # the max of the alert, default: 1
18811881

18821882

18831883
# easeprobe program running log file.

resources/config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,10 +407,10 @@ notify:
407407
# interval: 1m # probe every minute for all probes
408408
# failure: 2 # number of consecutive failed probes needed to determine the status down, default: 1
409409
# success: 1 # number of consecutive successful probes needed to determine the status up, default: 1
410-
# alert: # alter interval for all probes
410+
# alert: # alert interval for all probes
411411
# strategy: "regular" # it can be "regular", "increment" or "exponent", default: "regular"
412412
# factor: 1 # the factor of the interval, default: 1
413-
# max: 5 # the max of the alter, default: 1
413+
# max: 5 # the max of the alert, default: 1
414414
#
415415
# # easeprobe program running log file.
416416
# log:

0 commit comments

Comments
 (0)