快速接入Agent
前提條件
部署APM Agent時,必須確保接入APM的機器與APM服務網絡連通,Agent才能正常工作。
操作步驟
步驟 1 在左側導航欄中選擇“應用監控 > 應用列表”。
步驟 2 單擊“接入應用”,進入接入應用頁面。
圖 接入應用


步驟 3 選擇“區域”和“應用”。
圖 基礎信息


步驟 4 “后端語言”選擇Java。
步驟 5 根據應用類型選擇接入對應的接入方式,按照步驟接入。
圖 數據接入


表 參數說明
| 參數 | 說明 | 是否必填 |
|---|---|---|
| pwd | apm-javaagent.jar包所在路徑。 | 必填 |
| appName | 組件名稱,代表一個組件,一個組件可以包含多個環境。不能重復,如果要重復,使用instanceName區分。 | 必填 |
| env | 環境名稱,代表一個應用在一個地方的部署。一個應用程序根據配置不同可以部署多個環境,比如測試環境,現網環境。每個環境都在一個region部署,具有唯一的region屬性。該參數可以為空,代表默認環境。 | 選填 |
| envTag | 環境標簽,主要用于環境過濾,多個環境打上相同的環境標簽,在web頁面上可以通過標簽將這些環境過濾出來。該參數可以為空。 | 選填 |
| business | 應用英文名稱,為全局概念。如果填寫,則必須提前創建該應用。如果為空,則代表默認應用(開通APM時系統會自動創建一個默認應用)。 | 選填 |
| subBusiness | 子應用,為全局概念,在應用下面子文件夾。該參數可以為空,為空代表資源掛載在根應用下面,子應用最多支持三層。比如a/b/c,a、b、c各代表一層。 | 選填 |
| instanceName | 默認為空。當一個應用在機器上部署多個實例,可以通過instanceName來區分,比如7001或者8001兩個端口實例。這種實際情況下很少發生,一臺機器部署多個java實例往往是不同的應用程序,相同應用程序的部署兩個實例很少見。 | 選填 |
為JAVA應用手工安裝Agent
前提條件
- 部署APM Agent時,必須確保接入APM的機器與APM服務網絡連通,Agent才能正常工作。
- 可使用Telnet命令測試目標機器與APM服務器網絡是否連通。
- 選擇“系統管理 > 訪問密鑰”進入訪問密鑰頁面,查看獲取接入javaagent所需的AK/SK。
圖 獲取AK/SK


操作步驟
步驟 1 下載JavaAgent,參考JavaAgent下載地址下載apm-javaagent-x.x.x.zip,并將javaagent下載到需要接入APM機器的任意目錄。
示例命令:
curl -O //xxx/apm-javaagent-x.x.x.tar
步驟 2 執行tar命令解壓javaagent。
示例命令:
tar -xvf apm-javaagent-x.x.x.tar
步驟 3 修改javaagent中的apm.config配置文件。master.address配置請參見接入地址master.address配置,將AK/SK寫入配置文件中,如下圖所示。
圖 寫入AK/SK


步驟 4 修改java進程啟動腳本。
在服務啟動腳本的java命令之后,配置apm-javaagent.jar包所在路徑,并指定java進程的組件名。
添加-javaagent參數示例:
java -javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName={appName}
當企業業務很多的情況下,也支持更為復雜一些的配置,添加-javaagent參數的復雜模式如:
java -javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName=myApp,env=myEnv,envTag=myTag,business=myBusiness,subBusiness=mySub
說明
由于歷史原因,APM啟動參數設置的元數據,跟CMDB概念有一些沖突,這里進行說明。
啟動參數一般會設置 -javaagent:D:\javaagent-package\apm-javaagent\apm-javaagent.jar=appName=xxx,env=yyy,business=zzz,subBusiness=sss,envTag=xxx,在這里appName代表組件,business代表應用,subBusiness代表子應用,envTag代表環境標簽。
如果沒有在web界面對business參數進行設置,啟動javaagent時系統就會報錯;其他參數如果沒有設置,在啟動javaagent時會自動創建出來,包括子應用、組件、環境及環境標簽等。
步驟 5 重啟應用。
為部署在CCE容器中的JAVA應用安裝Agent
前提條件
- 部署APM Agent時,必須確保接入APM的機器與APM服務網絡連通,Agent才能正常工作。
可使用Telnet命令測試目標機器與APM服務器網絡是否連通。
- 訪問域名(Endpoint)列表,獲取所在region的endpoint。
- 選擇“系統管理 > 訪問密鑰”進入訪問密鑰頁面,查看獲取接入javaagent所需的AK/SK。
圖 獲取AK/SK


