Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
山不在高_有仙则灵
SkyWalking
提交
d0f15fc3
S
SkyWalking
项目概览
山不在高_有仙则灵
/
SkyWalking
与 Fork 源项目一致
Fork自
apache / SkyWalking
通知
12
Star
0
Fork
2
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
S
SkyWalking
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
d0f15fc3
编写于
7月 10, 2018
作者:
X
xinzhuxiansheng
提交者:
wu-sheng
7月 09, 2018
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update Quick-start-CN.md (#1436)
Sync English documents to Chinese.
上级
8eb2bef1
变更
4
显示空白变更内容
内联
并排
Showing
4 changed file
with
109 addition
and
113 deletion
+109
-113
docs/cn/Deploy-backend-in-cluster-mode-CN.md
docs/cn/Deploy-backend-in-cluster-mode-CN.md
+61
-38
docs/cn/Deploy-backend-in-standalone-mode-CN.md
docs/cn/Deploy-backend-in-standalone-mode-CN.md
+15
-12
docs/cn/Deploy-skywalking-agent-CN.md
docs/cn/Deploy-skywalking-agent-CN.md
+14
-55
docs/cn/Quick-start-CN.md
docs/cn/Quick-start-CN.md
+19
-8
未找到文件。
docs/cn/Deploy-backend-in-cluster-mode-CN.md
浏览文件 @
d0f15fc3
## 所需的第三方软件
## 所需的第三方软件
-
被监控程序要求JDK6+
-
JDK6+(被监控的应用程序运行在jdk6及以上版本)
-
SkyWalking collector和WebUI要求JDK8+
-
JDK8+(SkyWalking collector和WebUI部署在jdk8及以上版本)
-
Elasticsearch 5.x
-
Elasticsearch 5.x
(集群模式或不使用)
-
Zookeeper 3.4.10
-
Zookeeper 3.4.10
-
被监控应用的宿主服务器系统时间(包含时区)与collectors,UIs部署的宿主服务器时间设置正确且相同
## 下载发布版本
## 下载发布版本
-
前向
[
发布页面
](
http://skywalking.apache.org/downloads/
)
-
前向
[
发布页面下载
](
http://skywalking.apache.org/downloads/
)
## 部署 Zookeeper
Zookeeper用于collector协作,仅在需要多个collector实例时才需要.
在每个collector实例的
`application.yml`
中添加Zookeeper集群配置
```
yml
cluster
:
# zk用于管理collector集群协作.
zookeeper
:
# 多个zk连接地址用逗号分隔.
hostPort
:
localhost:2181
sessionTimeout
:
100000
```
## 部署Elasticsearch
## 部署Elasticsearch
-
修改
`elasticsearch.yml`
文件
-
修改
`elasticsearch.yml`
文件
-
设置
`cluster.name: CollectorDBCluster`
。此名称需要和collector配置文件一致。
-
设置
`cluster.name: CollectorDBCluster`
。此名称需要和collector配置文件一致。
-
设置
`node.name: anyname`
,
可以设置为任意名字,如Elasticsearch为集群模式,则每个节点名称需要不同。
-
设置
`node.name: anyname`
,
可以设置为任意名字,如Elasticsearch为集群模式,则每个节点名称需要不同。
-
增加如下配置
-
增加如下配置
```
```
...
@@ -18,40 +32,50 @@
...
@@ -18,40 +32,50 @@
network.host: 0.0.0.0
network.host: 0.0.0.0
thread_pool.bulk.queue_size: 1000
thread_pool.bulk.queue_size: 1000
```
```
请参阅ElasticSearch官方文档以了解如何部署集群(推荐)
-
启动Elasticsearch
-
启动
Elasticsearch
### 部署collector
### 配置 collector
1.
解压安装包
`tar -xvf skywalking-collector.tar.gz`
,windows用户可以选择zip包
下面是关于collector连接配置的5种类型方式
2.
设置Collector集群模式
1.
`naming`
:agent使用HTTP协议连接collectors
1.
`agent_gRPC`
:agent使用gRPC协议连接collectors
1.
`remote`
:Collector使用gRPC协议连接collector
1.
`ui`
:使用HTTP协议连接collector,(大多数情况不需要修改)
1.
`agent_jetty`
:agent使用HTTP协议连接collectors(可选连接)
集群模式主要依赖Zookeeper的注册和应用发现能力。所以,你只需要调整
`config/application.yml`
中的host和port配置,使用实际IP和端口,代替默认配置。
其次,将storage的注释取消,并修改为Elasticsearch集群的节点地址信息。
以下是
`application.yml`
的详细的配置
-
`config/application.yml`
-
`config/application.yml`
```
```
cluster:
cluster:
#
配置zookeeper集群信息
#
The Zookeeper cluster for collector cluster management.
zookeeper:
zookeeper:
hostPort: localhost:2181
hostPort: localhost:2181
sessionTimeout: 100000
sessionTimeout: 100000
naming:
naming:
# 配置探针使用的host和port
# Host and port used for agent config
jetty:
jetty:
# 配置agent发现collector集群,host必须要系统真实网络ip地址. agent --(HTTP)--> collector
host: localhost
host: localhost
port: 10800
port: 10800
contextPath: /
contextPath: /
remote:
remote:
gRPC:
gRPC:
# 配置collector节点在集群中相互通信,host必须要系统真实网络ip地址. collectorN --(gRPC) --> collectorM
host: localhost
host: localhost
port: 11800
port: 11800
agent_gRPC:
agent_gRPC:
gRPC:
gRPC:
# 配置agent上传(链路跟踪和指标)数据到collector,host必须要系统真实网络ip地址. agent--(gRPC)--> collector
host: localhost
host: localhost
port: 11800
port: 11800
agent_jetty:
agent_jetty:
jetty:
jetty:
# 配置agent上传(链路跟踪和指标)数据到collector,host必须要系统真实网络ip地址. agent--(HTTP)--> collector
# SkyWalking native Java/.Net/node.js agents don't use this.
# Open this for other implementor.
host: localhost
host: localhost
port: 12800
port: 12800
contextPath: /
contextPath: /
...
@@ -66,10 +90,11 @@ analysis_segment_parser:
...
@@ -66,10 +90,11 @@ analysis_segment_parser:
bufferSegmentMaxFileSize: 500M
bufferSegmentMaxFileSize: 500M
ui:
ui:
jetty:
jetty:
# 配置UI访问collector,host必须要系统真实网络ip地址.
host: localhost
host: localhost
port: 12800
port: 12800
contextPath: /
contextPath: /
# 配置
Elasticsearch 集群连接信息
# 配置Elasticsearch 集群连接信息
storage:
storage:
elasticsearch:
elasticsearch:
clusterName: CollectorDBCluster
clusterName: CollectorDBCluster
...
@@ -80,14 +105,14 @@ storage:
...
@@ -80,14 +105,14 @@ storage:
highPerformanceMode: true
highPerformanceMode: true
# 设置统计指标数据的失效时间,当指标数据失效时系统将数据自动删除.
# 设置统计指标数据的失效时间,当指标数据失效时系统将数据自动删除.
traceDataTTL: 90 # 单位为分
traceDataTTL: 90 # 单位为分
minuteMetricDataTTL:
90
# 单位为分
minuteMetricDataTTL:
45
# 单位为分
hourMetricDataTTL: 36 # 单位为小时
hourMetricDataTTL: 36 # 单位为小时
dayMetricDataTTL: 45 # 单位为天
dayMetricDataTTL: 45 # 单位为天
monthMetricDataTTL: 18 # 单位为月
monthMetricDataTTL: 18 # 单位为月
configuration:
configuration:
default:
default:
#
namespace: xxxxx
#
namespace: xxxxx
# 告警阀值
# 告警阀值
applicationApdexThreshold: 2000
applicationApdexThreshold: 2000
serviceErrorRateThreshold: 10.00
serviceErrorRateThreshold: 10.00
serviceAverageResponseTimeThreshold: 2000
serviceAverageResponseTimeThreshold: 2000
...
@@ -95,28 +120,26 @@ configuration:
...
@@ -95,28 +120,26 @@ configuration:
instanceAverageResponseTimeThreshold: 2000
instanceAverageResponseTimeThreshold: 2000
applicationErrorRateThreshold: 10.00
applicationErrorRateThreshold: 10.00
applicationAverageResponseTimeThreshold: 2000
applicationAverageResponseTimeThreshold: 2000
# 热力图配置,修改配置后需要删除热力指标统计表,由系统重建
# 热力图配置,修改配置后需要删除热力指标统计表,由系统重建
thermodynamicResponseTimeStep: 50
thermodynamicResponseTimeStep: 50
thermodynamicCountOfResponseTimeSteps: 40
thermodynamicCountOfResponseTimeSteps: 40
```
```
### 配置 UI
3.
运行
`bin/startup.sh`
启动。windows用户为.bat文件。
UI的配置项保存在
`webapp/webapp.yml`
中.
参考下面描述,更改
`collector.ribbon.listOfServers`
并且与
`naming.jetty`
参数值对应.
### 部署UI
1.
解压安装包
`tar -xvf skywalking-dist.tar.gz`
,windows用户可以选择zip包
2.
配置UI集群模式.
UI的配置信息保存在
`webapp/webapp.yml`
中.
|
配置项 | 描述
|
|
Config | Description
|
|----------------------------------|----------------------------------------------------------------------------------|
|----------------------------------|----------------------------------------------------------------------------------
--------------------
|
|
`server.port`
|
监听端口
|
|
`server.port`
|
默认监听8080端口
|
|
`collector.ribbon.listOfServers`
| collector
命名服务地址.(与
`config/application.yml`
中的
`naming.jetty`
配置保持相同 ),多个Collector地址以
`,`
分割
|
|
`collector.ribbon.listOfServers`
| collector
的访问服务名称(与
`config/application.yml`
中
`naming.jetty`
配置保持相同) 且若是多个 collector 服务名称用','分隔
|
|
`collector.path`
| Collector
查询uri. 默认: /graphql
|
|
`collector.path`
| Collector
查询uri地址. 默认是/graphql
|
|
`collector.ribbon.ReadTimeout`
| 查询超时时间
. 默认: 10 秒
|
|
`collector.ribbon.ReadTimeout`
| 查询超时时间
,默认是10秒
|
|
`security.user.*`
| 登录用户名/密码. 默认
: admin/admin
|
|
`security.user.*`
| 登录用户名/密码. 默认
是 admin/admin
|
3.
运行
`bin/webappService.sh`
### 启动 collector 节点
1.
使用
`bin/startup.sh`
同时启动collector和UI,若不使用1启动,需要单独启动,参考2,3
2.
单独启动collector,运行
`bin/collectorService.sh`
3.
单独启动UI,运行
`bin/webappService.sh`
\ No newline at end of file
docs/cn/Deploy-backend-in-standalone-mode-CN.md
浏览文件 @
d0f15fc3
# 用途说明
# 用途说明
单机模式
默认使用本地H2数据库,不支持集群部署
。主要用于:预览、功能测试、演示和低压力系统。
单机模式
collector不支持集群部署,它使用本地H2数据库
。主要用于:预览、功能测试、演示和低压力系统。
如果
使用单机collector用于非演示环境,你可选择使用Elasticsearch作为存储实现。
如果
在生产或者真实环境中(非本地demo) 部署SkyWalking,至少应该切换到Elasticsearch作为存储.
**在5.0.0-alpha版本中,暂不提供H2实现, 所以在启动之前,必须先部署ElasticSearch**
**在5.0.0-alpha版本中,暂不提供H2实现, 所以在启动之前,必须先部署ElasticSearch**
## 所需的第三方软件
## 所需的第三方软件
-
JDK8+
-
JDK6+(被监控的应用程序运行在jdk6及以上版本)
-
JDK8+(SkyWalking collector和WebUI部署在jdk8及以上版本)
-
Elasticsearch 5.x(集群模式或不使用)
## 下载发布版本
## 下载发布版本
-
前向
[
发布页面
](
http://skywalking.apache.org/downloads/
)
-
前向
[
发布页面
下载
](
http://skywalking.apache.org/downloads/
)
##
Quick Start
##
快速入门
Collector单机模拟启动简单,提供和集群模式相同的功能,单机模式下除端口(8080, 10800, 11800, 12800)被占用的情况下,直接启动即可
。
如果端口8080,10800,11800,12800不被占用,你可以直接解压tar / unzip,然后启动
。
## 部署后台服务
-
部署 ElasticSearch.
1.
解压安装包
`tar -xvf skywalking-collector.tar.gz`
,windows用户可以选择zip包
-
linux环境中
`tar -xvf skywalking-dist.tar.gz`
解压,windows环境中选择zip包.
1.
运行
`bin/startup.sh`
启动。windows用户为.bat文件。
-
运行
`bin/startup.sh`
,windows环境运行
`bin/startup.bat`
你可以使用
`config / application.yml`
的默认值
-
**注意:在5.0.0-alpha 版本中,startup.sh将会启动collector和UI两个进程,UI通过127.0.0.1:10800访问本地collector,无需额外配置。**
-
**注意:在5.0.0-alpha 版本中,startup.sh将会启动collector和UI两个进程,UI通过127.0.0.1:10800访问本地collector,无需额外配置。**
## 使用Elastic Search代替H2存储
## 使用Elastic Search代替H2存储
-
在单机模式下,
`collector`
也支持其他的存储(当前已支持的ElasticSearch 5.3),取消
`application.yml`
配置文件中的
`storage`
相关配置节的注释,并修改配置,默认的配置是
`collector`
-
即使在单机模式下,
`collector`
也可以配置ElasticSearch作为运行存储介质, 若想使用,去掉
`application.yml`
配置文件中的
`storage`
相关配置节的注释,并修改配置,默认的配置是
`collector`
和
`Elasticsearch`
运行在同一台机器上,并不开启集群模式。
和
`Elasticsearch`
运行在同一台机器上。
## 部署Elasticsearch
## 部署Elasticsearch
-
修改
`elasticsearch.yml`
文件
-
修改
`elasticsearch.yml`
文件
...
...
docs/cn/Deploy-skywalking-agent-CN.md
浏览文件 @
d0f15fc3
## 下载skywalking探针发布版本
## 下载skywalking探针发布版本
-
前
向
[
发布页面
](
http://skywalking.apache.org/downloads/
)
-
前
往
[
发布页面下载
](
http://skywalking.apache.org/downloads/
)
## 部署
探针
## 部署
skywalking javaagent
1.
拷贝
skywalking-agent目录到所需位置,探针包含整个目录,请不要改变目录结构
1.
拷贝
agent目录到所需位置. 日志,插件和配置都包含在包中,请不要改变目录结构.
1.
增加JVM启动参数,
`-javaagent:/path/to/skywalking-agent/skywalking-agent.jar`
。参数值为skywalking-agent.jar的绝对路径。
2.
增加JVM启动参数, -javaagent:/path/to/skywalking-agent/skywalking-agent.jar. 参数值为skywalking-agent.jar的绝对路径。
新目录结构如下:
新
的 agent package
目录结构如下:
```
```
+-- skywalking-agent
+-- skywalking-agent
+-- activations
+-- activations
...
@@ -23,67 +23,26 @@
...
@@ -23,67 +23,26 @@
skywalking-agent.jar
skywalking-agent.jar
```
```
-
`/config/agent.config`
包含探针所需配置,中文说明如下。
-
启动被监控应用.
```
properties
# 当前的应用编码,最终会显示在webui上。
# 建议一个应用的多个实例,使用有相同的application_code。请使用英文
agent.application_code
=
Your_ApplicationName
# 每三秒采样的Trace数量
# 默认为负数,代表在保证不超过内存Buffer区的前提下,采集所有的Trace
# agent.sample_n_per_3_secs=-1
# 设置需要忽略的请求地址
# 默认配置如下
# agent.ignore_suffix=.jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg
# 探针调试开关,如果设置为true,探针会将所有操作字节码的类输出到/debugging目录下
# skywalking团队可能在调试,需要此文件
# agent.is_open_debugging_class = true
# 对应Collector的config/application.yml配置文件中 agent_server/jetty/port 配置内容
# 例如:
# 单节点配置:SERVERS="127.0.0.1:8080"
# 集群配置:SERVERS="10.2.45.126:8080,10.2.45.127:7600"
collector.servers
=
127.0.0.1:10800
# 日志文件名称前缀
logging.file_name
=
skywalking-agent.log
# 日志文件最大大小
# 如果超过此大小,则会生成新文件。
# 默认为300M
logging.max_file_size
=
314572800
# 日志级别,默认为DEBUG。
logging.level
=
DEBUG
```
-
启动被监控应用。
# 高级特性
# 高级特性
-
插件会被统一放置在
`plugins`
目录中,新的插件,也只需要在启动阶段,放在目录中,就自动生效。删除则失效。
-
插件全部放置在
`/plugins`
目录中.新的插件,也只需要在启动阶段,放在目录中,就自动生效,删除则失效.
-
配置除了通过
`/config/agent.config`
文件外,可以通过环境变量和VM参数(-D)来进行设置
-
Log默认使用文件输出到
`/logs`
目录中.
-
参数的key =
`skywalking.`
+
`agent.config`
文件中的key
-
优先级:系统环境变量 > VM参数(-D) >
`/config/agent.config`
中的配置
-
Log默认使用文件输出,输出到
`/logs`
目录中
#
Tomcat配置探针FAQ
#
部署 java agent FAQs
-
Linux Tomcat 7, Tomcat 8
-
Linux Tomcat 7, Tomcat 8
修改
`tomcat/bin/catalina.sh`
,在首行加入如下信息
修改
`tomcat/bin/catalina.sh`
,在首行加入如下信息.
```
shell
```
shell
CATALINA_OPTS
=
"
$CATALINA_OPTS
-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
;
export
CATALINA_OPTS
CATALINA_OPTS
=
"
$CATALINA_OPTS
-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
;
export
CATALINA_OPTS
```
```
-
Windows Tomcat 7, Tomcat 8
-
Windows Tomcat 7, Tomcat 8
修改
`tomcat/bin/catalina.bat`
,在首行加入如下信息
修改
`tomcat/bin/catalina.bat`
,在首行加入如下信息.
```
shell
```
shell
set
"CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
set
"CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
```
```
-
JAR
部署
-
JAR
file
修改启动命令添加启动参数
`-javaagent`
在启动你的应用程序的命令行中添加
`-javaagent`
参数. 并确保在
`-jar`
参数之前添加它. 例如:
```
shell
```
shell
java
-javaagent
:/path/to/skywalking-agent/skywalking-agent.jar
-jar
yourApp.jar
java
-javaagent
:/path/to/skywalking-agent/skywalking-agent.jar
-jar
yourApp.jar
```
```
\ No newline at end of file
docs/cn/Quick-start-CN.md
浏览文件 @
d0f15fc3
# 部署步骤
# 快速入门
1.
下载
`apache-skywalking-apm-incubating-x.y.z.tar.gz`
或
`apache-skywalking-apm-incubating-x.y.z.zip`
快速启动是为了让终端用户在本地快速启动SkyWalking.
1.
部署 Backend
1.
[
单机模式
](
Deploy-backend-in-standalone-mode-CN.md
)
1.
从Apache官方网站下载发布版本.
[
Link
](
http://skywalking.apache.org/downloads/
)
1.
[
集群模式
](
Deploy-backend-in-cluster-mode-CN.md
)
1.
本地部署后台. See
[
collector 单机模式文档
](
Deploy-backend-in-standalone-mode-CN.md
)
1.
部署 Java Agent,
[
doc
](
Deploy-skywalking-agent-CN.md
)
1.
部署 Java Agent.
[
Doc
](
Deploy-skywalking-agent-CN.md
)
1.
重启并访问系统功能,查看UI即可。
1.
设置正确的系统时间(包括时区).
1.
登录页面的默认用户名/密码是
`admin/admin`
。
1.
重新启动你的应用程序,然后打开UI.
\ No newline at end of file
1.
登录页面的默认用户名/密码是
`admin/admin`
.
如果您想将SkyWalking作为集群部署在服务器或云中,请参考如下两个文档:
1.
[
部署 java agent
](
Deploy-skywalking-agent-CN.md
)
1.
[
集群模式部署后台
](
Deploy-backend-in-cluster-mode-CN.md
)
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录