Manage Extensions

Dynatrace Hub verifies the extension archive and structure and automatically enables it after a successful upload.

Most fields are pre-filled based on the extension YAML file. You can provide release notes information explaining why the extension version changed.

You can now check the Product information, Extension content, Available versions, Monitoring configurations, and Health of your extension by selecting each of the tabs.

Define devices

Select Add device to define the devices from which you want to pull data and provide the device connection details:

Start monitoring

Your extension appears in Dynatrace Hub. The next step is to provide the monitoring configuration for your extension. The detailed steps depend on your extension data source. For more information, see:

To update an extension, simply upload a new version. Dynatrace Hub will automatically activate the new extension version.

You can uninstall an extension or remove a version of that extension.

To uninstall an extension

To delete extension versions

When you delete a version, Dynatrace Hub activates the latest available version.

Run the following command to upload the extension package to your environment. For this example, we use the Dynatrace SaaS URL:

curl -X POST "https://{env-id}.live.dynatrace.com/api/v2/extensions" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token {api-token}" \
-H "Content-Type: multipart/form-data" \
-F "file=@MyCustomExtension.zip;type=application/zip"

Replace:

After a successful upload, the Dynatrace API returns basic extension details, including the extension name, version, and minimum Dynatrace version required to run the extension:

{
   "extensionName":"custom:my.company.extension",
   "version":"1.0.0",
   "author":{
      "name":"My Company"
   },
   "dataSources":[

   ],
   "variables":[

   ],
   "featureSets":[

   ],
   "minDynatraceVersion":"1.213.0"
}

After you upload the extension to your environment, you need to enable the environment configuration. This step is necessary because you can upload up to 10 extension versions but you can use only one extension version at the time. When you activate the extension, you specify which extension version to use.

Run the following command to activate the extension in your environment. For this example, we use the Dynatrace SaaS URL.

curl -X PUT "https://{env-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/environmentConfiguration" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token {api-token}" \
-H "Content-Type: application/json; charset=utf-8" \
-d "{\"version\":\"{version}\"}"

Replace:

To determine the extension name, extract the extension package, extract the extensions.zip file from the package, and open the extension.yaml file.

After a successful activation, the Dynatrace API returns the version of the activated extension. For example:

{"version":"1.0.0"}

To start monitoring, you need to add at least one version of the monitoring configuration. The format of the JSON payload depends on the monitored data source.

curl -X POST "{env-id}.live.dynatrace.com/api/v2/extensions/{extensionName>/monitoringConfigurations" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token {api-token}" \
-H "Content-Type: application/json; charset=utf-8" \
--data @{monitoring-configuration} -i

Replace:

After a successful call, the Dynatrace API returns the MonitoringConfigurationResponse object. For example:

[
{ "objectId": "vu9U3hXa3q0AAAABACVleHQ6Y29tLmR5bmF0cmFjZS5zY2hlbWEtc25tcC1nZW5lcmljAAhhZ19ncm91cAAHRTJFVEVTVAAkMWMxZTlhMDctNzVkYi0zZjI0LWI4OGUtZmIxYWRiNGNjYTY4vu9U3hXa3q0", "code": 200 }
]

After a few minutes, go to Metric browser and search for the metrics you defined for your extension.

To update an extension, you need to upload the new extension package and enable the new environment configuration.

Upload updated extension package with API

To upload the package, use the same command you used to upload the initial version of the extension. You need to use the new extension package filename if it changed.

Enable new configuration version with API

To enable the environment configuration version, you need to add the version parameter to the API call. Use one of these methods to determine the version:

Run the following command to activate the new version. For this example, we use the Dynatrace SaaS URL.

curl -X PUT "https://{env-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/environmentConfiguration" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token  {api-token}" \
-H "Content-Type: application/json; charset=utf-8" \
-d "{\"version\":\"{version}\"}"

Replace:

After a successful activation, the Dynatrace API returns the version of the activated extension. For example:

{"version":"1.1.0"}

If you need to revert activation to an earlier version, run the command above with a different version parameter.

If you uploaded a number of extension versions, you need to delete all the versions to completely remove the extension from your environment. You can use GET extension versions to list all the extension versions available in your environment.

Delete environment configuration with API

To delete the currently active environment configuration, use DELETE environment configuration. For this example, we use the Dynatrace SaaS URL.

curl -X DELETE "{env-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/environmentConfiguration" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token {api-token}"

Replace:

After a successful deactivation, the Dynatrace API returns the version of the deactivated extension. For example:

{"version":"1.1.0"}

Delete extension version with API

To delete an extension version, use DELETE an extension version. In this example, we use the Dynatrace SaaS URL.

curl -X DELETE "{env-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{version}" \
-H "accept: application/json; charset=utf-8" \
-H "Authorization: Api-Token {api-token}"

Replace:

After a successful version deletion, the Dynatrace API returns the following response:

{
   "extensionName":"custom:my.company.extension",
   "version":"1.0.0",
   "author":{
      "name":"My Company"
   },
   "dataSources":[

   ],
   "variables":[

   ],
   "featureSets":[

   ],
   "minDynatraceVersion":"1.213.0"
}