From c53359a1a0d0823dce233cf4441b6199d7915012 Mon Sep 17 00:00:00 2001 From: Lemon Date: Mon, 30 Apr 2018 10:15:31 +0800 Subject: [PATCH] Add optional plugins document. (#1136) --- docs/README_ZH.md | 1 + docs/cn/Optional-plugins-CN.md | 21 +++++++++++++++++++++ docs/en/Optional-plugins.md | 2 +- 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/cn/Optional-plugins-CN.md diff --git a/docs/README_ZH.md b/docs/README_ZH.md index 2fde3a268f..1672ecc685 100644 --- a/docs/README_ZH.md +++ b/docs/README_ZH.md @@ -5,6 +5,7 @@ * [快速入门](cn/Quick-start-CN.md) * [中间件，框架与类库支持列表](Supported-list.md) * [如何关闭特定插件](cn/How-to-disable-plugin-CN.md) + * [可选插件](cn/Optional-plugins-CN.md) * 高级特性 * [通过系统启动参数进行覆盖配置](cn/Setting-override-CN.md) * [服务直连(Direct uplink)及禁用名称服务(naming service)](cn/Direct-uplink-CN.md) diff --git a/docs/cn/Optional-plugins-CN.md b/docs/cn/Optional-plugins-CN.md new file mode 100644 index 0000000000..fea89817f4 --- /dev/null +++ b/docs/cn/Optional-plugins-CN.md @@ -0,0 +1,21 @@ +# 可选插件 +可选插件可以由源代码或者agent下的`optional-plugins`文件夹中提供。 + +为了使用这些插件，你需要自己编译源代码，或将某些插件复制到`/plugins`。 + +## Spring bean 插件 +这个插件允许在Spring上下文中追踪带有`@Bean`、 `@Service`、`@Component`和`@Repository`注解的bean的所有方法。 + +- 为什么这个插件是可选的？ +在Spring上下文中追踪所有方法会创建很多的span，也会消耗更多的CPU，内存和网络。 +当然你希望包含尽可能多的span，但请确保你的系统有效负载能够支持这些。 + +## Oracle and Resin 插件 +由于Oracle和Resin的License，这些插件无法在Apache发行版中提供。 +如果你想了解详细信息，请阅读 [Apache license legal document](https://www.apache.org/legal/resolved.html) + +- 我们应该如何在本地构建这些可选插件？ + +1. Resin 3: 下载Resin 3.0.9 并且把jar放在`/ci-dependencies/resin-3.0.9.jar`. +1. Resin 4: 下载Resin 4.0.41 并且把jar放在`/ci-dependencies/resin-4.0.41.jar`. +1. Oracle: 下载Oracle OJDBC-14 Driver 10.2.0.4.0 并且把jar放在`/ci-dependencies/ojdbc14-10.2.0.4.0.jar`. diff --git a/docs/en/Optional-plugins.md b/docs/en/Optional-plugins.md index 479270449d..d1f83f960f 100644 --- a/docs/en/Optional-plugins.md +++ b/docs/en/Optional-plugins.md @@ -7,7 +7,7 @@ For using these plugins, you need to compile source codes by yourself, or copy t This plugin allows to trace all methods of beans in Spring context, which are annotated with `@Bean`, `@Service`, `@Component` and `@Repository`. -- Why does this plugin optional? +- Why does this plugin optional? Tracing all methods in Spring context all creates a lot of spans, which also spend more CPU, memory and network. Of course you want to have spans as many as possible, but please make sure your system payload can support these. -- GitLab