使用說明
目前只支持部署CCE的JAVA應用。相關參數說明參見下表。
表 性能管理配置參數列表
| 參數名稱 | 參數說明 |
|---|---|
| 安裝探針 | 選擇安裝探針。目前只支持“APM探針”。 |
| 探針類型 | 選擇探針的版本類型。 |
| 探針升級策略 | 探針升級的方式、策略。默認為“重啟自動升級”。 重啟自動升級:每次都嘗試重新下載鏡像。 重啟手動升級:如果本地有該鏡像,則使用本地鏡像,本地不存在時下載鏡像。 |
| APM環境 | 輸入APM環境名稱,該參數為選填。 |
| APM業務 | 選擇一個已有的APM應用。 |
| 子業務 | 輸入APM子應用,該參數為選填。 |
| 接入密鑰 | 將會自動獲取APM服務的密鑰信息。 |
操作步驟
步驟 1 登錄CCE管理控制臺,在左側導航欄中選擇“工作負載 > 無狀態負載 Deployment”或“工作負載 > 有狀態負載 StatefulSet”,單擊“創建無狀態工作負載”或“創建有狀態工作負載”。
步驟 2 在創建工作負載時,在“高級設置”中找到“性能管理配置”,在“安裝探針”處勾選“APM探針”,將會啟用應用性能管理服務并在節點上安裝探針。
說明安裝探針會產生少量資源消耗,主要作用是可對java工作負載提供應用調用鏈、拓撲、SQL分析、堆棧追蹤等監控能力。
步驟 3 填寫探針相關參數。
- 監控組:輸入監控組名稱,如testapp。若已有監控組,可下拉選擇。
- 探針版本:選擇探針的版本。
- “探針升級策略”,默認為“重啟自動升級”。
- 重啟自動升級:每次都嘗試重新下載鏡像。
- 手動升級:如果本地有該鏡像,則使用本地鏡像,本地不存在時下載鏡像。
步驟 4 應用啟動后,等待約3分鐘,應用數據就會呈現在APM界面中,此時登錄APM,您可以在APM上通過拓撲、調用鏈等進行應用性能優化。
為CodeArts Deploy應用安裝Agent
前提條件
部署APM Agent時,必須確保接入APM的機器與APM服務網絡連通,Agent才能正常工作。
可使用Telnet命令測試目標機器與APM服務器網絡是否連通。
操作步驟
步驟 1 在左側導航欄中選擇“應用監控 > 應用列表”。
步驟 2 單擊“接入應用”,進入接入應用頁面。
圖 接入應用


步驟 3 選擇“區域”和“應用”。
圖 基礎信息


步驟 4 “后端語言”選擇Java。
步驟 5 根據應用類型選擇接入對應的接入方式,按照步驟接入。
圖 數據接入


表 參數說明
| 參數 | 說明 | 是否必填 |
|---|---|---|
| pwd | apm-javaagent.jar包所在路徑。 | 必填 |
| appName | 組件名稱,代表一個組件,一個組件可以包含多個環境。不能重復,如果要重復,使用instanceName區分。 | 必填 |
| env | 環境名稱,代表一個應用在一個地方的部署。一個應用程序根據配置不同可以部署多個環境,比如測試環境,現網環境。每個環境都在一個region部署,具有唯一的region屬性。該參數可以為空,代表默認環境。 | 選填 |
| envTag | 環境標簽,主要用于環境過濾,多個環境打上相同的環境標簽,在web頁面上可以通過標簽將這些環境過濾出來。該參數可以為空。 | 選填 |
| business | 應用英文名稱,為全局概念。如果填寫,則必須提前創建該應用。如果為空,則代表默認應用(開通APM時系統會自動創建一個默認應用)。 | 選填 |
| subBusiness | 子應用,為全局概念,在應用下面子文件夾。該參數可以為空,為空代表資源掛載在根應用下面,子應用最多支持三層。比如a/b/c,a、b、c各代表一層。 | 選填 |
| instanceName | 默認為空。當一個應用在機器上部署多個實例,可以通過instanceName來區分,比如7001或者8001兩個端口實例。這種實際情況下很少發生,一臺機器部署多個java實例往往是不同的應用程序,相同應用程序的部署兩個實例很少見。 | 選填 |
步驟 6 進入CodeArts Deploy部署任務,編輯部署步驟,新增執行shell命令,將復制安裝JavaAgent中的命令加入進去。
步驟 7 修改部署步驟,復制啟動參數,并將該參數添加到服務啟動腳本的java命令中。
步驟 8 重啟應用。