示例Demo

示例代碼倉(cāng)庫(kù)地址：SkyWalking Demo

用SkyWalking為Java應(yīng)用自動(dòng)埋點(diǎn)

1. 打開config/agent.config，配置接入點(diǎn)和令牌。

   說明

   請(qǐng)將<endpoint>和<auth-token>分別替換成控制臺(tái)集群配置 > 接入點(diǎn)信息頁(yè)面上SkyWalking客戶端在相應(yīng)地域的接入點(diǎn)和鑒權(quán)令牌。關(guān)于獲取方法，請(qǐng)參見前提條件。

   collector.backend_service=<endpoint>
   agent.authentication=<auth-token>

2. 采用以下方法之一配置應(yīng)用名稱（Service Name）。

   重要

   請(qǐng)將<ServiceName>替換為您的應(yīng)用名稱。如果同時(shí)采用以下兩種方法，則僅第二種方法（在啟動(dòng)命令行中添加參數(shù)）生效。

   • 打開config/agent.config，配置應(yīng)用名稱。

     agent.service_name=<ServiceName>

   • 在應(yīng)用程序的啟動(dòng)命令行中添加-Dskywalking.agent.service_name參數(shù)。

     java -javaagent:<skywalking-agent-path> -Dskywalking.agent.service_name=<ServiceName> -jar yourApp.jar

3. 根據(jù)應(yīng)用的運(yùn)行環(huán)境，選擇相應(yīng)的方法來指定SkyWalking Agent的路徑。

   說明

   請(qǐng)將以下示例代碼中的<skywalking-agent-path>替換為Agent文件夾中的skywalking-agent.jar的絕對(duì)路徑。

   • Linux Tomcat 7 / Tomcat 8

     在tomcat/bin/catalina.sh第一行添加以下內(nèi)容：

     CATALINA_OPTS="$CATALINA_OPTS -javaagent:<skywalking-agent-path>"; export CATALINA_OPTS

   • Windows Tomcat 7 / Tomcat 8

     在tomcat/bin/catalina.bat第一行添加以下內(nèi)容：

     set "CATALINA_OPTS=-javaagent:<skywalking-agent-path>"

   • JAR File或Spring Boot

     在應(yīng)用程序的啟動(dòng)命令行中添加-javaagent參數(shù)。

     重要

     -javaagent參數(shù)一定要在-jar參數(shù)之前。

     java -javaagent:<skywalking-agent-path> -jar yourApp.jar

   • Jetty

     在{JETTY_HOME}/start.ini配置文件中添加以下內(nèi)容：

     --exec    # 去掉前面的井號(hào)取消注釋。
     -javaagent:<skywalking-agent-path>

4. 重新啟動(dòng)應(yīng)用。

Java Agent可配置屬性

SkyWalking Java Agent支持豐富的用戶可配置屬性。完整的屬性配置詳情，請(qǐng)參見示例Demo的config/agent.config文件。

屬性列表（部分）

以下屬性以apache-skywalking-java-agent-8.16.0為準(zhǔn)。

配置方式

系統(tǒng)屬性

使用-Dskywalking. + agent.config配置文件的key。例如：

# 通過系統(tǒng)屬性配置agent.service_name
java -javaagent:/path/to/skywalking-agent.jar -Dskywalking.agent.service_name=<your_service_name> -jar your-project.jar

代理選項(xiàng)

在JVM參數(shù)中的代理路徑之后添加屬性即可。

# 模板
-javaagent:/path/to/skywalking-agent.jar=[key1]=[value1],[key2]=[value2]

# 舉例
java -javaagent:/path/to/skywalking-agent.jar=agent.service_name=<your-service-name>,agent.authentication=<your-token> -jar your-project.jar

系統(tǒng)環(huán)境變量

將屬性配置成系統(tǒng)環(huán)境變量，skywalking-agent會(huì)自動(dòng)獲取。可以在config/agent.config文件中查詢具體屬性對(duì)應(yīng)的系統(tǒng)環(huán)境變量，例如agent.service_name的系統(tǒng)環(huán)境變量為SW_AGENT_NAME。

agent.service_name=${SW_AGENT_NAME:default_name}

# 配置環(huán)境變量
export SW_AGENT_NAME=<your_service_name>

優(yōu)先級(jí)

以上配置方式的優(yōu)先級(jí)從高到低依次為代理選項(xiàng)、系統(tǒng)屬性、系統(tǒng)環(huán)境變量、配置文件。

Java Agent插件

SkyWalking Java Agent支持多種中間件、框架和庫(kù)。支持的所有插件可在示例Demo的/plugins文件夾下查看。

激活插件

所有在/plugins文件夾下的插件都是已被激活的插件。若從/plugins中移除某個(gè)插件的jar包，則表示插件不可用。

官方已支持插件

官方支持的插件都已在/plugins文件夾下。

可選插件

Java Agent的插件支持可插拔。在Agent或第三方倉(cāng)庫(kù)的optional-plugins文件夾下提供了可選的插件。 想要使用可選插件，可以將對(duì)應(yīng)插件移動(dòng)到/plugins文件夾下。

Bootstrap類插件

由于意外風(fēng)險(xiǎn)，所有Bootstrap插件都是可選的。Bootstrap插件在bootstrap-plugins文件夾中。若需要使用這些插件，可以將目標(biāo)插件的jar文件放入/plugins文件夾下。

支持插件列表

關(guān)于下面的插件，官方認(rèn)為可能存在性能影響或者使用限制，所以只在第三方倉(cāng)庫(kù)發(fā)布。更多信息請(qǐng)參見SkyAPM Java插件擴(kuò)展倉(cāng)庫(kù)。

插件開發(fā)

您可以參考官方文檔自定義開發(fā)一個(gè)SkyWalking Java Agent Plugin。

可觀測(cè)鏈路 OpenTelemetry 版支持Trace上報(bào)，您可以參考官方文檔開發(fā)一個(gè)自定義的Trace Plugin。

常見問題

問：SkyWalking正常連接服務(wù)端后，無法創(chuàng)建應(yīng)用？

如果未產(chǎn)生數(shù)據(jù)上報(bào)，則可能原因是：開啟采樣、設(shè)置過濾或未觸發(fā)生成鏈路追蹤的請(qǐng)求。