From 0d2ee9af4bd47c8a38c23c7d1fa26aee1f0d0473 Mon Sep 17 00:00:00 2001 From: wusheng Date: Sat, 26 Nov 2016 22:29:43 +0800 Subject: [PATCH] fix more issue. change README.md to English. --- README.md | 78 ++----- .../dependency-reduced-pom.xml | 191 +++++++++--------- .../eye/skywalking/agent/SkyWalkingAgent.java | 8 +- skywalking-sniffer/skywalking-api/pom.xml | 6 - .../com/a/eye/skywalking/conf/Config.java | 2 + .../skywalking/conf/ConfigInitializer.java | 9 +- .../ack/SendAckSpanEventHandler.java | 1 + .../request/SendRequestSpanEventHandler.java | 2 +- 8 files changed, 130 insertions(+), 167 deletions(-) diff --git a/README.md b/README.md index f3d636abe..89e1b309e 100644 --- a/README.md +++ b/README.md @@ -104,58 +104,23 @@ ___ ## instrument javaagent jdk version - support 1.6+ , instruments applications can run in jdk6 -## 编译与部署 / Build and deploy -- 服务端发布版本[下载](https://github.com/wu-sheng/sky-walking/releases) (.tar.gz) +## Download and deploy servers - Download Server release version. [Download](https://github.com/wu-sheng/sky-walking/releases) (.tar.gz) -- [配置应用服务器](CONFIG_DOC.md) -- [config servers](CONFIG_DOC.md) -- 如果您想自己编译最新版本，可参考《[代码编译说明](BUILD_DOC.md)》 -- [Code compilation instructions](BUILD_DOC.md) + +### run all servers in a Docker +- Docker version is good quick-test. + +### deploy your own cluster -## Download offical agent +## Download agent [ ![Download](https://api.bintray.com/packages/wu-sheng/skywalking/com.a.eye.skywalking-agent/images/download.svg) ](https://bintray.com/wu-sheng/skywalking/com.a.eye.skywalking-agent/_latestVersion) -- 通过github-release[下载](https://github.com/wu-sheng/sky-walking/releases) -- 通过[skywalking bintray官网](https://bintray.com/wu-sheng/skywalking/)托管，可使用公网仓库[https://jcenter.bintray.com/](https://jcenter.bintray.com/)下载。 -- use public repository [https://jcenter.bintray.com/](https://jcenter.bintray.com/) to download sdk - -## 下载并设置授权文件 / Download auth file -- 注册并登陆过skywalking-webui，创建应用。（一个用户代表一个逻辑集群，一个应用代表一个服务集群。如前后端应用应该设置两个应用，但归属一个用户） -- Sign up and login in skywalking-webui. Create application as needed. -- 下载授权文件，放在在agent jar所在目录中 -- download auth file(*.auth), and copy the auth file to directory of the agent jar - -## 在运行时环境中设置环境变量 / set environment variables -``` -export SKYWALKING_RUN=true -``` -- 设置完成后，SkyWalking将随应用启动运行 -- After set env, SkyWalking will be working, when application startup. - - -## 使用-javaagent 并启动应用程序 / start application with -javaagent -- 为应用程序添加启动参数 +## start application with -javaagent ```shell -java -jar ... -javaagent:/..ospath../skywalking-agent-x.x-Final.jar +java -jar ... -javaagent:/..ospath../skywalking-agent-x.x.jar ``` -- Tomcat可以使用修改启动文件，配置-javaagent参数 - -# 在应用程序中显示traceid / How to find tid -- 通过web应用的http调用入口，通过返回的header信息，找到此次调用的traceid。前提：此web应用的url，已经使用skywalking进行监控。 - -# Development Documents -- [Development Guide of Plugin](https://github.com/wu-sheng/sky-walking/wiki/Development-Guide-of-Plugin) - -# QA -- [SkyWalking SDK是否已经工作？ Is SkyWalking SDK Running?](QA/IS_RUNNING.md) -- [tid在web-ui上无法查询. tid can't be search on web-ui](QA/TID_CANNOT_BE_SEARCH.md) -- [SkyWalking Server的运行情况. The status of SkyWalking Server](QA/SERVER_RUNNING_STAUTS.md) -- [SkyWalking Analysis部署运行常见问题. The FAQ of SkyWalking Analysis deployment](QA/deploy-sw_analysis-problem.md) - -# 源代码说明 -* [网络传输协议、缓存文件协议说明. the protocols of transform between agent and collector, collector buffer file](doc/protocol.md) # Recent RoadMap * [In the schedule] v2.1-2017 @@ -165,26 +130,9 @@ java -jar ... -javaagent:/..ospath../skywalking-agent-x.x-Final.jar * support log framework(log4j, log4j2, logback) to output traceid in system log. * [Dev] v2.0-2016 - * 移除对于Hadoop，HBase的依赖，降低部署和运维难度 - * 使用内嵌式数据库，和分布式集群 - * 移除副本发送机制 - * 支持数据文件的时间分片，支持集群TB级别日志文件存储 - * 支持统计和高效的准实时统计汇总 - * 更多插件的支持 + * not dependency on Hadoop or HBase, easy to deploy or maintenance + * support simple-cluster mode + * support docker mode in single-server-instance + * support more plugins * motan rpc framework (provided) -* [Release] v1.0-Final - * 客户端与服务端间使用扩展后的网络协议，前置的测试版本无法兼容，以提高服务端的稳定性和健壮性。（在内部使用过程中，发生因为安全扫描，导致服务端宕机） - * 引入javaagent模式，无需修改任何代码，完成监控。 - * 所有插件将基于字节码技术实现，原有的配置文件模式将被移除。 - -* [Release] v1.0 beta - * 修复大量前置版本的BUG - * 提供基于MR的分析能力，能够对调用链进行分析汇总，并形成调用链统计视图 - -* [Release] v1.0 alpha2 - * 基于v1.0-alpha1的较稳定版本，在内部环境进行数月运行，修复大量影响服务端运行稳定性的问题。 - * v1.0-beta，将提供定时分析任务，部分分析页面展现功能。 - * 预计：后续版本将在插件模式上有较大改变，计划针对java api的拦截和第三方拦截提供更小侵入性的方法。配置和拦截模式会发生相应变化。具体模式，参考v1.0-beta发布时的说明。 - - [More...](https://github.com/wu-sheng/sky-walking/releases) diff --git a/skywalking-sniffer/skywalking-agent/dependency-reduced-pom.xml b/skywalking-sniffer/skywalking-agent/dependency-reduced-pom.xml index 730632c52..241055d5c 100644 --- a/skywalking-sniffer/skywalking-agent/dependency-reduced-pom.xml +++ b/skywalking-sniffer/skywalking-agent/dependency-reduced-pom.xml @@ -1,90 +1,101 @@ - - - - skywalking-collector - com.a.eye - 2.0-2016 - - 4.0.0 - skywalking-agent - skywalking-agent - http://maven.apache.org - - - - maven-shade-plugin - 2.4.1 - - - package - - shade - - - false - true - true - true - - - skywalking-plugin.def - - - - ${premain.class} - - - - - - ${shade.net.bytebuddy.source} - ${shade.net.bytebuddy.target} - - - ${shade.io.netty.source} - ${shade.io.netty.target} - - - ${shade.com.google.gson.source} - ${shade.com.google.gson.target} - - - - - - - - - - - junit - junit - 4.12 - test - - - hamcrest-core - org.hamcrest - - - - - - - bintray-wu-sheng-sky-walking-repository - wu-sheng-sky-walking-repository - https://api.bintray.com/maven/wu-sheng/skywalking/com.a.eye.skywalking-agent/;publish=1 - - - - com.a.eye.skywalking.api.dependencies.net.bytebuddy - com.google.gson - com.a.eye.skywalking.api.dependencies.com.google.gson - UTF-8 - io.netty - com.a.eye.skywalking.api.dependencies.io.netty - net.bytebuddy - com.a.eye.skywalking.agent.SkyWalkingAgent - - - + + + + skywalking-sniffer + com.a.eye + 2.0-2016 + + 4.0.0 + skywalking-agent + skywalking-agent + http://maven.apache.org + + + + maven-shade-plugin + 2.4.1 + + + package + + shade + + + false + true + true + true + + + skywalking-plugin.def + + + + ${premain.class} + + + + + + ${shade.net.bytebuddy.source} + ${shade.net.bytebuddy.target} + + + ${shade.com.lmax.disruptor.source} + ${shade.com.lmax.disruptor.target} + + + + + + + + + + + junit + junit + 4.12 + test + + + hamcrest-core + org.hamcrest + + + + + org.mockito + mockito-core + 1.10.19 + test + + + objenesis + org.objenesis + + + hamcrest-core + org.hamcrest + + + + + + + bintray-wu-sheng-sky-walking-repository + wu-sheng-sky-walking-repository + https://api.bintray.com/maven/wu-sheng/skywalking/com.a.eye.skywalking-agent/;publish=1 + + + + ${shade.package}.${shade.net.bytebuddy.source}} + com.a.eye.skywalking.api.dependencies + UTF-8 + com.lmax.disruptor + ${shade.package}.${shade.com.lmax.disruptor.source} + net.bytebuddy + com.a.eye.skywalking.agent.SkyWalkingAgent + + + diff --git a/skywalking-sniffer/skywalking-agent/src/main/java/com/a/eye/skywalking/agent/SkyWalkingAgent.java b/skywalking-sniffer/skywalking-agent/src/main/java/com/a/eye/skywalking/agent/SkyWalkingAgent.java index 1c51da0c4..684bfc9ab 100644 --- a/skywalking-sniffer/skywalking-agent/src/main/java/com/a/eye/skywalking/agent/SkyWalkingAgent.java +++ b/skywalking-sniffer/skywalking-agent/src/main/java/com/a/eye/skywalking/agent/SkyWalkingAgent.java @@ -29,10 +29,10 @@ public class SkyWalkingAgent { LogManager.setLogResolver(new EasyLogResolver()); } - private static ILog easyLogger; + private static ILog logger; public static void premain(String agentArgs, Instrumentation instrumentation) throws PluginException { - easyLogger = LogManager.getLogger(SkyWalkingAgent.class); + logger = LogManager.getLogger(SkyWalkingAgent.class); initConfig(); final PluginDefineCategory pluginDefineCategory = PluginDefineCategory.category(new PluginBootstrap().loadPlugins()); @@ -54,7 +54,7 @@ public class SkyWalkingAgent { @Override public void onError(String typeName, ClassLoader classLoader, JavaModule module, Throwable throwable) { - easyLogger.error("Failed to enhance class " + typeName, throwable); + logger.error("Failed to enhance class " + typeName, throwable); } @Override @@ -86,7 +86,7 @@ public class SkyWalkingAgent { urlString = urlString.substring(urlString.indexOf("file:"), urlString.indexOf('!')); return new File(new URL(urlString).getFile()).getParentFile().getAbsolutePath(); } catch (Exception e) { - easyLogger.error("Failed to init config .", e); + logger.error("Failed to init config .", e); return ""; } } diff --git a/skywalking-sniffer/skywalking-api/pom.xml b/skywalking-sniffer/skywalking-api/pom.xml index ab0bd0c20..b83eb311f 100644 --- a/skywalking-sniffer/skywalking-api/pom.xml +++ b/skywalking-sniffer/skywalking-api/pom.xml @@ -26,7 +26,6 @@ byte-buddy 1.5.7 - com.a.eye skywalking-network @@ -37,11 +36,6 @@ disruptor 3.3.6 - - com.a.eye - skywalking-registry - ${project.parent.version} - com.a.eye skywalking-health-report diff --git a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/Config.java b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/Config.java index 95adf9fc3..eb68e7ea5 100644 --- a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/Config.java +++ b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/Config.java @@ -11,6 +11,8 @@ public class Config { public static String AGENT_BASE_PATH = ""; + public static String SERVERS = ""; + } public static class Disruptor{ diff --git a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/ConfigInitializer.java b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/ConfigInitializer.java index dd5ca43ce..4b0b14c7a 100644 --- a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/ConfigInitializer.java +++ b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/conf/ConfigInitializer.java @@ -25,6 +25,7 @@ public class ConfigInitializer { Config.SkyWalking.USER_ID = System.getProperty("userId"); Config.SkyWalking.APPLICATION_CODE = System.getProperty("applicationCode"); + Config.SkyWalking.SERVERS = System.getProperty("server"); if (configFileStream == null) { logger.info("Not provide sky-walking certification documents, sky-walking api run in default config."); @@ -39,7 +40,13 @@ public class ConfigInitializer { } if(StringUtil.isEmpty(Config.SkyWalking.USER_ID)){ - + throw new ExceptionInInitializerError("'-DuserId=' is missing."); + } + if(StringUtil.isEmpty(Config.SkyWalking.APPLICATION_CODE)){ + throw new ExceptionInInitializerError("'-DapplicationCode=' is missing."); + } + if(StringUtil.isEmpty(Config.SkyWalking.SERVERS)){ + throw new ExceptionInInitializerError("'-Dserver=' is missing."); } } diff --git a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/ack/SendAckSpanEventHandler.java b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/ack/SendAckSpanEventHandler.java index 9e89e0000..fb8c8f6f7 100644 --- a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/ack/SendAckSpanEventHandler.java +++ b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/ack/SendAckSpanEventHandler.java @@ -27,6 +27,7 @@ public class SendAckSpanEventHandler implements EventHandler { if (endOfBatch || buffer.size() == bufferSize) { try { + //TODO， use GRPC to send HealthCollector.getCurrentHeathReading("SendAckSpanEventHandler").updateData(HeathReading.INFO, "%s messages were successful consumed .", buffer.size()); } finally { diff --git a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/request/SendRequestSpanEventHandler.java b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/request/SendRequestSpanEventHandler.java index bb4fba57a..c0220e245 100644 --- a/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/request/SendRequestSpanEventHandler.java +++ b/skywalking-sniffer/skywalking-api/src/main/java/com/a/eye/skywalking/disruptor/request/SendRequestSpanEventHandler.java @@ -27,7 +27,7 @@ public class SendRequestSpanEventHandler implements EventHandler