diff --git a/README.md b/README.md index 3bd4635ca..6ad2ad2b3 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,132 @@ http://wu-sheng.github.io/sky-walking/sample-code/codeView.html # Contact Us Mail: wu.sheng@foxmail.com + +# Quick Start +## 编译与部署 +### 部署第三方软件 +- 安装zookeeper 3.4.6 +- 安装apache hbase 1.1.2 +- 安装mysql +- 安装tomcat 7 + +### 编译安装SkyWalking Server +- 编译工程 +```shell +$cd github/sky-walking/skywalking-server +$mvn package -Dmaven.test.skip=true +$cd github/sky-walking/skywalking-server/target/installer +``` +- 拷贝installer到服务器 +- 根据服务器环境修改/config/config.properties +```properties +#服务器收集数据监听端口 +server.port=34000 + +#数据缓存文件目录,请确保此目录有一定的存储容量 +buffer.data_buffer_file_parent_directory=D:/test-data/data/buffer +#偏移量注册文件的目录 +registerpersistence.register_file_parent_directory=d:/test-data/data/offset + +#hbase zk quorum +hbaseconfig.zk_hostname=10.1.235.197,10.1.235.198,10.1.235.199 +#hbase zk port +hbaseconfig.client_port=29181 + +#Redis配置 +alarm.redis_server=10.1.241.18:16379 +``` +- 启动服务 +```shell +$cd installer/bin +$./swserver.sh +``` +- 可根据需要部署多个实例 + +### 编译安装SkyWalking Alarm +- 编译工程 +```shell +$cd github/sky-walking/skywalking-alarm +$mvn package -Dmaven.test.skip=true +$cd github/sky-walking/skywalking-alarm/target/installer +``` +- 拷贝installer到服务器 +- 根据服务器环境修改/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 + +#管理数据库的JDBC连接信息 +#数据库连接地址 +db.url=jdbc:mysql://10.1.241.20:31306/sw_db +#数据库用户名 +db.user_name=sw_dbusr01 +#数据库密码 +db.password=sw_dbusr01 + +#告警信息存在的redis服务器地址,需要和skywalking-server的alarm.redis_server设置一致 +alarm.redis_server=127.0.0.1:6379 +``` +- 启动服务 +```shell +$cd installer/bin +$./sw-alarm-server.sh +``` +- 可根据需要部署多个实例,根据实例启动数量,自动负载均衡 + +### 编译安装SkyWalking WebUI + + +### 编译安装SkyWalking Analysis +暂未提供 + +## 根据所需的监控点,引入maven依赖 +暂不存在公网仓库,需要本地编译并发布 +```xml + + + com.ai.cloud + skywalking-api + 1.0-SNAPSHOT + + + + com.ai.cloud + skywalking-spring-plugin + 1.0-SNAPSHOT + + + + com.ai.cloud + skywalking-dubbo-plugin + 1.0-SNAPSHOT + + + + com.ai.cloud + skywalking-jdbc-plugin + 1.0-SNAPSHOT + + + + com.ai.cloud + skywalking-httpClient-4.2.x-plugin + 1.0-SNAPSHOT + + + + com.ai.cloud + skywalking-httpClient-4.3.x-plugin + 1.0-SNAPSHOT + +``` +查询不会引用所需的第三方组件(如Spring、dubbo、dubbox等),请自行引入所需的版本。 + +## 根据所需插件配置应用程序 +参考[用户指南](http://wu-sheng.github.io/sky-walking/sample-code/codeView.html) + +## 下载并设置授权文件 +通过skywalking-webui工程下载授权文件,并在运行时环境中,将授权文件加入到CLASSPATH中 + +## 在运行时环境中设置环境变量 +export SKYWALKING_RUN=true diff --git a/skywalking-webui/pom.xml b/skywalking-webui/pom.xml index 13bbb9d1d..4b084132e 100644 --- a/skywalking-webui/pom.xml +++ b/skywalking-webui/pom.xml @@ -115,9 +115,9 @@ 1.8.7 - com.ai.cloud - skywalking-alarm - 1.0-SNAPSHOT - + com.google.code.gson + gson + 2.2.2 + \ No newline at end of file