Integrate OneAgent on Azure Virtual Machines

Full-stack monitoring powered by OneAgent
Extensions for easy deployment of OneAgent
Integration with Azure Monitor
Enhanced support for Azure VM metadata such as Azure regions, scale sets and more
Classic Virtual Machines are also supported

Dynatrace provides a VM Extension to install OneAgent on Azure Virtual Machines. This enables you to leverage the native deployment automation features using Azure Resource Manager (ARM). The Dynatrace VM extension is available for Windows and Linux in all public Azure regions (including support for Classic Virtual Machines).

The extension doesn't include the OneAgent installer. Instead, the extension uses the Dynatrace REST API to download the latest installer from the cluster, unless a OneAgent default version is configured.

Prerequisites

Create a PaaS token.
Determine your environment ID.
Determine your server URL.

The server URL is required only if you use either of the following:

a Dynatrace Managed endpoint
an ActiveGate for a Dynatrace Managed or Dynatrace SaaS endpoint
If you use Dynatrace SaaS, the URL is automatically generated from the environment ID.

The server URL for Dynatrace Managed:

https://{your-domain}/e/{your-environment-id}/api

The server URL for ActiveGate:

https://<your-active-gate-IP-or-hostname>:9999/e/<your-environment-id>/api (the ActiveGate port is configurable)

Note: If you're using Dynatrace Managed or your cluster traffic should be routed through an ActiveGate, you need to configure the API endpoint used by the extension for downloading OneAgent.

Install Dynatrace OneAgent VM extension

There are several ways to install the Dynatrace OneAgent VM extension: through Azure Portal, Azure CLI, or PowerShell, or by using an ARM template. Follow the steps below for instructions.

Azure PortalAzure CLI 2.0PowerShell

Add the extension to an existing VM

In Azure Portal, go to an existing virtual machine where you want to add the OneAgent extension.
In the left menu, go to Settings and select Extensions.
Select Add.
Select Choose extension.
From the list of extensions, select Dynatrace OneAgent.
Select Create to add the extension.
On the Install extension page, enter your environment ID, your API token, and your server URL. See Prerequisites for details.
Select whether you want to enable Log Monitoring.
optional Define the host group to which the VM belongs.
Select OK.
To check the deployment status, in your Dynatrace environment, go to Manage and select Deployment status.

After installation is complete, restart your applications on the VM. Immediately after restart, OneAgent will begin monitoring them.

Add the extension to a new VM

During the creation of a new VM in the deployment wizard, in Advanced, select Select an extension.
Select Dynatrace OneAgent.
Select Create.
On the Install extension page, enter your environment ID, your API token, and your server URL. See Prerequisites for details.
Select whether you want to enable Log Monitoring.
optional Define the host group to which the VM belongs.
Select OK.
Continue VM configuration in the deployment wizard.
Select Review and create.
To check the deployment status, in your Dynatrace environment, go to Manage and select Deployment status.

After installation is complete, restart your applications on the VM. Immediately after restart, OneAgent will begin monitoring them.

Note: Replace all values marked with <...> with your actual values.

az vm extension set
  --publisher dynatrace.ruxit
  -n "<Extension-Type>"
  -g "<Resource-Group>"
  --vm-name "<VM-Name>"
  --settings "{\"tenantId\":\"<Environment-ID>\",\"token\":\"<API-Token>\", \"server\":\"<Server-Url>\", \"enableLogAnalytics\":\"yes\", \"hostGroup\":\"<Host-Group>\"}"

Note: When using the Azure CLI within PowerShell, the settings have to be formatted as a here-string.

--settings @'"{\"tenantId\":\"<Environment-ID>\",\"token\":\"<API-Token>\"}"'@

Parameter	Required	Description
Resource-Group	yes	Name of the resource group on which the VM is deployed.
VM-Name	yes	Name of the VM where you want to install the extension.
Extension-Type	yes	For Windows-based VMs, use `oneAgentWindows`. For Linux-based VMs, use `oneAgentLinux`.
tenantId	yes	The environment ID as described in Prerequisites.
token	yes	The PaaS token as described in Prerequisites.
server	no	optional The server URL, if you want to configure an alternative communication endpoint as described in Prerequisites.
enableLogsAnalytics	no	Set to `yes` if you want to enable Log Monitoring.
hostGroup	no	optional Define the host group to which the VM belongs.

To check the deployment status, in your Dynatrace environment, go to Manage and select Deployment status.

After installation is complete, restart your applications on the VM. Immediately after restart, OneAgent will begin monitoring them.

Note: Replace all values marked with <...> with your actual values.

