Skip to content

Commit 0ab10ab

Browse files
authored
Refine backend doc (#7595)
1 parent b4aa79a commit 0ab10ab

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/en/setup/backend/ttl.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# TTL
2-
In SkyWalking, there are two types of observability data, besides metadata.
3-
1. Record, including trace and alarm. Maybe log in the future.
4-
1. Metric, including such as percentile, heat map, success rate, cpm(rpm) etc.
2+
In SkyWalking, besides metadata, there are two types of observability data:
3+
1. Record: Includes trace and alarm. Log may also be included in the future.
4+
1. Metric: Includes percentile, heat map, success rate, cpm (rpm), etc.
55

6-
You have following settings for different types.
6+
These are the settings for the different types:
77
```yaml
88
# Set a timeout on metrics data. After the timeout has expired, the metrics data will automatically be deleted.
99
recordDataTTL: ${SW_CORE_RECORD_DATA_TTL:3} # Unit is day
1010
metricsDataTTL: ${SW_CORE_METRICS_DATA_TTL:7} # Unit is day
1111
```
1212
13-
- `recordDataTTL` affects **Record** data, including tracing and alarm.
14-
- `metricsDataTTL` affects all metrics, including service, instance, endpoint metrics and topology map metrics.
13+
- `recordDataTTL` applies to **record** data, including tracing and alarm.
14+
- `metricsDataTTL` applies to all metrics, including the metrics for service, instance, endpoint, and topology map.

docs/en/setup/backend/ui-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ SkyWalking UI distribution is already included in our Apache official release.
55
Startup script is also in `/bin/webappService.sh`(.bat). UI runs as an OS Java process, powered-by Zuul.
66

77
## Settings
8-
Setting file of UI is `webapp/webapp.yml` in distribution package. It is constituted by three parts.
8+
Settings file of UI is `webapp/webapp.yml` in distribution package. It has three parts.
99

1010
1. Listening port.
1111
1. Backend connect info.

docs/en/setup/backend/uninstrumented-gateways.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
The uninstrumented gateways are not instrumented by SkyWalking agent plugin when they are started,
44
but they can be configured in `gateways.yml` file or via [Dynamic Configuration](dynamic-config.md). The reason why they can't register
5-
to backend automatically is that there're no suitable agent plugins, for example, there is no agent plugins for Nginx, haproxy, etc.
5+
to backend automatically is that there're no suitable agent plugins. For example, there are no agent plugins for Nginx, haproxy, etc.
66
So in order to visualize the real topology, we provide a way to configure the gateways/proxies manually.
77

88
## Configuration Format
99

10-
The configuration content includes the gateways' names and their instances:
10+
The configuration content includes gateway names and their instances:
1111

1212
```yml
1313
gateways:
@@ -17,6 +17,6 @@ gateways:
1717
port: 9099 # the port of this gateway instance, defaults to 80
1818
```
1919
20-
**Note** that the `host` of the instance must be the one that is actually used in client side, for example,
21-
if the instance `proxyA` has 2 IPs, say `192.168.1.110` and `192.168.1.111`, both of which delegates the target service,
20+
**Note**: The `host` of the instance must be the one that is actually used at client side. For example,
21+
if instance `proxyA` has 2 IPs, say `192.168.1.110` and `192.168.1.111`, both of which delegate the target service,
2222
and the client connects to `192.168.1.110`, then configuring `192.168.1.111` as the `host` won't work properly.

0 commit comments

Comments
 (0)