PDF
Download PDF
Download page エージェントのアップグレードとロールバック.
エージェントのアップグレードとロールバック
このページでは、エージェントをアップグレードおよびロールバックする方法について説明します。エージェントをアップグレードおよびロールバックするには、systemID を確認し、アップグレードするエージェントのタイプを確認し、使用可能なエージェントのバージョンを確認します。systemID は、エージェント インストーラ システムを識別する識別子です。この機能は、API を使用する場合にのみ使用できます。詳細については、Agent Installer Platform Service APIを参照してください。
パージしてから、新しいバージョンのエージェント インストーラ プラットフォームをインストールします。
サポートされるバージョン
| バージョン | 説明 |
|---|---|
| 21.10.0 以降 | Java Agent Legacy およびマシンエージェント（Linux）では、アップグレードとロールバックがサポートされています。 |
| 22.5.0 以降 |
|
カスタムエージェント構成
アップグレードおよびロールバックのプロセス中は、次のカスタム構成が保持されます。
path: <zero agent path>/java/javaagent/ver
*
*
*/conf/
*.xml
CODE
path: <zero agent path>/zeroagent/agents/machineagent/conf/logging/log4j.xml
path: <zero agent path>/zeroagent/agents/machineagent/conf/controller-info.xml
path: <zero agent path>/zeroagent/agents/machineagent/monitors
CODE
マシンエージェント構成の詳細については、「マシンエージェントの構成」を参照してください。
システム情報の確認
エージェントインストーラでインストールされているすべてのシステムを確認します。この API は、1 つのアカウント下に存在するすべての systemIDs と hostnames を提供します。この API は、エージェントインストーラをロールバックするために使用される以前のバージョンのモニタリングエージェントも提供します。
形式:
GET /maintenance/systemInfos
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/systemInfos' --header 'Authorization: Bearer {AuthToken}'
CODE
応答の例：
{
"total": 2,
"items": [
{
"systemId": "1cbcfd90-95ab-4366-b614-1bfab44a9305",
"hostname": "jboss_host",
"applicationName": "HelloWorld",
"rootInstall": true,
"curVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"prevVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
]
},
{
"systemId": "c44f978d-8db6-452f-9387-9b852d8df03a",
"hostname": "windows_host",
"applicationName": "HelloWorld",
"rootInstall": true,
"versions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.3.0.3296"
}
],
"prevVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.1.0.3252"
}
]
}
]
}
CODE
エージェントバージョンの確認
エージェントのバージョンを見つけるには、「エージェントバージョンの確認」を参照してください。
エージェントバージョンのアップグレード
これで systemIDs、hostname、および最新バージョンが用意できたので、API を使用してアップグレードをトリガーします。リクエストが受け入れられると、maintenanceID を受け取ります。アップグレードは非同期で行われ、maintenanceID を使用してアップグレードの進行状況を追跡できます。
構成の指定はオプションです。何も追加しない場合、エージェントインストーラで現在実行されている構成が使用されます。Java Agent Legacy から Java Agent JKD8+ にアップグレードできますが、Java Agent JDK8+ から Java Agent Legacy にアップグレードすることはできません。
形式：
POST /maintenance/upgrade/systems
CODE
要求の例：
{
"systemDetails": [
{
"systemId": "28f7a681-6010-4150-8940-ebee25841215",
"hostname": "hostname1"
},
{
"systemId": "28f7a681-6010-4150-8940-ebee25841216",
"hostname": "hostname2"
}
],
"versions": [
{
"type": "JDK8_PLUS",
"version": "22.4.0.33722"
},
{
"type": "MACHINE",
"version": "22.4.0.3344"
}
],
"configurations": {
"enableOtel": true,
"otelProperties": {
"tracesExporter": "otlp,logging",
"metricsExporter": "otlp,logging",
"otlpEndpoint": "http://localhost:4317"
},
"enableSim": true
}
}
CODE
{
"systemDetails": [
{
"systemId": "c44f978d-8db6-452f-9387-9b852d8df03a",
"hostname": "windows_host"
}
],
"versions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"configurations": {
"enableSim": true,
"dotnetCompaibility": true
}
}
CODE
入力パラメータ：
Parameter Name | Parameter Type | Description | 必須 |
|---|---|---|---|
| 本文 | エージェント インストーラ システムの | はい |
| エージェント インストーラ システムの | ||
| モニタリングエージェントの | ||
| アップグレードするモニタリングエージェントの | ||
configurations.enableOtel | Java Agent JDK8+ の OpenTelementry を有効にするための構成。 | いいえ | |
configurations.otelProperties | OpenTelemetry エクスポータの構成。 | はい、 | |
configurations.otelProperties.tracesExporter | OpenTelemetry トレースエクスポータの構成。サポートされる値：otlp、logging。 | ||
configurations.otelProperties.metricsExporter | OpenTelemetry メトリックエクスポータの構成。サポートされる値：otlp、logging。 | ||
configurations.otelProperties.otlpEndpoint | OpenTelemetry OTLP Collector エンドポイントの構成。 | ||
configurations.enableSim | マシンエージェントでサーバーの可視性を有効にするための構成。 | 対象外 | |
configurations.dotnetCompatibility | マシンエージェントで .NET 互換モードを有効にするための構成。 | いいえ |
応答例：
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fc",
"operation": "UPGRADE",
"status": "PENDING",
"startedAt": "2022-05-06T17:46:04.743Z",
"updatedAt": "2022-05-06T17:46:04.743Z",
"applicationName": null,
"maintAgentVersions": [
{
"type": "JDK8_PLUS",
"version": "22.4.0.33722"
},
{
"type": "MACHINE",
"version": "22.4.0.3344"
}
],
"affectedSystemIds": [
"28f7a681-6010-4150-8940-ebee25841215",
"28f7a681-6010-4150-8940-ebee25841216"
],
"username": "demo_user",
"configurations": {
"enableOtel": true,
"otelProperties": {
"tracesExporter": "otlp,logging",
"metricsExporter": "otlp,logging",
"otlpEndpoint": "http://localhost:4317"
},
"enableSim": true,
"dotnetCompatibility": null
}
}
CODE
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fd",
"operation": "UPGRADE",
"status": "PENDING",
"startedAt": "2022-05-11T17:46:04.743Z",
"updatedAt": "2022-05-11T17:46:04.743Z",
"applicationName": null,
"maintAgentVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"affectedSystemIds": [
"c44f978d-8db6-452f-9387-9b852d8df03a"
],
"username": "demo_user",
"configurations": {
"enableSim": true,
"dotnetCompatibility": true
}
}
CODE
アップグレードのロールバック
アップグレードをロールバックするには、systemIDs、hostname、および以前のバージョンを使用して以下の API をトリガーします。リクエストが受け入れられると、maintenanceID を含む応答を受け取ります。
ロールバックは非同期に発生し、
maintenanceID を使用します。ロールバックは構成入力を受け入れません。エージェントインストーラで以前に実行されていた構成が使用されます。
形式：
POST /maintenance/rollback/systems
CODE
要求の例：
curl --location --request POST 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/rollback/systems' \
--header 'Authorization: Bearer {AuthToken}' \
--header 'Content-Type: application/json' \
--data-raw
{
"systemDetails": [
{
"systemId": "28f7a681-6010-4150-8940-ebee25841215",
"hostname": "hostname1"
},
{
"systemId": "28f7a681-6010-4150-8940-ebee25841216",
"hostname": "hostname2"
}
],
"versions": [
{
"type": "JAVA",
"version": "21.7.0.32930"
}
]
}
CODE
curl --location --request POST 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/rollback/systems' \
--header 'Authorization: Bearer {AuthToken}' \
--header 'Content-Type: application/json' \
--data-raw
{
"systemDetails": [
{
"systemId": "c44f978d-8db6-452f-9387-9b852d8df03a",
"hostname": "windows_host"
}
],
"versions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.1.0.3252"
}
]
}
CODE
入力パラメータ：
Parameter Name | Parameter Type | Description | 必須 |
|---|---|---|---|
| 本体 | エージェント インストーラ システムの | 対応 |
| エージェント インストーラ システムの | ||
| モニタリングエージェントの | ||
| ロールバックするモニタリングエージェントの以前の v |
応答例：
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fc",
"operation": "ROLLBACK",
"status": "PENDING",
"startedAt": "2021-10-25T18:19:28.607Z",
"updatedAt": "2021-10-25T18:19:28.607Z",
"maintAgentVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"affectedSystemIds": [
"d601aacc-97a4-479e-b2b3-db095fef34fc"
]
}
CODE
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fd",
"operation": "ROLLBACK",
"status": "PENDING",
"startedAt": "2022-05-12T18:19:28.607Z",
"updatedAt": "2022-05-12T18:19:28.607Z",
"maintAgentVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.1.0.3252"
}
],
"affectedSystemIds": [
"c44f978d-8db6-452f-9387-9b852d8df03a"
]
}
CODE
すべてのメンテナンスリクエスト履歴の取得
この API を使用して、アップグレードとロールバックのリクエスト履歴全体を取得します。この履歴は、個々のシステムのステータスではなく、全体的な maintenance ステータスを提供します。
形式：
GET /maintenance/history
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/history' --header 'Authorization: Bearer {AuthToken}'
CODE
応答の例：
{
"total": 2,
"items": [
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fc",
"operation": "UPGRADE",
"status": "PENDING",
"startedAt": "2021-10-25T18:20:55.196Z",
"updatedAt": "2021-10-25T18:20:55.196Z",
"maintAgentVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"affectedSystemIds": [
"d601aacc-97a4-479e-b2b3-db095fef34fc"
],
"failedSystemMaintenanceIds": [
"d601aacc-97a4-479e-b2b3-db095fef34fc"
]
},
{
"maintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fd",
"operation": "UPGRADE",
"status": "SUCEEDED",
"startedAt": "2022-05-11T18:20:55.196Z",
"updatedAt": "2022-05-11T18:20:55.196Z",
"applicationName": null,
"maintAgentVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"affectedSystemIds": [
"c44f978d-8db6-452f-9387-9b852d8df03a"
],
"failedSystemMaintenanceIds": null
}
]
}
CODE
特定のメンテナンス リクエスト レコードの取得
この API を使用して、maintenanceID を使用して特定のアップグレードおよびロールバックの maintenance レコードを取得します。このレコードは、個々のシステムのステータスではなく、全体的なメンテナンスステータスを提供します。
形式：
GET /maintenance/history/{maintenanceId}
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/history/{maintenanceId}' --header 'Authorization: Bearer {AuthToken}'
CODE
入力パラメータ：
Parameter Name | Parameter Type | 説明 | 必須 |
|---|---|---|---|
| パス | ロールバックおよびアップグレードのリクエストからの | はい |
応答例：
{
"maintenanceId":"d601aacc-97a4-479e-b2b3-db095fef34fc",
"operation":"UPGRADE",
"status":"PENDING",
"startedAt":"2021-10-25T18:20:55.196Z",
"updatedAt":"2021-10-25T18:20:55.196Z",
"maintAgentVersions":[
{
"type":"JAVA",
"version":"20.3.0.1183"
}
],
"affectedSystemIds":[
"d601aacc-97a4-479e-b2b3-db095fef34fc"
],
"failedSystemMaintenanceIds":[
"d601aacc-97a4-479e-b2b3-db095fef34fc"
],
"configurations":{
"enableOtel":true,
"otelProperties":{
"tracesExporter":"otlp,logging",
"metricsExporter":"otlp,logging",
"otlpEndpoint":"http://localhost:4317"
},
"enableSim":true,
"dotnetCompatibility":null
}
}
CODE
{
"maintenanceId":"d601aacc-97a4-479e-b2b3-db095fef34fd",
"operation":"UPGRADE",
"status":"SUCCEEDED",
"startedAt":"2022-05-11T18:20:55.196Z",
"updatedAt":"2022-05-11T18:20:55.196Z",
"applicationName": null,
"maintAgentVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"affectedSystemIds":[
"c44f978d-8db6-452f-9387-9b852d8df03a"
],
"failedSystemMaintenanceIds": null,
"configurations":{
"enableSim": true,
"dotnetCompatibility": true
}
}
CODE
すべてのシステム メンテナンス レコードの取得
この API を使用して、maintenanceId を使用して特定のメンテナンスリクエストのすべてのシステム メンテナンス ステータスを取得します。
エージェントのアップグレードが要求されると、エージェントインストーラは自動的に最新バージョンにアップグレードします。次に、応答の implicitMaintenance フィールドによって表されます。
構成のメンテナンスは、バージョンのメンテナンス後に発生します。次に、応答の "operation": "CONFIGURATIONS" フィールドによって表されます。
形式：
GET /maintenance/history/{maintenanceId}/systemMaintenances
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/history/{maintenanceId}/systemMaintenances' --header 'Authorization: Bearer {AuthToken}'
CODE
入力パラメータ：
Parameter Name | Parameter Type | Description | 必須 |
|---|---|---|---|
| パス | ロールバックおよびアップグレードのリクエストからの | はい |
応答例：
{
"total": 3,
"items": [
{
"systemMaintenanceId": "b469f73f-8530-444d-8aa1-256226de0305",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653427594984",
"updatedAt": "1653427608216",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO",
"version": "20.2.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [
{
"type": "ZERO",
"version": "22.5.0.2286"
}
],
"curAgentVersions": [
{
"type": "ZERO",
"version": "20.3.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": true,
"operation": "UPGRADE",
"configurations": null
},
{
"systemMaintenanceId": "eab11200-cf9a-4ec5-9255-0ddbba320257",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653427594988",
"updatedAt": "1653427624802",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO",
"version": "20.2.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [
{
"type": "JDK8_PLUS",
"version": "22.4.0.33722"
}
],
"curAgentVersions": [
{
"type": "ZERO",
"version": "20.3.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": false,
"operation": "UPGRADE",
"configurations": null
},
{
"systemMaintenanceId": "913d9929-a94b-472e-830f-ac1a4b68bc40",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653427594989",
"updatedAt": "1653427642527",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO",
"version": "20.2.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [],
"curAgentVersions": [
{
"type": "ZERO",
"version": "20.3.0.1183"
},
{
"type": "JAVA",
"version": "20.3.0.1183"
},
{
"type": "MACHINE",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": false,
"operation": "CONFIGURATION",
"configurations": {
"enableOtel": true,
"otelProperties": {
"tracesExporter": "otlp,logging",
"metricsExporter": "otlp",
"otlpEndpoint": "http://localhost:4317"
},
"enableSim": null,
"dotnetCompatibility": null
}
}
]
}
CODE
{
"total": 3,
"items": [
{
"systemMaintenanceId": "85473377-f46b-4ab8-941f-9c34a555c15a",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653430383251",
"updatedAt": "1653430397986",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.2.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "22.5.0.2286"
}
],
"curAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.3.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": true,
"operation": "UPGRADE",
"configurations": null
},
{
"systemMaintenanceId": "5e8df22e-3e10-490a-874f-e7a8f9a1cd78",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653430383259",
"updatedAt": "1653430480344",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.2.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"curAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.3.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": false,
"operation": "UPGRADE",
"configurations": null
},
{
"systemMaintenanceId": "4327f68b-78b1-4296-abf6-4c63c5012419",
"systemId": "28f7a681-6010-4150-8940-ebee25841217",
"hostName": "hostname",
"startedAt": "1653430383262",
"updatedAt": "1653430502656",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.2.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.2.0.3282"
}
],
"maintAgentVersions": [],
"curAgentVersions": [
{
"type": "ZERO_WINDOWS",
"version": "20.3.0.1183"
},
{
"type": "MACHINE_WINDOWS",
"version": "22.3.0.3296"
}
],
"implicitMaintenance": false,
"operation": "CONFIGURATION",
"configurations": {
"enableOtel": null,
"otelProperties": null,
"enableSim": true,
"dotnetCompatibility": true
}
}
]
}
CODE
特定のシステム メンテナンス レコードの取得
この API を使用して、systemMaintenanceId を使用して特定のシステム メンテナンス レコードを取得します。
形式：
GET /maintenance/systemMaintenances/{systemMaintenanceId}
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/systemMaintenances/{systemMaintenanceId}' --header 'Authorization: Bearer {AuthToken}'
CODE
入力パラメータ：
Parameter Name | Parameter Type | Description | 必須 |
|---|---|---|---|
| パス | システム メンテナンス アクティビティの | はい |
応答の例：
{
"systemMaintenanceId": "d601aacc-97a4-479e-b2b3-db095fef34fc",
"systemId": "d601aacc-97a4-479e-b2b3-db095fef34fc",
"hostName": "HostName",
"startedAt": "2021-10-25T18:30:52.377Z",
"updatedAt": "2021-10-25T18:30:52.377Z",
"logsAvailable": false,
"status": "SUCCEEDED",
"prevAgentVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"maintAgentVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"curAgentVersions": [
{
"type": "JAVA",
"version": "20.3.0.1183"
}
],
"implicitMaintenance": false
}
CODE
システムメンテナンス失敗ログの取得
この API を使用して、systemMaintenanceId を使用して特定のシステム メンテナンス アクティビティの失敗ログを取得します。返されるログは最大 4,096 文字です。文字数がこの制限を超えると、ログが削減されます。
形式：
GET /maintenance/systemMaintenances/{systemMaintenanceId}/log
CODE
リクエストの例：
curl --location --request GET 'https://demo.saas.appdynamics.com/zero/v1beta/maintenance/systemMaintenances/{systemMaintenanceId}/log' --header 'Authorization: Bearer {AuthToken}'
CODE
入力パラメータ：
Parameter Name | Parameter Type | Description | 必須 |
|---|---|---|---|
| パス | システム メンテナンス アクティビティの | はい |