Commit f27ee281 authored by 马超's avatar 马超

doc: 文档补充和修改

parent 01d13a37
......@@ -31,20 +31,78 @@ tar -zxvf apache-skywalking-java-agent-8.8.0.tgz
```shell
├── config/agent.config # 为客户端代理配置文件,可以根据系统情况进行响应调整
├── logs # SW agent相关运行情况日志。
├── activations # 插件包
├── bootstrap-plugins # 插件包
├── optional-plugins # 插件包
├── optional-reporter-plugins # 插件包
├── activations # 可选插件包
├── bootstrap-plugins # 可选插件包
├── optional-plugins # 可选插件包
├── optional-reporter-plugins # 可选插件包
├── plugins # 插件目录
├── skywalking-agent.jar # agent代理jar包。
```
## 启动
JAR包 使用命令行启动应用时,添加-javaagent参数。比如:
**1)、前置工作**
添加SpringCloud支持,将optional-plugins目录下的`apm-spring-cloud-gateway-2.1.x-plugin-8.8.0.jar`拷贝到plugins目录下。
如果想在SkyWalking上看日志,需要修改工程pom文件
```xml
<!-- 在pom中添加skywalking 日志支持 -->
<dependency>
<groupId>org.apache.skywalking</groupId>
<artifactId>apm-toolkit-logback-1.x</artifactId>
<version>8.8.0</version>
</dependency>
```
并在logback.xml文件中添加以下内容
```xml
<!-- skywalking -->
<appender name="skywalking-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender">
<!-- 日志输出编码 -->
<encoder>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%date [%level] [%thread] %logger{60} [%file : %line] %msg%n</pattern>
</encoder>
</appender>
```
将appender添加到root标签中
```xml
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="InfoLogFile"/>
<appender-ref ref="ErrorLogFile"/>
<!-- 添加skywalking日志 -->
<appender-ref ref="skywalking-log"/>
</root>
```
**2)、带agent启动**
JAR包 使用命令行启动应用时,添加-javaagent参数。需要在参数上指定服务名 `agent.service_name`,指定SkyWalking后台地址和端口`collector.backend_service`
```java
base-service 服务:
java -javaagent:/agent解压路径/skywalking-agent.jar=agent.service_name=base-service,collector.backend_service=sinra-server0:8009 -jar /jar路径/base-startup-1.0-SNAPSHOT.jar
java -javaagent:/agent绝对路径/skywalking-agent.jar=agent.service_name=base-service,collector.backend_service=sinra-server0:11800 -jar /jar路径/base-startup-1.0-SNAPSHOT.jar
```
**3)、LDP安装包配置文件boot.conf**
LDP安装包`ldp-manage/conf/boot.conf`中新增了关于SkyWalking的配置,配合tool目录脚本可以非常简单的实现是否启用代理模式启动
```shell
NACOS_SERVER=nacos-server0:8018
SPRING_PROFILES_ACTIVE=prod
DUBBO_PROTOCOL_HOST=ldp-server0
DEPLOY_ENV=prod
# SkyWalking地址
SKYWALKING_SERVICE=ldp-server0:11800
SKYWALKING_START=false
SKYWALKING_URL=/alidata/skywalking-agent/agent/skywalking-agent.jar
```
## Agent的可配置属性列表
......@@ -59,8 +117,8 @@ collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:11800}
| 属性名 | 描述 | 默认值 |
| ---- | ---- | ---- |
| agent.namespace | 命名空间,用于隔离跨进程传播的header。如果进行了配置,header将为HeaderName:Namespace. | 未设置 |
| agent.service_name | 在SkyWalking UI中展示的服务名。5.x版本对应Application,6.x版本对应Service。 建议:为每个服务设置个唯一的名字,服务的多个服务实例为同样的服务名 | Your_ApplicationName |
| agent.namespace | 命名空间,用于隔离跨进程传播的header。如果进行了配置,header将为HeaderName:Namespace. | 未设置 |
| agent.service_name | 在SkyWalking UI中展示的服务名。5.x版本对应Application,6.x版本对应Service。 建议:为每个服务设置个唯一的名字,服务的多个服务实例为同样的服务名 | Your_ApplicationName |
| agent.sample_n_per_3_secs | 负数或0表示不采样,默认不采样。SAMPLE_N_PER_3_SECS表示每3秒采样N条。 | 未设置 |
| agent.authentication | 鉴权是否开启取决于后端的配置,可查看application.yml的详细描述。对于大多数的场景,需要后端对鉴权进行扩展。目前仅实现了基本的鉴权功能。 | 未设置 |
| agent.span_limit_per_segment | 单个segment中的span的最大个数。通过这个配置项,Skywalking可评估应用程序内存使用量。 | 未设置 |
......
......@@ -157,7 +157,7 @@ storage:
asyncBatchPersistentPoolSize: ${SW_STORAGE_ASYNC_BATCH_PERSISTENT_POOL_SIZE:4}
```
切换到mysql需要修改h2 为mysql,并修改mysql的链接地址、用户名、密码。
切换到mysql需要修改h2 为mysql,创建数据库,并修改mysql的链接地址、用户名、密码,
```yml
selector: ${SW_STORAGE:mysql}
......@@ -165,7 +165,7 @@ selector: ${SW_STORAGE:mysql}
**PS:SkyWalking没有mysql驱动,需要根据自己需要将驱动下载或拷贝到oap-libs目录下**
参考样例:
参考样例(需要根据版本下载对应版本驱动)
```shell
# 切换到oap-libs目录下
......@@ -233,7 +233,9 @@ cd bin
./webappService.sh
```
服务启动好后,访问:http://部署服务器ip/8080
服务启动好后,访问:http://部署服务器ip/8080,可以看到SkyWalking的UI界面。
服务端部署好后,还需要客户端收集信息,SkyWalking是使用插件方式来监控服务运行状态,只需要在jar启动时加上agent参数即可,详情请参考[skywalking-agent 说明文档.md](skywalking-agent 说明文档.md)。
## 四、配置详解
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment