Skip to content

Commit a489583

Browse files
wu-shengwu-sheng
committed
Merge branch 'fix/documents'
2 parents a862690 + a715220 commit a489583

6 files changed

+73
-89
lines changed

‎docs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
## Documents
2-
[![version](https://img.shields.io/badge/document--version-3.2.5--2017-green.svg)]()
32
[![cn doc](https://img.shields.io/badge/document-中文-blue.svg)](README_ZH.md)
43

54
* Getting Started

‎docs/README_ZH.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
## 中文文档
2-
[![version](https://img.shields.io/badge/document--version-3.2.5--2017-green.svg)]()
32
[![EN doc](https://img.shields.io/badge/document-English-blue.svg)](README.md)
43

54
* [项目简介](/README_ZH.md)

‎docs/cn/Deploy-collector-in-cluster-mode-CN.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,49 +23,58 @@ thread_pool.bulk.queue_size: 1000
2323

2424
### 部署collector
2525
1. 解压安装包`tar -xvf skywalking-collector.tar.gz`，windows用户可以选择zip包
26-
1. 运行`bin/startup.sh`启动。windows用户为.bat文件。
26+
2. 设置Collector集群模式
27+
28+
集群模式主要依赖Zookeeper的注册和应用发现能力。所以，你只需要调整 `config/application.yml`中的host和port配置，使用实际IP和端口，代替默认配置。
29+
其次，将storage的注释取消，并修改为Elasticsearch集群的节点地址信息。
30+
2731

2832
- `config/application.yml`
2933
```
3034
cluster:
31-
# Zookeeper地址配置
35+
# 配置zookeeper集群信息
3236
zookeeper:
3337
hostPort: localhost:2181
3438
sessionTimeout: 100000
35-
# agent_server, agent_stream, ui, collector_inside中配置的IP都是Collector所使用的IP地址
36-
agent_server:
39+
naming:
40+
# 配置探针使用的host和port
3741
jetty:
3842
host: localhost
39-
# The port used
4043
port: 10800
4144
context_path: /
42-
agent_stream:
43-
grpc:
45+
remote:
46+
gRPC:
47+
host: localhost
48+
port: 11800
49+
agent_gRPC:
50+
gRPC:
4451
host: localhost
4552
port: 11800
53+
agent_jetty:
4654
jetty:
4755
host: localhost
4856
port: 12800
4957
context_path: /
58+
agent_stream:
59+
default:
60+
buffer_file_path: ../buffer/
61+
buffer_offset_max_file_size: 10M
62+
buffer_segment_max_file_size: 500M
5063
ui:
5164
jetty:
5265
host: localhost
5366
port: 12800
5467
context_path: /
55-
collector_inside:
56-
grpc:
57-
host: localhost
58-
port: 11800
68+
# 配置 Elasticsearch 集群连接信息
5969
storage:
6070
elasticsearch:
6171
cluster_name: CollectorDBCluster
6272
cluster_transport_sniffer: true
63-
# Elastic Search地址信息
6473
cluster_nodes: localhost:9300
6574
index_shards_number: 2
6675
index_replicas_number: 0
76+
ttl: 7
6777
```
6878

69-
## Collector集群模式启动
70-
集群模式主要依赖Zookeeper的注册和应用发现能力。所以，你只需要调整 `config/application.yml`中，agent_server, agent_stream, ui, collector_inside这些配置项的ip信息，使用真实的IP地址或者hostname，Collector就会使用集群模式运行。
71-
其次，将elasticsearch的注释取消，并修改集群的节点地址信息。
79+
80+
3. 运行`bin/startup.sh`启动。windows用户为.bat文件。

‎docs/cn/Deploy-collector-in-standalone-mode-CN.md

Lines changed: 5 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## 用途说明
2-
单机模式使用本地H2数据库，不支持集群部署。主要用于：预览、功能测试、演示和低压力系统。
1+
# 用途说明
2+
单机模式使用本地H2数据库，不支持集群部署。主要用于：预览、功能测试、演示和低压力系统。你可选择使用Elasticsearch作为
33

44
## 所需的第三方软件
55
- JDK8+
@@ -10,55 +10,12 @@
1010
## Quick Start
1111
Collector单机模拟启动简单，提供和集群模式相同的功能，单机模式下除端口被占用的情况下，直接启动即可。
1212

13-
### 部署collector
13+
## 部署collector
1414
1. 解压安装包`tar -xvf skywalking-collector.tar.gz`，windows用户可以选择zip包
1515
1. 运行`bin/startup.sh`启动。windows用户为.bat文件。
1616

17-
- `config/application.yml`
18-
```
19-
# 单机模式下无需配置集群相关信息
20-
#cluster:
21-
# zookeeper:
22-
# hostPort: localhost:2181
23-
# sessionTimeout: 100000
24-
# agent_server, agent_stream, ui, collector_inside中配置的IP都是Collector所使用的IP地址
25-
agent_server:
26-
jetty:
27-
host: localhost
28-
# The port used
29-
port: 10800
30-
context_path: /
31-
agent_stream:
32-
grpc:
33-
host: localhost
34-
port: 11800
35-
jetty:
36-
host: localhost
37-
port: 12800
38-
context_path: /
39-
ui:
40-
jetty:
41-
host: localhost
42-
port: 12800
43-
context_path: /
44-
collector_inside:
45-
grpc:
46-
host: localhost
47-
port: 11800
48-
49-
#storage:
50-
# elasticsearch:
51-
# cluster_name: CollectorDBCluster
52-
# cluster_transport_sniffer: true
53-
# Elastic Search地址信息
54-
# cluster_nodes: localhost:9300
55-
# index_shards_number: 2
56-
# index_replicas_number: 0
57-
```
58-
5917
## 使用Elastic Search代替H2存储
60-
由于H2数据库性能的局限性，我们在单机模式下，也支持使用ElasticSearch 5.3作为存储。你需要安装对应的ElasticSearch 5.3，并取消
61-
- 在单机模式下除了支持内置的H2数据库运行，也支持其他的存储（当前已支持的ElasticSearch 5.3），安装storage注释，修改配置信息即可。取消Storage相关配置节的注释。
18+
- 在单机模式下除了支持内置的H2数据库运行，也支持其他的存储（当前已支持的ElasticSearch 5.3），取消Storage相关配置节的注释，并修改配置。
6219
```yaml
6320
#storage:
6421
# elasticsearch:
@@ -69,7 +26,7 @@ collector_inside:
6926
# index_replicas_number: 0
7027
```
7128

72-
### 部署Elasticsearch
29+
## 部署Elasticsearch
7330
- 修改`elasticsearch.yml`文件
7431
- 设置 `cluster.name: CollectorDBCluster`。此名称需要和collector配置文件一致。
7532
- 设置 `node.name: anyname`, 可以设置为任意名字，如Elasticsearch为集群模式，则每个节点名称需要不同。

‎docs/en/Deploy-collector-in-cluster-mode.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- Set `cluster.name: CollectorDBCluster`
1313
- Set `node.name: anyname`, this name can be any, it based on Elasticsearch.
1414
- Add the following configurations to
15-
15+
1616
```
1717
# The ip used for listening
1818
network.host: 0.0.0.0
@@ -21,53 +21,58 @@ thread_pool.bulk.queue_size: 1000
2121

2222
- Start Elasticsearch
2323

24-
## Single Node Mode Collector
25-
Single Node collector is easy to deploy, and provides same features as cluster mode. You can use almost all default config to run in this mode. And attention, all the default configs of single node mode, depend on running the collector, traced application, ElasticSearch and Zookeeper in the same machine.
26-
2724
### Deploy collector servers
2825
1. Run `tar -xvf skywalking-collector.tar.gz`
29-
1. Run `bin/startup.sh`
26+
2. Config collector in cluster mode.
27+
28+
Cluster mode depends on Zookeeper register and application discovery capabilities. So, you just need to adjust the IP config items in `config/application.yml`. Change IP and port configs of agent_server, agent_stream, ui, collector_inside, replace them to the real ip or hostname which you want to use for cluster.
3029

3130
- `config/application.yml`
3231
```
3332
cluster:
34-
# The address of Zookeeper
33+
# The Zookeeper cluster for collector cluster management.
3534
zookeeper:
3635
hostPort: localhost:2181
3736
sessionTimeout: 100000
38-
# IPs in agent_server, agent_stream, ui, collector_inside are addresses of Collector
39-
agent_server:
37+
naming:
38+
# Host and port used for agent config
4039
jetty:
4140
host: localhost
42-
# The port used
4341
port: 10800
4442
context_path: /
45-
agent_stream:
46-
grpc:
43+
remote:
44+
gRPC:
45+
host: localhost
46+
port: 11800
47+
agent_gRPC:
48+
gRPC:
4749
host: localhost
4850
port: 11800
51+
agent_jetty:
4952
jetty:
5053
host: localhost
5154
port: 12800
5255
context_path: /
56+
agent_stream:
57+
default:
58+
buffer_file_path: ../buffer/
59+
buffer_offset_max_file_size: 10M
60+
buffer_segment_max_file_size: 500M
5361
ui:
5462
jetty:
5563
host: localhost
5664
port: 12800
5765
context_path: /
58-
collector_inside:
59-
grpc:
60-
host: localhost
61-
port: 11800
66+
# Config Elasticsearch cluster connection info.
6267
storage:
6368
elasticsearch:
6469
cluster_name: CollectorDBCluster
6570
cluster_transport_sniffer: true
66-
# The address of Elastic Search
6771
cluster_nodes: localhost:9300
6872
index_shards_number: 2
6973
index_replicas_number: 0
74+
ttl: 7
7075
```
7176

72-
## Cluster Mode Collector
73-
Cluster mode depends on Zookeeper register and application discovery capabilities. So, you just need to adjust the IP config items in `config/application.yml`. Change IP and port configs of agent_server, agent_stream, ui, collector_inside, replace them to the real ip or hostname which you want to use for cluster.
77+
78+
3. Run `bin/startup.sh`

‎docs/en/Deploy-collector-in-standalone-mode.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,35 @@
11
# Usage scenario
2-
Standalong mode collector means don't support cluster. It uses H2 as storage layer implementation, suggest that use only for preview, test, demonstration, low throughputs and small scale system.
2+
Default standalong mode collector means don't support cluster. It uses H2 as storage layer implementation, suggest that use only for preview, test, demonstration, low throughputs and small scale system.
33

4-
# Requirements
4+
If you are using skywalking in a low throughputs monitoring scenario, and don't want to deploy cluster, at least, swith the storage implementation from H2 to Elasticsearch.
5+
6+
## Requirements
57
* JDK 8+
68

7-
# Download
9+
## Download
810
* [Releases](https://github.com/OpenSkywalking/skywalking/releases)
911

10-
# Quick start
12+
## Quick start
1113
You can simplely tar/unzip and startup if ports 10800, 11800, 12800 are free.
1214

1315
- `tar -xvf skywalking-collector.tar.gz` in Linux, or unzip in windows.
1416
- run `bin/startup.sh` or `bin/startup.bat`
1517

1618
You should keep the `config/application.yml` as default.
1719

18-
# Use Elastic Search instead of H2 as storage layer implementation
19-
Even in standalone mode, collector can run with Elastic Search as storage. If so, uncomment the `storage` section in `application.yml`, set the config right.
20+
## Use Elastic Search instead of H2 as storage layer implementation
21+
Even in standalone mode, collector can run with Elastic Search as storage. If so, uncomment the `storage` section in `application.yml`, set the config right. The default configs fit for collector and Elasticsearch both running in same machine, and not cluster.
22+
23+
## Deploy Elasticsearch server
24+
- Modify `elasticsearch.yml`
25+
- Set `cluster.name: CollectorDBCluster`
26+
- Set `node.name: anyname`, this name can be any, it based on Elasticsearch.
27+
- Add the following configurations to
28+
29+
```
30+
# The ip used for listening
31+
network.host: 0.0.0.0
32+
thread_pool.bulk.queue_size: 1000
33+
```
2034

35+
- Start Elasticsearch

0 commit comments

Comments
 (0)