Skywalking安装部署，在springboot中的使用

1 Skywalking主要功能特性

（1）多种监控手段，可以通过语言探针和service mesh获得监控数据
（2）支持多种语言探针，包括Java，.NET Core和Node.JS
（3）轻量高效，无需大量服务器资源
（4）模块化，UI，存储，集群管理都有多种机制可选
（5）支持告警
（6）优秀的可视化解决方案

2 Skywalking部署

2.1 部署图

oapservice负责处理探针agent收集到的数据，并进行存储

2.2下载

https://skywalking.apache.org/downloads/

2.3目录说明

webapp：UI前端jar包及配置文件，可以修改前端端口。
oap-libs：后台应用的jar包，以及依赖，里面server-starter-8.7.0.jar是启动程序
config：启动后台应用程序的配置文件，使用的各种配置。主要是application.yml里面有很多。
bin：各种启动脚本，一般使用startup.sh来启动页面和后端应用
|----oapService.sh：默认使用的后台程序启动脚本；（使用的是默认模式启动，还支持其他模式）
|----oapServiceInit.sh：使用init模式启动；在此模式下，OAP服务器启动以执行初始化工作，然后退出。
|----oapServiceNoInit.sh：使用no init模式启动；在此模式下，OAP服务器不进行初始化。
|----webappService.sh：UI前端的启动脚本
|----startup.sh：组合脚本，同时使用oapService.sh，webappService.sh脚本
agent：
----skywalking-agent.jar：代理服务jar包
----config：代理服务启动时使用的配置文件
----plugins：包含多个插件，代理服务启动时会加载该目录下所有插件（实际是jar包）
----optional-plugins：可选插件，当需要支持某种功能时，比如SpringCloud Gateway，则需要把对应的jar包拷贝到plugins

2.4 修改配置文件

修改config下面的application.yml

2.5 启动服务

skywalking-web-ui 的端口默认为8080，可修改
skywalking-oap-server服务启动后默认11800和12800端口，分别为收集监控数据的端口（11800）、接受前端请求的接口（12800），可修改

3 SkyWalking接入微服务

3.1 linux环境通过jar包方式接入

(1)使用脚本启动

export SW_AGENT_NAME=agentName  #“接入的名字”
export SW_AGENT_COLLECTOR_BACKEND_SERVICES=127.0.0.1:11800 #Collector地址
export SW_AGENT_SPAN_LIMIT=2000  #配置链路最大Span数量，默认为300
export JAVA_AGENT=-javaagent:/opt/skywaliking-agent.jar
java $JAVA_AGENT -jar *.jar

(2)或者直接命令启动

java -jar -javaagent:/opt/skywaliking-agent.jar
-DSW_AGENT_COLLECTOR_BACKEND_SERVICES=127.0.0.1:11800
-DSW_AGENT_NAME=mingzi
-SW_AGENT_SPAN_LIMIT=2000 -jar *.jar

3.2在IDEA中使用

添加启动参数

-javaagent:D:\apache-skywalking-java-agent-8.9.0\skywalking-agent\skywalking-agent.jar
-DSW_AGENT_NAME=operate-manager-system
-DSW_AGENT_COLLECTOR_BACKEND_SERVICES=192.168.0.133:11800

需要注意的是，需要把agent文件夹都复制过来。

启动即可

3.3 启动的一些问题

（1）链路不显示gateway，需要拷贝agent/optional-plugins目录下的gateway插件到agent/plugins目录。

（2）参数名对应agent/config/agent.config配置文件中的属性
属性对应源码：org.apache.skywalking.apm.agent.core.conf.Config.java
我们也可以通过配置文件进行覆盖，但是javaagent参数配置方式优先级更高。
（3）Elasticsearch built-in security features are not enabled错误
进入到配置文件，加上
xpack.security.enabled: false

4 自定义链路及自定义返回监控

4.1 添加依赖

<dependency>
  <groupId>org.apache.skywalking</groupId>
  <artifactId>apm-toolkit-trace</artifactId>
  <version>8.8.0</version>
</dependency>

4.2 业务方法在链路中

显示在UI界面了，想要多加一些值，直接加@Tag获取更多信息即可。


或者直接在controller加入也可以

因为这些原本就在链路中，直接加@Tag可以获取更多的信息。

4.3 自定义链路显示，并添加更多信息

使用@Trace将方法添加到链路显示中，用@Tag获取更多信息

即可显示

4.4 更多自定义规则

详情见 https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/customize-enhance-trace/

5 日志

logback官方配置
log4j官方配置
log4j2官方配置

5.1 引入依赖

    <dependency>
        <groupId>org.apache.skywalking</groupId>
        <artifactId>apm-toolkit-logback-1.x</artifactId>
        <version>8.9.0</version>
    </dependency>

5.2 引入链路追踪id

方式一：在原有的logback打印中加入[%tid]

 <!--控制台日志， 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
        <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度,%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid][%thread] %-5level %logger{50}[%L]- %msg%n</pattern>
        </layout>
    </encoder>
</appender>
<!-- 日志输出级别 -->
<root level="INFO">
    <appender-ref ref="STDOUT"/>
</root>

方式二：

<conversionRule conversionWord="tid" converterClass="org.apache.skywalking.apm.toolkit.log.logback.v1.x.LogbackPatternConverter"/>
<!--控制台日志， 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度,%msg：日志消息，%n是换行符-->
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid][%thread] %-5level %logger{50}[%L]- %msg%n</pattern>
    </encoder>
</appender>
<!-- 日志输出级别 -->
<root level="INFO">
    <appender-ref ref="STDOUT"/>
</root>

如果使用了logstash，如下即可。

<conversionRule conversionWord="tid" converterClass="org.apache.skywalking.apm.toolkit.log.logback.v1.x.LogbackPatternConverter"/>
<springProperty scope="context" name="appName" source="spring.application.name" defaultValue="no_application_name"/>
<appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
    <param name="Encoding" value="UTF-8"/>
    <destination>192.168.0.108:5044</destination>
    <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder" >
        <provider class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.logstash.TraceIdJsonProvider" />
        <customFields>{"appName":"${appName}"}</customFields>
    </encoder>
</appender>

5.3 gRpc日志

（1）logback加入配置如下

<appender name="grpc-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{tid}] [%thread] %-5level %logger{36} -%msg%n</Pattern>
            </layout>
        </encoder>
</appender>

（2）如果没有在本机，修改探针中的配置文件
/opt/skywalking/apache-skywalking-apm-bin/agent/config

最后面加上相关信息

plugin.toolkit.log.grpc.reporter.server_host=${SW_GRPC_LOG_SERVER_HOST:127.0.0.1}
plugin.toolkit.log.grpc.reporter.server_port=${SW_GRPC_LOG_SERVER_PORT:11800}
plugin.toolkit.log.grpc.reporter.max_message_size=${SW_GRPC_LOG_MAX_MESSAGE_SIZE:10485760}
plugin.toolkit.log.grpc.reporter.upstream_timeout=${SW_GRPC_LOG_GRPC_UPSTREAM_TIMEOUT:30}