diff --git a/BUILD_DOC.md b/BUILD_DOC.md index 75132462464ac33f574b26a8aab7abf0e97ee839..05f9fb001f8e8737971669aa2c1c9f5293e9a6ea 100644 --- a/BUILD_DOC.md +++ b/BUILD_DOC.md @@ -1,27 +1,33 @@ -### 部署第三方软件 +### 部署第三方软件 / Required of third party softwares - JDK 1.7 -- 安装zookeeper 3.4.6 -- 安装apache hbase 1.1.2 -- 安装mysql -- 安装tomcat 7 +- zookeeper 3.4.6 +- apache hbase 1.1.2 +- mysql +- tomcat 7 - redis-3.0.5 -### 编译安装SkyWalking Server +### 编译安装SkyWalking Server / Build SkyWalking Server - 编译工程 +- build ```shell $cd github/sky-walking/skywalking-server $mvn package -Dmaven.test.skip=true $cd github/sky-walking/skywalking-server/target/installer ``` - 拷贝installer到服务器 +- upload installer to server - 根据服务器环境修改/config/config.properties +- config '/config/config.properties' ```properties #服务器收集数据监听端口 +#server listening port of collecting data server.port=34000 #数据缓存文件目录，请确保此目录有一定的存储容量 +#directory of cache data files. buffer.data_buffer_file_parent_directory=D:/test-data/data/buffer #偏移量注册文件的目录，这里为系统绝对路径 +#directory of offset data file registerpersistence.register_file_parent_directory=d:/test-data/data/offset #hbase zk quorum，hbase的zk地址 @@ -30,25 +36,31 @@ hbaseconfig.zk_hostname=10.1.235.197,10.1.235.198,10.1.235.199 hbaseconfig.client_port=29181 #告警数据暂存的Redis配置 +#redis ip,port to save alarm data alarm.redis_server=10.1.241.18:16379 ``` - 启动服务 +- start server ```shell $cd installer/bin $./swserver.sh ``` - 可根据需要部署多个实例 +- Multiple instances can be deployed， according to the needs of processing capacity. - 启动服务前，请注意hbase的客户端使用机器名而非ip连接主机，请在server所在机器上正确配置hosts文件，否则会造成数据无法入库 -### 编译安装SkyWalking Alarm +### 编译安装SkyWalking Alarm / Build SkyWalking Alarm - 编译工程 +- build ```shell $cd github/sky-walking/skywalking-alarm $mvn package -Dmaven.test.skip=true $cd github/sky-walking/skywalking-alarm/target/installer ``` - 拷贝installer到服务器 +- upload installer to server - 根据服务器环境修改/config/config.properties +- config '/config/config.properties' ```properties #zookeeper连接地址,用于协调集群，可以和hbase的zookeeper共用 zkpath.connect_str=10.1.241.18:29181,10.1.241.19:29181,10.1.241.20:29181 @@ -65,20 +77,24 @@ db.password=sw_dbusr01 alarm.redis_server=127.0.0.1:6379 ``` - 启动服务 +- start server ```shell $cd installer/bin $./sw-alarm-server.sh ``` - 可根据需要部署多个实例，根据实例启动数量，自动负载均衡 +- Multiple instances can be deployed， according to the needs of processing capacity. Multiple instances will load balance automatically. -### 编译安装SkyWalking WebUI +### 编译安装SkyWalking WebUI / Build SkyWalking WebUI - 修改配置文件config.properties +- config 'config.properties' ```properties #hbase的连接地址 hbaseconfig.quorum=10.1.235.197,10.1.235.198,10.1.235.199 hbaseconfig.client_port=29181 ``` - 修改配置文件jdbc.properties +- config 'jdbc.properties' ```properties #管理数据库的JDBC连接信息 jdbc.url=jdbc:mysql://10.1.228.202:31316/test @@ -86,29 +102,36 @@ jdbc.username=devrdbusr21 jdbc.password=devrdbusr21 ``` - 编译工程 +- build ```shell $cd github/sky-walking/skywalking-webui $mvn package ``` -- 初始化管理数据库 -根据[数据库脚本](https://github.com/wu-sheng/sky-walking/blob/master/skywalking-webui/src/main/sql/table.mysql)初始化管理数据库。其中，脚本中如下SQL片段需要修改： +- 初始化管理数据库，根据[数据库脚本](https://github.com/wu-sheng/sky-walking/blob/master/skywalking-webui/src/main/sql/table.mysql)初始化管理数据库。其中，脚本中如下SQL片段需要修改 +- initialize database using [database-script](https://github.com/wu-sheng/sky-walking/blob/master/skywalking-webui/src/main/sql/table.mysql) ```sql --配置告警邮件的发送人和SMTP信息 +--set sender and smtp of alarm e-mail INSERT INTO `system_config` (`config_id`,`conf_key`,`conf_value`,`val_type`,`val_desc`,`create_time`,`sts`,`modify_time`) VALUES (1000,'mail_info','{\"mail.host\":\"mail.asiainfo.com\",\"mail.transport.protocol\":\"smtp\",\"mail.smtp.auth\":\"true\",\"mail.smtp.starttls.enable\":\"false\",\"mail.username\":\"testA\",\"mail.password\":\"******\",\"mail.account.prefix\":\"@asiainfo.com\"}','json','默认邮件发送人信息','2015-12-10 11:54:06','A','2015-12-10 11:54:06'); --配置部署页面地址，用于告警邮件内的链接 +--set webui addr of internet INSERT INTO `system_config` (`config_id`,`conf_key`,`conf_value`,`val_type`,`val_desc`,`create_time`,`sts`,`modify_time`) VALUES (1001,'portal_addr','http://10.1.235.197:48080/skywalking/','string','默认门户地址','2015-12-10 15:23:53','A','2015-12-10 15:23:53'); --配置SkyWalking Server的集群地址（内网地址） +--set LAN addrs of server cluster INSERT INTO `system_config` (`config_id`,`conf_key`,`conf_value`,`val_type`,`val_desc`,`create_time`,`sts`,`modify_time`) VALUES (1002,'servers_addr','10.1.235.197:34000;10.1.235.197:35000;','string','日志采集地址','2015-12-10 15:23:53','A','2015-12-10 15:23:53'); --配置SkyWalking Server的集群地址（外网地址） +--set internet addrs of server cluster INSERT INTO `system_config` (`config_id`,`conf_key`,`conf_value`,`val_type`,`val_desc`,`create_time`,`sts`,`modify_time`) VALUES (1003,'servers_addr_1','60.194.3.183:34000;60.194.3.183:35000;60.194.3.184:34000;60.194.3.184:35000;','string','日志采集地址-外网','2015-12-10 15:23:53','A','2015-12-10 15:23:53'); ``` - 上传war包到服务器，启动Tomcat服务器 +- startup tomcat of webui -### 编译安装SkyWalking Analysis -暂未提供 +### 编译安装SkyWalking Analysis / Build SkyWalking Analysis +- 暂未提供 +- next version -## 使用maven发布各插件工程 -- 发布skywalking-sdk-plugin下的各子工程(dubbo-plugin，spring-plugin，web-plugin，jdbc-plugin，httpclient-4.2.x-plugin，httpclient-4.3.x-plugin) +## 使用maven发布各插件工程 / build and deploy plugins +- build and deploy skywalking-sdk-plugin(dubbo-plugin，spring-plugin，web-plugin，jdbc-plugin，httpclient-4.2.x-plugin，httpclient-4.3.x-plugin, etc.) - 请跳过maven.test环节，避免打包失败 ```properties -Dmaven.test.skip=true diff --git a/README.md b/README.md index 75f41eb45842d290a05e530458577f9f1387a00c..a713e636f81cc57e0c064f1a814ce7e051cae397 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ SkyWalking: Large-Scale Distributed Systems Tracing Infrastructure, 是一个对 # Quick Start ## 编译与部署 / Build and deploy - 参考《[代码编译部署说明](BUILD_DOC.md)》 +- [Code compilation and deployment instructions](BUILD_DOC.md) ## 引入核心SDK / Import SDK - 无论试用哪种插件，都必须引入