使用docker部署spring boot并接入skywalking的方法

一、概述

最近在研究skywalking，打算使用k8s部署 skywalking 并將 pod 中的應(yīng)用接入 skywalking 進(jìn)行服務(wù)鏈路追蹤。這篇文章先不介紹 skywalking 在k8s中的部署和使用，而是先介紹如何使用手動(dòng)和docker的方式使用 skywalking。在整個(gè)實(shí)踐過(guò)程中查閱了大量文檔，遇到了各種問(wèn)題，這里將我自己的實(shí)踐過(guò)程記錄下來(lái)，希望對(duì)有同樣需求的小伙伴提供一些幫助。

1、skywalking 簡(jiǎn)介

SkyWalking是一款廣受歡迎的國(guó)產(chǎn)APM（Application Performance Monitoring，應(yīng)用性能監(jiān)控）產(chǎn)品，主要針對(duì)微服務(wù)、Cloud Native和容器化（Docker、Kubernetes、Mesos）架構(gòu)的應(yīng)用。SkyWalking的核心是一個(gè)分布式追蹤系統(tǒng)，目前是Apache基金會(huì)的頂級(jí)項(xiàng)目。

skywalking 的詳細(xì)介紹可以查看官方文檔：skywalking 官網(wǎng)

2、skywalking 架構(gòu)

從邏輯上講，SkyWalking分為四個(gè)部分：探針，平臺(tái)后端，存儲(chǔ)和UI，如下圖所示：

• 探針收集數(shù)據(jù)并重新格式化以符合SkyWalking的要求（不同的探針支持不同的來(lái)源）。
• 平臺(tái)后端支持?jǐn)?shù)據(jù)聚合，分析和流處理，涵蓋跟蹤，指標(biāo)和日志。
• 存儲(chǔ)設(shè)備通過(guò)開(kāi)放/可插入的界面存儲(chǔ)SkyWalking數(shù)據(jù)。您可以選擇現(xiàn)有的實(shí)現(xiàn)，例如ElasticSearch，H2，MySQL，TiDB，InfluxDB，或者實(shí)現(xiàn)自己的實(shí)現(xiàn)。
• UI是一個(gè)高度可定制的基于Web的界面，允許SkyWalking最終用戶可視化和管理SkyWalking數(shù)據(jù)。

 3、skywalking 如何自動(dòng)上報(bào)數(shù)據(jù)

在使用鏈路追蹤控制臺(tái)追蹤應(yīng)用的鏈路數(shù)據(jù)之前，需要通過(guò)客戶端將應(yīng)用數(shù)據(jù)上報(bào)至鏈路追蹤。SkyWalking將Java應(yīng)用數(shù)據(jù)上報(bào)至鏈路追蹤控制臺(tái)，首先需要完成埋點(diǎn)工作。SkyWalking既支持自動(dòng)探針（Dubbo、gRPC、JDBC、OkHttp、Spring、Tomcat、Struts、Jedis等），也支持手動(dòng)埋點(diǎn)（OpenTracing）。本文介紹自動(dòng)埋點(diǎn)方法。

skywalking 上報(bào)數(shù)據(jù)的原理如下圖所示：

二、使用 docker-compose 安裝 skywalking-oap-server 和 skywalking-ui

使用下面的命令在linux中安裝 docker-compose：

yum install -y docker-compose

使用下面的命令創(chuàng)建 skywalking-docker-compose.yaml 文件：

vim skywalking-docker-compose.yaml

這里啟動(dòng)一個(gè) standlone 容器，默認(rèn)使用 H2 存儲(chǔ)數(shù)據(jù)，如需其他存儲(chǔ)可以查看官方文檔進(jìn)行設(shè)置。
skywalking-docker-compose.yaml 文件內(nèi)容如下：

version: '3'
services:
  oap:
    image: apache/skywalking-oap-server:8.4.0-es6
    container_name: oap
    restart: always
    ports:
      - 11800:11800 # agent 上報(bào)數(shù)據(jù)的端口，這是 gRPC 端口
      - 12800:12800 # ui 讀取數(shù)據(jù)的端口， 這是 http 端口
  skywaling-ui:
    image: apache/skywalking-ui:8.4.0
    container_name: ui
    depends_on:
      - oap
    links:
      - oap
    ports:
      - 8088:8080
    environment:
      - SW_OAP_ADDRESS=oap:12800

使用下面的命令啟動(dòng)skywalking：

docker-compose -f skywalking-docker-compose.yaml up -d

使用下面的命令查看啟動(dòng)日志：

docker-compose -f skywalking-docker-compose.yaml logs -f 

啟動(dòng)成功后，訪問(wèn)：http://localhost:8088，可以看到如下界面：

三、手動(dòng)將 spring boot 接入 skywalking

1、下載 skywalking agent

