链路追踪系统Skywalking接入说明

应用修改

引入依赖

目的是实现手动获取链路信息、链路信息日志记录等扩展功能。

   <properties>
     <skywalking.version>8.14.0</skywalking.version>
   </properties> 

  <dependencies>
    <!-- 省略其他依赖 -->
    <dependency>
      <groupId>org.apache.skywalking</groupId>
      <artifactId>apm-toolkit-logback-1.x</artifactId>
      <version>${skywalking.version}</version>
    </dependency>
    <dependency>
       <groupId>org.apache.skywalking</groupId>
       <artifactId>apm-toolkit-trace</artifactId>
       <version>${skywalking.version}</version>
    </dependency>
  </dependencies>

日志模板

修改logback配置文件,以实现将traceIdspanId(segmentId)输出到日志。

  1. LOG_PATTERN

    <property name="LOG_PATTERN" value=
                "|%d{yyyy-MM-dd HH:mm:ss.SSS}|%-5level|%replace(%X{tid}){'TID:',''}|%replace(%X{sw_ctx}){'(([\\w\\[\\-\\.:@/]*,){3})|(,-?\\d+\\])',''}|${APP_NAME}|%t|%C|%M|%L|%m%n"/>
    

    log4j2与logback的replace函数有细微差别,如有需要可查阅log4j2文档

  2. appender.encoder

            <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
                <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                    <Pattern>${LOG_PATTERN}</Pattern>
                </layout>
                <charset>UTF-8</charset>
            </encoder>
    

注意事项

  1. 链路信息跨线程解决方案
    默认情况下,链路信息只能在线程内传递,如果应用代码中有跨线程逻辑,需要手动处理:

    • usage 1

          @TraceCrossThread
          public static class MyCallable<String> implements Callable<String> {
              @Override
              public String call() throws Exception {
                  return null;
              }
          }
          ExecutorService executorService = Executors.newFixedThreadPool(1);
          executorService.submit(new MyCallable());
      
    • usage 2

          @TraceCrossThread
          public static class MyRunnable implements Runnable {
      
              @Override
              public void run() {
                // TODO
              }
          }
          ExecutorService executorService = Executors.newFixedThreadPool(1);
          executorService.submit(new MyRunnable());
      
    • usage 3

          ExecutorService executorService = Executors.newFixedThreadPool(1);
          executorService.submit(CallableWrapper.of(new Callable<String>() {
              @Override public String call() throws Exception {
                  return null;
              }
          }));
      
    • usage 4

          ExecutorService executorService = Executors.newFixedThreadPool(1);
          executorService.execute(RunnableWrapper.of(new Runnable() {
              @Override public void run() {
                  //TODO
              }
          }));
      
    • usage 5

          CompletableFuture.supplyAsync(SupplierWrapper.of(() -> {
              return "SupplierWrapper";
          })).thenApplyAsync(FunctionWrapper.of(f -> {
              return "FunctionWrapper";
          })).thenAcceptAsync(ConsumerWrapper.of(c -> {
              System.out.println("ConsumerWrapper");
          }));
      
  2. 在程序中手动获取链路信息

    String traceId = TraceContext.traceId();
    String segmentId = TraceContext.segmentId();
    String spanId = TraceContext.spanId();
    

部署修改

Dockerfile

一般应用

修改FROM基础镜像并修改WORKDIR,示例:

FROM apache/skywalking-java-agent:8.14.0-java11
MAINTAINER lms lmstech@163.com

RUN /bin/cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \&& echo 'Asia/Shanghai' >/etc/timezone

WORKDIR /
ADD target/analysis-boot.jar analysis-boot.jar

ENTRYPOINT ["java", "-Xmx98m", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/analysis-boot.jar"]

EXPOSE 8806

spring-cloud-gateway

skywalking-java-agent以插件的形式提供对不同框架的支持,而spring-cloud-gatewayspring-webflux插件是可选插件,需要手动引入。示例:

FROM apache/skywalking-java-agent:8.14.0-java11
MAINTAINER lms lmstech@163.com

RUN cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \&& echo 'Asia/Shanghai' >/etc/timezone
# 添加网关所需插件
RUN cp /skywalking/agent/optional-plugins/apm-spring-cloud-gateway-3.x-plugin-8.14.0.jar /skywalking/agent/plugins/
RUN cp /skywalking/agent/optional-plugins/apm-spring-webflux-5.x-plugin-8.14.0.jar /skywalking/agent/plugins/

WORKDIR /
ADD target/lms-gateway.jar lms-gateway.jar

ENTRYPOINT ["java", "-Xmx98m", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/lms-gateway.jar"]

EXPOSE 9999

部署脚本

docker

至少需要添加以下三个配置项,以环境变量形式注入:

配置项 说明 推荐配置
SW_AGENT_NAME 服务名称,格式为<group name>::<logic name> 项目名称::应用名词,如: lms::alarm-sender
SW_AGENT_INSTANCE_NAME 实例(节点)名称 应用名词@部署地址,如: alarm-sender@192.168.0.1
SW_AGENT_COLLECTOR_BACKEND_SERVICES skywalking后端地址 ip:port

更多配置项参考官方文档

示例:

docker run -d -p 8806:8806 -e SW_AGENT_NAME=lms::analysis -e SW_AGENT_INSTANCE_NAME=analysis@192.168.0.1 -e SW_AGENT_COLLECTOR_BACKEND_SERVICES=114.252.40.238:11800 lms-anlysis:latest

docker-compose

示例:

version: '3.1'
services:
  analysis:
 build:
   context: ./
   dockerfile: Dockerfile
 image: analysis:latest
 container_name: lms-analysis
 ports:
   - 8806:8806
 volumes:
   - /app/logs/analysis:/logs
 environment:
   - SW_AGENT_NAME=lms::analysis
   - SW_AGENT_INSTANCE_NAME=analysis@192.168.0.1
   - SW_AGENT_COLLECTOR_BACKEND_SERVICES=114.252.40.238:11800
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容