使用 docker 部署 spring boot 並接入 skywalking

1、概述

最近在研究skywalking，打算使用k8s部署 skywalking 並將 pod 中的應用接入 skywalking 進行服務鏈路追蹤。這篇文章先不介紹 skywalking 在k8s中的部署和使用，而是先介紹如何使用手動和docker的方式使用 skywalking。在整個實踐過程當中查閱了大量文檔，遇到了各類問題，這裏將我本身的實踐過程記錄下來，但願對有一樣需求的小夥伴提供一些幫助。

一、skywalking 簡介

SkyWalking是一款廣受歡迎的國產APM（Application Performance Monitoring，應用性能監控）產品，主要針對微服務、Cloud Native和容器化（Docker、Kubernetes、Mesos）架構的應用。SkyWalking的核心是一個分佈式追蹤系統，目前是Apache基金會的頂級項目。

skywalking 的詳細介紹能夠查看官方文檔： skywalking 官網

二、skywalking 架構

從邏輯上講，SkyWalking分爲四個部分：探針，平臺後端，存儲和UI，以下圖所示：

• 探針收集數據並從新格式化以符合SkyWalking的要求（不一樣的探針支持不一樣的來源）。
• 平臺後端支持數據聚合，分析和流處理，涵蓋跟蹤，指標和日誌。
• 存儲設備經過開放/可插入的界面存儲SkyWalking數據。您能夠選擇現有的實現，例如ElasticSearch，H2，MySQL，TiDB，InfluxDB，或者實現本身的實現。
• UI是一個高度可定製的基於Web的界面，容許SkyWalking最終用戶可視化和管理SkyWalking數據。

三、skywalking 如何自動上報數據

在使用鏈路追蹤控制檯追蹤應用的鏈路數據以前，須要經過客戶端將應用數據上報至鏈路追蹤。SkyWalking將Java應用數據上報至鏈路追蹤控制檯，首先須要完成埋點工做。SkyWalking既支持自動探針（Dubbo、gRPC、JDBC、OkHttp、Spring、Tomcat、Struts、Jedis等），也支持手動埋點（OpenTracing）。本文介紹自動埋點方法。

skywalking 上報數據的原理以下圖所示：

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

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

yum install -y docker-compose

使用下面的命令建立 skywalking-docker-compose.yaml 文件：

vim skywalking-docker-compose.yaml

這裏啓動一個 standlone 容器，默認使用 H2 存儲數據，如需其餘存儲能夠查看官方文檔進行設置。
skywalking-docker-compose.yaml 文件內容以下：

version: '3'
services:
  oap:
    image: apache/skywalking-oap-server:8.4.0-es6
    container_name: oap
    restart: always
    ports:
      - 11800:11800 # agent 上報數據的端口，這是 gRPC 端口
      - 12800:12800 # ui 讀取數據的端口， 這是 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

使用下面的命令啓動skywalking：

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

使用下面的命令查看啓動日誌：

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

啓動成功後，訪問：http://localhost:8088，能夠看...

3、手動將 spring boot 接入 skywalking

一、下載 skywalking agent

skywalking 官網下載地址： http://skywalking.apache.org/...

我這裏下載的是 apache-skywalking-apm-8.4.0.tar.gz，在linux系統中也能夠經過下面的命令下載並解壓：

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

解壓後的目錄結構以下圖：

agent目錄的說明以下圖：

二、spring boot 項目自動上報數據

要上報spring boot項目的數據須要配置 skywalking 的接入點和服務名，能夠經過下面的方式配置：

修改配置文件

打開前面下載的 agent/config/agent.config文件，找到下面的兩個配置：

# 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}

根據實際狀況進行配置便可，配置修改完成以後，能夠經過下面的命令啓動spring boot 項目：

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

請將<skywalking-agent-path>替換爲Agent文件夾中的skywalking-agent.jar的絕對路徑。
注意 -javaagent參數必定要在 -jar參數以前。

經過命令參數進行配置

服務名能夠在應用程序的啓動命令行中添加-Dskywalking.agent.service_name參數。
skywalking 接入點能夠在應用程序的啓動命令行中添加-Dskywalking.collector.backend_service參數。
完整命令以下：

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

在idea中啓動參數中配置

咱們也能夠在 idea 啓動配置選項的 VM options 中進行以下配置：

配置完成後，啓動項目能夠看到以下信息打印到控制檯：

查看skywalking 控制檯，並無數據，由於須要先訪問接口，纔會上報數據到控制檯，經過不斷的調用測試接口，再次查看控制檯能夠看到咱們的調用狀況，以下圖所示：

4、使用 docker 部署 spring boot 並接入 skywalking

這裏 spring boot 的基礎鏡像選擇 skywalking-base，此鏡像中包含 openjdk11 和 skywalking-agent，詳細的信息能夠參考下面的參考文檔。

spring boot 的 Dockerfile文件內容以下：

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

這裏使用環境變量的方式爲 skywalking 設置自定義參數，環境變量的其餘配置能夠查看 agent/config/agent.config文件。

使用下面的命令構建鏡像：

docker build -t spring-boot-demo .

使用下面的命令啓動鏡像：

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

啓動成功以後能夠訪問測試的地址，到 skywalking 控制檯查看是否有數據上報，若是沒有數據上報，咱們須要查看 skywalking agent 的日誌，能夠在 agent/logs/skywalking-api.log文件中查看報錯信息。

參考文檔

skywalking 官方文檔
Apache SkyWalking Docker Files
經過SkyWalking上報Java應用數據