Set-AzureRmVmExtension
  -Name Dynatrace
  -Publisher dynatrace.ruxit
  -ResourceGroupName "<Resource-Group>"
  -Location "<Location>"
  -VMName "<VM-Name>"
  -ExtensionType "<Extension-Type>"
  -TypeHandlerVersion "<Extension-Version>"
  -Settings @{ "tenantId"="<Environment-ID>"; "token"="<API Token>";"server"="<Server-Url>"; "enableLogAnalytics"="yes"; "hostGroup"="<Host-Group>"; }

Parameter	Required	Description
Resource-Group	yes	Name of the resource group on which the VM is deployed.
Location	yes	Location where the VM is deployed.
VM-Name	yes	Name of the VM where you want to install the extension.
Extension-Type	yes	For Windows-based VMs, use `oneAgentWindows`. For Linux-based VMs, use `oneAgentLinux`.
Extension-Version	yes	Required version of the extension.
tenantId	yes	The environment ID as described in Prerequisites.
token	yes	The PaaS token as described in Prerequisites.
server	no	optional The server URL, if you want to configure an alternative communication endpoint as described in Prerequisites.
enableLogsAnalytics	no	Set to `yes` if you want to enable Log Monitoring.
hostGroup	no	optional Define the host group to which the VM belongs.

To check the deployment status, in your Dynatrace environment, go to Manage and select Deployment status.

After installation is complete, restart your applications on the VM. Immediately after restart, OneAgent will begin monitoring them.

Install Dynatrace OneAgent VM extension via an ARM template

Alternatively to the main installation methods, you can make the Dynatrace VM extension part of your ARM templates.
The JSON file for a virtual machine extension can be nested inside the virtual machine resource, or placed at the root or top level of a resource manager JSON template. The placement of the JSON file affects the value of the resource name and type.

The following example assumes the OneAgent extension is nested inside the virtual machine resource. When nesting the extension resource, the JSON file is placed in the "resources": [] object of the virtual machine.

{
    "type": "extensions",
    "name": "dynatrace",
    "apiVersion": "2018-06-01",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', <VM-Name>)]"
    ],
    "properties": {
        "publisher": "dynatrace.ruxit",
        "type": "<Extension-Type>",
        "typeHandlerVersion": "<Extension-Version>",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "tenantId": "<Environment-ID>",
            "token": "<API-Token>",
            "server": "<Server-Url>",
            "enableLogAnalytics": "yes",
            "hostGroup": "<Host-Group>"

        },
    }
}

When placing the extension JSON at the root of the template, the resource name includes a reference to the parent virtual machine, and the type reflects the nested configuration.

{
    "type": "Microsoft.Compute/virtualMachines/extensions",
    "name": "<Parent-VM-Resource>/dynatrace",
    "apiVersion": "2018-06-01",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', <VM-Name>)]"
    ],
    "properties": {
        "publisher": "dynatrace.ruxit",
        "type": "<Extension-Type>",
        "typeHandlerVersion": "<Extension-Version>",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "tenantId": "<Environment-ID>",
            "token": "<API-Token>",
            "server": "<Server-Url>",
            "enableLogAnalytics": "yes",
            "hostGroup": "<Host-Group>"
        }

    }
}

Parameter	Required	Description
Parent-VM-Resource	yes	Name of the parent VM resource where you want to install the extension. Not applicable when using nested resource.
VM-Name	yes	Name of the VM where you want to install the extension.
Extension-Type	yes	For Windows-based VMs, use `oneAgentWindows`. For Linux-based VMs, use `oneAgentLinux`.
Extension-Version	yes	Required version of the extension.
tenantId	yes	The environment ID as described in Prerequisites.
token	yes	The PaaS token as described in Prerequisites.
server	no	optional The server URL, if you want to configure an alternative communication endpoint as described in Prerequisites.
enableLogsAnalytics	no	Set to `yes` if you want to enable Log Monitoring.
hostGroup	no	optional Define the host group to which the VM belongs.

To check the deployment status, in your Dynatrace environment, go to Manage and select Deployment status.

After installation is complete, restart your applications on the VM. Immediately after restart, OneAgent will begin monitoring them.

optional Configure network zones

To configure network zones, use the installer arguments below.

az vm extension set
  --publisher dynatrace.ruxit
  -n "oneAgentLinux"
  -g "yourresourcegroup"
  --vm-name "awesome-vm"
  --settings "{\"tenantId\":\"myawesometenant\",\"token\":\"nope123\", \"installerArguments\":\"--set-host-group=example_hostgroup --set-infra-only=false --set-network-zone=<your.network.zone>\"}"

See network zones for more information.