skywalking 官網(wǎng)下載地址：http://skywalking.apache.org/downloads/

我這里下載的是 apache-skywalking-apm-8.4.0.tar.gz，在linux系統(tǒng)中也可以通過(guò)下面的命令下載并解壓：

wget https://archive.apache.org/dist/skywalking/8.4.0/apache-skywalking-apm-8.4.0.tar.gz

tar -zxvf apache-skywalking-apm-8.4.0.tar.gz

解壓后的目錄結(jié)構(gòu)如下圖：

agent目錄的說(shuō)明如下圖：

2、spring boot 項(xiàng)目自動(dòng)上報(bào)數(shù)據(jù)

要上報(bào)spring boot項(xiàng)目的數(shù)據(jù)需要配置 skywalking 的接入點(diǎn)和服務(wù)名，可以通過(guò)下面的方式配置：

修改配置文件

打開(kāi)前面下載的 agent/config/agent.config文件，找到下面的兩個(gè)配置：

# The service name in UI
agent.service_name=${SW_AGENT_NAME:Your_ApplicationName}

# Backend service addresses.
collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:11800}

根據(jù)實(shí)際情況進(jìn)行配置即可，配置修改完成之后，可以通過(guò)下面的命令啟動(dòng)spring boot 項(xiàng)目：

java -javaagent:<skywalking-agent-path> -jar spring-boot-demo

請(qǐng)將替換為Agent文件夾中的skywalking-agent.jar的絕對(duì)路徑。
注意 -javaagent參數(shù)一定要在-jar參數(shù)之前。

通過(guò)命令參數(shù)進(jìn)行配置

服務(wù)名可以在應(yīng)用程序的啟動(dòng)命令行中添加-Dskywalking.agent.service_name參數(shù)。
skywalking 接入點(diǎn)可以在應(yīng)用程序的啟動(dòng)命令行中添加-Dskywalking.collector.backend_service參數(shù)。
完整命令如下：

java -javaagent:<skywalking-agent-path> -Dskywalking.agent.service_name=<ServiceName> -Dskywalking.collector.backend_service=<backend-service-addresses>  -jar yourApp.jar

在idea中啟動(dòng)參數(shù)中配置

我們也可以在 idea 啟動(dòng)配置選項(xiàng)的 VM options 中進(jìn)行如下配置：

配置完成后，啟動(dòng)項(xiàng)目可以看到如下信息打印到控制臺(tái)：

查看skywalking 控制臺(tái)，并沒(méi)有數(shù)據(jù)，因?yàn)樾枰仍L問(wèn)接口，才會(huì)上報(bào)數(shù)據(jù)到控制臺(tái)，通過(guò)不斷的調(diào)用測(cè)試接口，再次查看控制臺(tái)可以看到我們的調(diào)用情況，如下圖所示：

四、使用 docker 部署 spring boot 并接入 skywalking

這里 spring boot 的基礎(chǔ)鏡像選擇 skywalking-base，此鏡像中包含 openjdk11 和 skywalking-agent，詳細(xì)的信息可以參考下面的參考文檔。

spring boot 的 Dockerfile文件內(nèi)容如下：

FROM apache/skywalking-base:8.4.0-es6
WORKDIR /app
COPY target/spring-demo-0.0.1-SNAPSHOT.jar spring-demo-0.0.1-SNAPSHOT.jar
ENV SW_AGENT_COLLECTOR_BACKEND_SERVICES="127.0.0.1:11800" \

    SW_AGENT_NAME="my-spring-demo-test-adfasdf"


CMD java -javaagent:/skywalking/agent/skywalking-agent.jar \

         -jar spring-demo-0.0.1-SNAPSHOT.jar

這里使用環(huán)境變量的方式為 skywalking 設(shè)置自定義參數(shù)，環(huán)境變量的其他配置可以查看 agent/config/agent.config文件。

使用下面的命令構(gòu)建鏡像：

docker build -t spring-boot-demo .

使用下面的命令啟動(dòng)鏡像：

docker run --rm -p 8080:8080 spring-boot-demo

啟動(dòng)成功之后可以訪問(wèn)測(cè)試的地址，到 skywalking 控制臺(tái)查看是否有數(shù)據(jù)上報(bào)，如果沒(méi)有數(shù)據(jù)上報(bào)，我們需要查看 skywalking agent 的日志，可以在 agent/logs/skywalking-api.log文件中查看報(bào)錯(cuò)信息。

參考文檔

skywalking 官方文檔
Apache SkyWalking Docker Files
通過(guò)SkyWalking上報(bào)Java應(yīng)用數(shù)據(jù)

到此這篇關(guān)于使用docker部署spring boot并接入skywalking的文章就介紹到這了,更多相關(guān)docker部署spring boot接入skywalking內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！