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 allows to leverage the native deployment automation features using Azure Resource Manager (ARM).

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.

Azure Site-Extension

Agent updates are provided automatically through the capabilities of OneAgent.

Prerequisites

Generate an environment ID and a PaaS token

Sign in using your Dynatrace account.
Select Deploy Dynatrace from the left-hand menu.
Select Set up PaaS integration.
Your environment ID appears in the Environment ID text box. You'll need this ID to link your Dynatrace account with your PaaS environment. Select Copy to copy the ID to the clipboard. You can do this at any time by revisiting this page.
To generate a PaaS token, select Generate new token.
The PaaS token is essentially an API token that's used in combination with your environment ID to download OneAgent. As you'll see, there's also a default InstallerDownload token available that you can alternatively use. However, for security reasons, it's recommended that you create several discrete tokens for each environment you have.
Enter a meaningful name for your PaaS token. A meaningful token name might be the name of the PaaS platform you want to monitor (for example, azure, cloud-foundry, or openshift).
Select Generate to create the PaaS token. The newly created PaaS token will appear in the list below. Select Copy to copy the generated token to the clipboard. You can do this at any time by revisiting this page and selecting Show token next to the relevant PaaS token.

Alternatively you can use the POST a new token API call to generate a token with the InstallerDownload and SupportAlert permissions.

Additional configuration parameters

Server URL
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.

<YourDynatraceServerURL> and <YourEnvironmentID> need to be replaced. The URL pattern for the API endpoint is as follows: https://<YourDynatraceServerURL>/e/<YourEnvironmentID>/api

Optional Network zones
To configure network zones, use the following installer arguments:

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

See network zones for more information.

Install Dynatrace OneAgent site extension

The Dynatrace VM extension is available for Windows and Linux in all public Azure regions (including support for Classic Virtual Machines).

Azure Portal Azure CLI 2.0 PowerShell

Add the extension to an existing VM

Navigate to an existing virtual machine.
Select Extensions > Add.
Select Dynatrace OneAgent from the list of extensions.
Provide the configuration parameters as required.
Select OK to start the installation process.

Add the extension to a new VM

Use the deployment wizard to configure the VM extension during the creation of a new VM.

deployment-wizard

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 the Virtual Machine is deployed to.
VM-Name	yes	Name of the VM the extension should be installed.
Extension-Type	yes	For Windows-based Virtual Machines use `oneAgentWindows`. For Linux-based ones use `oneAgentLinux`.
tenantId	yes	Set environment ID as described in the Prerequisites.
token	yes	Set API token as described in the Prerequisites.
server	no	Optional Provide this property to configure an alternative communication endpoint. See Additional configuration parameters for more information.
enableLogsAnalytics	no	If not set, Log Monitoring isn't enabled. Set value to `yes` to enable Log Monitoring
hostGroup	no	Optional Provide this property to define the hostgroup that this VM belongs to. See Host Groups for more information.

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>"
  -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 the Virtual Machine is deployed to.
Location	yes	Location the VM is deployed to.
VM-Name	yes	Name of the VM the extension should be installed.
Extension-Type	yes	For Windows-based Virtual Machines use `oneAgentWindows`. For Linux-based ones use `oneAgentLinux`.
tenantId	yes	Provide the environment ID as described in the Prerequisites.
token	yes	Provide the API token as described in the Prerequisites.
server	no	Optional Provide this property to configure an alternative communication endpoint. See Additional configuration parameters for more information.
enableLogsAnalytics	no	If not set, Log Monitoring isn't enabled. Set value to `yes` to enable Log Monitoring
hostGroup	no	Optional Provide this property to define the hostgroup that this VM belongs to. See Host Groups for more information.

Install Dynatrace OneAgent site extension via an ARM template

Alternatively to the main installation methods, you can make the Dynatrace site extension part of your ARM templates.
The JSON 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 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 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 the extension should be installed. Not applicable when using nested resource.
VM-Name	yes	Name of the VM the extension should be installed.
Extension-Type	yes	For Windows-based Virtual Machines use `oneAgentWindows`. For Linux-based ones use `oneAgentLinux`.
Extension-Version	yes	Required version of the extension. Current latest version is: 2.3
tenantId	yes	Provide the environment ID as described in the Prerequisites.
token	yes	Provide the API token as described in the Prerequisites
server	no	Optional Provide this property to configure an alternative API endpoint to download the OneAgent installer. See Additional configuration parameters for more information.
enableLogsAnalytics	no	If not set, Log Monitoring isn't enabled. Set value to `yes` to enable Log Monitoring
hostGroup	no	Optional Provide this property to define the hostgroup that this VM belongs to. See Host Groups for more information.

Check deployment status

OneAgent starts monitoring your virtual machine immediately after installation, but it will start monitoring your application only after the application is restarted.

You can see the deployment status in your Dynatrace environment.

OneAgent deployment status