From 21c58f07d52770faf0f404128f7b6915dd2eaee6 Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 3 Mar 2018 22:36:15 +0800 Subject: [PATCH 1/5] Update some documents for 5.0.0-alpha release. --- apm-sniffer/config/agent.config | 2 +- docs/en/Deploy-collector-in-cluster-mode.md | 3 ++- docs/en/Deploy-collector-in-standalone-mode.md | 6 ++++-- docs/en/Deploy-skywalking-agent.md | 2 +- docs/en/Quick-start.md | 5 +++-- 5 files changed, 11 insertions(+), 7 deletions(-) diff --git a/apm-sniffer/config/agent.config b/apm-sniffer/config/agent.config index 8616a4b04..4600bbc92 100644 --- a/apm-sniffer/config/agent.config +++ b/apm-sniffer/config/agent.config @@ -17,7 +17,7 @@ agent.application_code=Your_ApplicationName # agent.is_open_debugging_class = true # Server addresses. -# Mapping to `agent_server/jetty/port` in `config/application.yml` of Collector. +# Mapping to `naming/jetty/ip:port` in `config/application.yml` of Collector. # Examples： # Single collector：SERVERS="127.0.0.1:8080" # Collector cluster：SERVERS="10.2.45.126:8080,10.2.45.127:7600" diff --git a/docs/en/Deploy-collector-in-cluster-mode.md b/docs/en/Deploy-collector-in-cluster-mode.md index 2cc58795e..a9fec046f 100644 --- a/docs/en/Deploy-collector-in-cluster-mode.md +++ b/docs/en/Deploy-collector-in-cluster-mode.md @@ -25,7 +25,8 @@ thread_pool.bulk.queue_size: 1000 1. Run `tar -xvf skywalking-collector.tar.gz` 2. Config collector in cluster mode. -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. +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 naming, remote, agent_gRPC, agent_jetty and ui, +replace them to the real ip or hostname which you want to use for cluster. - `config/application.yml` ``` diff --git a/docs/en/Deploy-collector-in-standalone-mode.md b/docs/en/Deploy-collector-in-standalone-mode.md index 7e3292d00..3697fe1f1 100644 --- a/docs/en/Deploy-collector-in-standalone-mode.md +++ b/docs/en/Deploy-collector-in-standalone-mode.md @@ -1,7 +1,9 @@ # Usage scenario 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. -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. +If you are using skywalking in a low throughputs monitoring scenario, and don't want to deploy cluster, at least, switch the storage implementation from H2 to Elasticsearch. + +**H2 storage implementation is not provided in 5.0.0-alpha** ## Requirements * JDK 8+ @@ -24,7 +26,7 @@ Even in standalone mode, collector can run with Elastic Search as storage. If so - Modify `elasticsearch.yml` - Set `cluster.name: CollectorDBCluster` - Set `node.name: anyname`, this name can be any, it based on Elasticsearch. - - Add the following configurations to + - Add the following configurations ``` # The ip used for listening diff --git a/docs/en/Deploy-skywalking-agent.md b/docs/en/Deploy-skywalking-agent.md index c42ee3b51..900c39f9c 100644 --- a/docs/en/Deploy-skywalking-agent.md +++ b/docs/en/Deploy-skywalking-agent.md @@ -42,5 +42,5 @@ CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/skywalking-agent/skywalking-ag - Tomcat 8 Change the first line of `tomcat/bin/catalina.sh`. ```shell -set "CATALINA_OPTS=-javaagent:E:\apache-tomcat-8.5.20\skywalking-agent\skywalking-agent.jar -Dconfig=\skywalking\config\dir" +set "CATALINA_OPTS=-javaagent:E:\apache-tomcat-8.5.20\skywalking-agent\skywalking-agent.jar" ``` \ No newline at end of file diff --git a/docs/en/Quick-start.md b/docs/en/Quick-start.md index 9e604336d..64b8eacfc 100644 --- a/docs/en/Quick-start.md +++ b/docs/en/Quick-start.md @@ -1,7 +1,8 @@ # Quick start +1. Download `org.apache.skywalking.apm-dist` in maven central. Or find `skywalking-dist.tar.gz/.zip` in `dist` folder after `mvn clean package`. 1. Deploy Collector 1. [Standalone Mode](Deploy-collector-in-standalone-mode.md) 1. [Cluster Mode](Deploy-collector-in-cluster-mode.md) -1. Deploy webui server, [doc](https://github.com/apache/incubator-skywalking-ui#quickstart) -1. Doploy Java Agent，[doc](Deploy-skywalking-agent.md) +1. Deploy webui server [WIP] +1. Deploy Java Agent，[doc](Deploy-skywalking-agent.md) 1. Reboot your applications, and open UI. \ No newline at end of file From 00a9cde2821a39bacdbb2e8d33ee6ab42d06637d Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 3 Mar 2018 22:47:25 +0800 Subject: [PATCH 2/5] Add UI startup.sh description. --- docs/en/Deploy-collector-in-cluster-mode.md | 2 ++ docs/en/Deploy-collector-in-standalone-mode.md | 4 +++- docs/en/Quick-start.md | 7 +++---- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/en/Deploy-collector-in-cluster-mode.md b/docs/en/Deploy-collector-in-cluster-mode.md index a9fec046f..c6fa1ffd9 100644 --- a/docs/en/Deploy-collector-in-cluster-mode.md +++ b/docs/en/Deploy-collector-in-cluster-mode.md @@ -77,3 +77,5 @@ storage: 3. Run `bin/startup.sh` + +- NOTICE: **In 5.0.0-alpha, startup.sh will start two processes, collector and UI, and UI uses 127.0.0.1:10800 as default.** diff --git a/docs/en/Deploy-collector-in-standalone-mode.md b/docs/en/Deploy-collector-in-standalone-mode.md index 3697fe1f1..56b1cdaf4 100644 --- a/docs/en/Deploy-collector-in-standalone-mode.md +++ b/docs/en/Deploy-collector-in-standalone-mode.md @@ -3,7 +3,7 @@ Default standalong mode collector means don't support cluster. It uses H2 as sto If you are using skywalking in a low throughputs monitoring scenario, and don't want to deploy cluster, at least, switch the storage implementation from H2 to Elasticsearch. -**H2 storage implementation is not provided in 5.0.0-alpha** +**H2 storage implementation is not provided in 5.0.0-alpha, so you must deploy ElasticSearch before try to start backend** ## Requirements * JDK 8+ @@ -19,6 +19,8 @@ You can simplely tar/unzip and startup if ports 10800, 11800, 12800 are free. You should keep the `config/application.yml` as default. +- NOTICE: **In 5.0.0-alpha, startup.sh will start two processes, collector and UI, and UI uses 127.0.0.1:10800 as default.** + ## Use Elastic Search instead of H2 as storage layer implementation 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. diff --git a/docs/en/Quick-start.md b/docs/en/Quick-start.md index 64b8eacfc..cdc15d93a 100644 --- a/docs/en/Quick-start.md +++ b/docs/en/Quick-start.md @@ -1,8 +1,7 @@ # Quick start 1. Download `org.apache.skywalking.apm-dist` in maven central. Or find `skywalking-dist.tar.gz/.zip` in `dist` folder after `mvn clean package`. -1. Deploy Collector - 1. [Standalone Mode](Deploy-collector-in-standalone-mode.md) - 1. [Cluster Mode](Deploy-collector-in-cluster-mode.md) -1. Deploy webui server [WIP] +1. Deploy Backend + - [Standalone Mode](Deploy-collector-in-standalone-mode.md) + - [Cluster Mode](Deploy-collector-in-cluster-mode.md) 1. Deploy Java Agent，[doc](Deploy-skywalking-agent.md) 1. Reboot your applications, and open UI. \ No newline at end of file From 293fd9a1cd1396d1368845f6602b3a9376bc1483 Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 3 Mar 2018 22:55:35 +0800 Subject: [PATCH 3/5] Sync Chinese doc --- docs/cn/Deploy-collector-in-cluster-mode-CN.md | 3 +++ docs/cn/Deploy-collector-in-standalone-mode-CN.md | 8 +++++++- docs/cn/Quick-start-CN.md | 4 ++-- docs/en/Deploy-collector-in-cluster-mode.md | 3 ++- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/cn/Deploy-collector-in-cluster-mode-CN.md b/docs/cn/Deploy-collector-in-cluster-mode-CN.md index e73f3fd96..b892eac8c 100644 --- a/docs/cn/Deploy-collector-in-cluster-mode-CN.md +++ b/docs/cn/Deploy-collector-in-cluster-mode-CN.md @@ -78,3 +78,6 @@ storage: 3. 运行`bin/startup.sh`启动。windows用户为.bat文件。 + +- **注意：startup.sh将会启动collector和UI两个进程，UI通过127.0.0.1:10800访问本地collector，无需额外配置。 +如需保证UI负载均衡，推荐使用类nginx的HTTP代理服务。** \ No newline at end of file diff --git a/docs/cn/Deploy-collector-in-standalone-mode-CN.md b/docs/cn/Deploy-collector-in-standalone-mode-CN.md index 86351b574..fb0166d80 100644 --- a/docs/cn/Deploy-collector-in-standalone-mode-CN.md +++ b/docs/cn/Deploy-collector-in-standalone-mode-CN.md @@ -1,5 +1,9 @@ # 用途说明 -单机模式默认使用本地H2数据库，不支持集群部署。主要用于：预览、功能测试、演示和低压力系统。如果使用单机collector用于非演示环境，你可选择使用Elasticsearch作为存储实现。 +单机模式默认使用本地H2数据库，不支持集群部署。主要用于：预览、功能测试、演示和低压力系统。 + +如果使用单机collector用于非演示环境，你可选择使用Elasticsearch作为存储实现。 + +**在5.0.0-alpha版本中，暂不提供H2实现** ## 所需的第三方软件 - JDK8+ @@ -14,6 +18,8 @@ Collector单机模拟启动简单，提供和集群模式相同的功能，单 1. 解压安装包`tar -xvf skywalking-collector.tar.gz`，windows用户可以选择zip包 1. 运行`bin/startup.sh`启动。windows用户为.bat文件。 +- **注意：startup.sh将会启动collector和UI两个进程，UI通过127.0.0.1:10800访问本地collector，无需额外配置。** + ## 使用Elastic Search代替H2存储 - 在单机模式下除了支持内置的H2数据库运行，也支持其他的存储（当前已支持的ElasticSearch 5.3），取消Storage相关配置节的注释，并修改配置。 ```yaml diff --git a/docs/cn/Quick-start-CN.md b/docs/cn/Quick-start-CN.md index 21c2b6799..9567bf38d 100644 --- a/docs/cn/Quick-start-CN.md +++ b/docs/cn/Quick-start-CN.md @@ -1,7 +1,7 @@ # 部署步骤 -1. 部署 Collector +1. 在Maven Central中下载 `org.apache.skywalking.apm-dist`. 或者本地编译程序，在`dist`目录中找到`skywalking-dist.tar.gz/.zip`. +1. 部署 Backend 1. [单机模式](Deploy-collector-in-standalone-mode-CN.md) 1. [集群模式](Deploy-collector-in-cluster-mode-CN.md) -1. 部署 webui server, [doc](https://github.com/apache/incubator-skywalking-ui#quickstart) 1. 部署 Java Agent，[doc](Deploy-skywalking-agent-CN.md) 1. 重启并访问系统功能，查看UI即可。 \ No newline at end of file diff --git a/docs/en/Deploy-collector-in-cluster-mode.md b/docs/en/Deploy-collector-in-cluster-mode.md index c6fa1ffd9..29025b9b3 100644 --- a/docs/en/Deploy-collector-in-cluster-mode.md +++ b/docs/en/Deploy-collector-in-cluster-mode.md @@ -78,4 +78,5 @@ storage: 3. Run `bin/startup.sh` -- NOTICE: **In 5.0.0-alpha, startup.sh will start two processes, collector and UI, and UI uses 127.0.0.1:10800 as default.** +- NOTICE: **In 5.0.0-alpha, startup.sh will start two processes, collector and UI, and UI uses 127.0.0.1:10800 as default. +Recommend use http proxy to access UI in product, otherwise, access any UI.** From 5765b1e4ff63a041d5f82a955a00dc5813008f43 Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 3 Mar 2018 22:59:52 +0800 Subject: [PATCH 4/5] Remove all bintray related. --- apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml | 9 --------- apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml | 8 -------- apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml | 9 --------- apm-application-toolkit/apm-toolkit-opentracing/pom.xml | 9 +-------- apm-application-toolkit/apm-toolkit-trace/pom.xml | 9 --------- docs/README_ZH.md | 2 +- .../{skywalking-opentracing-CN.md => Opentracing-CN.md} | 2 -- docs/en/Opentracing.md | 1 - 8 files changed, 2 insertions(+), 47 deletions(-) rename docs/cn/{skywalking-opentracing-CN.md => Opentracing-CN.md} (65%) diff --git a/apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml b/apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml index c019fe1a5..5d536b510 100644 --- a/apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml +++ b/apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml @@ -59,13 +59,4 @@ - - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - https://api.bintray.com/maven/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-log4j-1.x/;publish=1 - - - diff --git a/apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml b/apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml index a85dff077..02087118a 100644 --- a/apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml +++ b/apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml @@ -60,12 +60,4 @@ - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - https://api.bintray.com/maven/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-log4j-2.x/;publish=1 - - - diff --git a/apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml b/apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml index c0ec486fb..caa88a3ce 100644 --- a/apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml +++ b/apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml @@ -59,13 +59,4 @@ - - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - https://api.bintray.com/maven/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-logback-1.x/;publish=1 - - - diff --git a/apm-application-toolkit/apm-toolkit-opentracing/pom.xml b/apm-application-toolkit/apm-toolkit-opentracing/pom.xml index b05e70ca0..dee31cb5e 100644 --- a/apm-application-toolkit/apm-toolkit-opentracing/pom.xml +++ b/apm-application-toolkit/apm-toolkit-opentracing/pom.xml @@ -42,12 +42,5 @@ - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - https://api.bintray.com/maven/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-opentracing/;publish=1 - - - + diff --git a/apm-application-toolkit/apm-toolkit-trace/pom.xml b/apm-application-toolkit/apm-toolkit-trace/pom.xml index 394ccb2a3..fbee8e8e2 100644 --- a/apm-application-toolkit/apm-toolkit-trace/pom.xml +++ b/apm-application-toolkit/apm-toolkit-trace/pom.xml @@ -52,13 +52,4 @@ - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - - https://api.bintray.com/maven/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-trace/;publish=1 - - - diff --git a/docs/README_ZH.md b/docs/README_ZH.md index db6bbb2db..ea7fed228 100644 --- a/docs/README_ZH.md +++ b/docs/README_ZH.md @@ -10,7 +10,7 @@ * [OpenTracing中文版](https://github.com/opentracing-contrib/opentracing-specification-zh) * Application Toolkit，应用程序工具包 * [概述](cn/Application-toolkit-CN.md) - * [OpenTracing Tracer](cn/skywalking-opentracing-CN.md) + * [OpenTracing Tracer](cn/Opentracing-CN.md) * 日志组件 * [log4j组件](cn/Application-toolkit-log4j-1.x-CN.md) * [log4j2组件](cn/Application-toolkit-log4j-2.x-CN.md) diff --git a/docs/cn/skywalking-opentracing-CN.md b/docs/cn/Opentracing-CN.md similarity index 65% rename from docs/cn/skywalking-opentracing-CN.md rename to docs/cn/Opentracing-CN.md index 588641915..3bb3d2a37 100644 --- a/docs/cn/skywalking-opentracing-CN.md +++ b/docs/cn/Opentracing-CN.md @@ -7,8 +7,6 @@ ``` -   [ ![Download](https://api.bintray.com/packages/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-opentracing/images/download.svg) ](https://bintray.com/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-opentracing/_latestVersion) - * 使用OpenTracing的标准API和桥接器，使用手动埋点 ```java Tracer tracer = new org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer(); diff --git a/docs/en/Opentracing.md b/docs/en/Opentracing.md index ce270c6e8..e6215f1e9 100644 --- a/docs/en/Opentracing.md +++ b/docs/en/Opentracing.md @@ -7,7 +7,6 @@ ``` -   [ ![Download](https://api.bintray.com/packages/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-opentracing/images/download.svg) ](https://bintray.com/wu-sheng/skywalking/org.apache.skywalking.apm-toolkit-opentracing/_latestVersion) * Use our OpenTracing tracer implementation ```java From 9ae8318c1d5664335f5116bbf5322ee7f14c09d7 Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 3 Mar 2018 23:02:29 +0800 Subject: [PATCH 5/5] Rename collector to backend --- ...luster-mode-CN.md => Deploy-backend-in-cluster-mode-CN.md} | 0 ...one-mode-CN.md => Deploy-backend-in-standalone-mode-CN.md} | 0 docs/cn/Quick-start-CN.md | 4 ++-- ...r-in-cluster-mode.md => Deploy-backend-in-cluster-mode.md} | 0 ...tandalone-mode.md => Deploy-backend-in-standalone-mode.md} | 0 docs/en/Quick-start.md | 4 ++-- 6 files changed, 4 insertions(+), 4 deletions(-) rename docs/cn/{Deploy-collector-in-cluster-mode-CN.md => Deploy-backend-in-cluster-mode-CN.md} (100%) rename docs/cn/{Deploy-collector-in-standalone-mode-CN.md => Deploy-backend-in-standalone-mode-CN.md} (100%) rename docs/en/{Deploy-collector-in-cluster-mode.md => Deploy-backend-in-cluster-mode.md} (100%) rename docs/en/{Deploy-collector-in-standalone-mode.md => Deploy-backend-in-standalone-mode.md} (100%) diff --git a/docs/cn/Deploy-collector-in-cluster-mode-CN.md b/docs/cn/Deploy-backend-in-cluster-mode-CN.md similarity index 100% rename from docs/cn/Deploy-collector-in-cluster-mode-CN.md rename to docs/cn/Deploy-backend-in-cluster-mode-CN.md diff --git a/docs/cn/Deploy-collector-in-standalone-mode-CN.md b/docs/cn/Deploy-backend-in-standalone-mode-CN.md similarity index 100% rename from docs/cn/Deploy-collector-in-standalone-mode-CN.md rename to docs/cn/Deploy-backend-in-standalone-mode-CN.md diff --git a/docs/cn/Quick-start-CN.md b/docs/cn/Quick-start-CN.md index 9567bf38d..211982c25 100644 --- a/docs/cn/Quick-start-CN.md +++ b/docs/cn/Quick-start-CN.md @@ -1,7 +1,7 @@ # 部署步骤 1. 在Maven Central中下载 `org.apache.skywalking.apm-dist`. 或者本地编译程序，在`dist`目录中找到`skywalking-dist.tar.gz/.zip`. 1. 部署 Backend - 1. [单机模式](Deploy-collector-in-standalone-mode-CN.md) - 1. [集群模式](Deploy-collector-in-cluster-mode-CN.md) + 1. [单机模式](Deploy-backend-in-standalone-mode-CN.md) + 1. [集群模式](Deploy-backend-in-cluster-mode-CN.md) 1. 部署 Java Agent，[doc](Deploy-skywalking-agent-CN.md) 1. 重启并访问系统功能，查看UI即可。 \ No newline at end of file diff --git a/docs/en/Deploy-collector-in-cluster-mode.md b/docs/en/Deploy-backend-in-cluster-mode.md similarity index 100% rename from docs/en/Deploy-collector-in-cluster-mode.md rename to docs/en/Deploy-backend-in-cluster-mode.md diff --git a/docs/en/Deploy-collector-in-standalone-mode.md b/docs/en/Deploy-backend-in-standalone-mode.md similarity index 100% rename from docs/en/Deploy-collector-in-standalone-mode.md rename to docs/en/Deploy-backend-in-standalone-mode.md diff --git a/docs/en/Quick-start.md b/docs/en/Quick-start.md index cdc15d93a..398ac04c1 100644 --- a/docs/en/Quick-start.md +++ b/docs/en/Quick-start.md @@ -1,7 +1,7 @@ # Quick start 1. Download `org.apache.skywalking.apm-dist` in maven central. Or find `skywalking-dist.tar.gz/.zip` in `dist` folder after `mvn clean package`. 1. Deploy Backend - - [Standalone Mode](Deploy-collector-in-standalone-mode.md) - - [Cluster Mode](Deploy-collector-in-cluster-mode.md) + - [Standalone Mode](Deploy-backend-in-standalone-mode.md) + - [Cluster Mode](Deploy-backend-in-cluster-mode.md) 1. Deploy Java Agent，[doc](Deploy-skywalking-agent.md) 1. Reboot your applications, and open UI. \ No newline at end of file