一、概述
最近在研究skywalking,打算使用k8s部署 skywalking 并将 pod 中的應用接入 skywalking 進行服務鍊路追蹤。這篇文章先不介紹 skywalking 在k8s中的部署和使用,而是先介紹如何使用手動和docker的方式使用 skywalking。在整個實踐過程中查閱了大量文檔,遇到了各種問題,這裡将我自己的實踐過程記錄下來,希望對有同樣需求的小夥伴提供一些幫助。
1、skywalking 簡介
SkyWalking是一款廣受歡迎的國産APM(Application Performance Monitoring,應用性能監控)産品,主要針對微服務、Cloud Native和容器化(Docker、Kubernetes、Mesos)架構的應用。SkyWalking的核心是一個分布式追蹤系統,目前是Apache基金會的頂級項目。
skywalking 的詳細介紹可以檢視官方文檔:skywalking 官網
2、skywalking 架構
從邏輯上講,SkyWalking分為四個部分:探針,平台後端,存儲和UI,如下圖所示:
![](https://img.laitimes.com/img/__Qf2AjLwojIjJCLyojI0JCLicmbw5SY0IWY4Q2NjZmYyYWOxEWYxEmMjZjNzIWZ0EWY5IDMh9CX4EzLcVDMxIDMy8CXn9Gbi9CXzV2Zh1WavwVbvNmLvR3YxUjL1M3Lc9CX6MHc0RHaiojIsJye.png)
- 探針收集資料并重新格式化以符合SkyWalking的要求(不同的探針支援不同的來源)。
- 平台後端支援資料聚合,分析和流處理,涵蓋跟蹤,名額和日志。
- 儲存設備通過開放/可插入的界面存儲SkyWalking資料。您可以選擇現有的實作,例如ElasticSearch,H2,MySQL,TiDB,InfluxDB,或者實作自己的實作。
- UI是一個高度可定制的基于Web的界面,允許SkyWalking最終使用者可視化和管理SkyWalking資料。
3、skywalking 如何自動上報資料
在使用鍊路追蹤控制台追蹤應用的鍊路資料之前,需要通過用戶端将應用資料上報至鍊路追蹤。SkyWalking将Java應用資料上報至鍊路追蹤控制台,首先需要完成埋點工作。SkyWalking既支援自動探針(Dubbo、gRPC、JDBC、OkHttp、Spring、Tomcat、Struts、Jedis等),也支援手動埋點(OpenTracing)。本文介紹自動埋點方法。
skywalking 上報資料的原理如下圖所示:
二、使用 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,可以看...
三、手動将 spring boot 接入 skywalking
1、下載下傳 skywalking agent
skywalking 官網下載下傳位址:http://skywalking.apache.org/downloads/
我這裡下載下傳的是
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目錄的說明如下圖:
2、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 控制台,并沒有資料,因為需要先通路接口,才會上報資料到控制台,通過不斷的調用測試接口,再次檢視控制台可以看到我們的調用情況,如下圖所示:
四、使用 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 官方文檔:
http://skywalking.apache.org/docs/main/latest/en/concepts-and-designs/overview/
Apache SkyWalking Docker Files:
https://github.com/apache/skywalking-docker
通過SkyWalking上報Java應用資料:
https://help.aliyun.com/document_detail/104185.html