Upgrade Agent Versions

Now that you have the systemIDs, hostname, and the latest versions, trigger the upgrade using the API. Once the request is accepted, you receive a maintenanceID. The upgrade happens asynchronously, and you can use the maintenanceID to track the progress of the upgrade.

Warning: Specifying the configurations is optional. If none are added, then configurations currently running in the Agent Installer are used. You can upgrade from Java Agent Legacy to Java Agent JKD8+, but you cannot upgrade from Java Agent JDK8+ to Java Agent Legacy.

Format:

POST /maintenance/upgrade/systems

Request Examples:

On Linux:
{
"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
}
}
On Windows:
{
"systemDetails": [
{
"systemId": "c44f978d-8db6-452f-9387-9b852d8df03a",
"hostname": "windows_host"
}
],
"versions": [
{
"type": "MACHINE_WINDOWS",
"version": "22.4.0.3344"
}
],
"configurations": {
"enableSim": true,
"dotnetCompaibility": true
}
}

Input Parameters:

Parameter Name Parameter Type Description Mandatory
systemDetails.systemId Body

ID of the Agent Installer system

Yes
systemDetails.hostname

Hostname of the Agent Installer System

versions.type

Type of the monitoring agents

versions.verison

Versions of the monitoring agents to upgrade
configurations.enableOtel Configuration to enable OpenTelementry for Java Agent JDK8+. No
configurations.otelProperties

Configurations for OpenTelemetry exporter.

Yes, only when enableOtel is true
configurations.otelProperties.tracesExporter Configuration for OpenTelemetry traces exporter. Supported values: otlp , logging .
configurations.otelProperties.metricsExporter Configuration for OpenTelemetry metrics exporter. Supported values: otlp , logging .
configurations.otelProperties.otlpEndpoint Configuration for OpenTelemetry OTLP Collector endpoint.
configurations.enableSim Configuration to enable Server Visibility for the Machine Agent. No
configurations.dotnetCompatibility Configuration to enable .NET Compatibility Mode for the Machine Agent. No

Response Examples:

On Linux:
{
"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
}
}
On Windows:
{
"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
}
}