Monitor Azure Virtual Machine Scale Set (VMSS)
Capabilities
Full-stack monitoring powered OneAgent
- Extensions for easy deployment of OneAgent
- Integration with Azure Monitor
Enhanced support for Azure VM Metadata such as Azure regions, AutoScale detection, and more
Dynatrace provides a VM extension to install OneAgent on Azure Virtual Machine Scale Set (VMSS). The extension doesn't include the OneAgent installer. Instead, it uses the Dynatrace REST API to download the latest version from the cluster, unless a default OneAgent version is configured. OneAgent updates are provided automatically.
Prerequisites
-
Create a PaaS token.
-
Determine your environment ID.
-
Determine your server URL if required.
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.)
- Dynatrace Managed server URL:
https://{your-domain}/e/{your-environment-id}/api
- ActiveGate server URL:
https://<your-active-gate-IP-or-hostname>:9999/e/<your-environment-id>/api
(the ActiveGate port is configurable)
If you're using Dynatrace Managed, or if your cluster traffic should be routed through an ActiveGate, you need to configure the API endpoint used by the extension for downloading OneAgent.
Installation
The Dynatrace VM extension is available for Windows and Linux in all public Azure regions.
Install Dynatrace OneAgent VM extension via an ARM template
Alternatively to the main installation methods, you can make the Dynatrace site extension part of your ARM templates.
-
Place the JSON configuration for a virtual machine extension in the VMSS resource, under
extensions
inextensionProfile
.Example:
1{2 "type": "Microsoft.Compute/virtualMachineScaleSets",3 "sku": {...},4 "name": "<VMSS-Name>",5 "apiVersion": "2018-06-01",6 "location": "centralus",7 "properties": {8 "upgradePolicy": {...},9 "virtualMachineProfile": {10 "osProfile": {...},11 "storageProfile": {...},12 "networkProfile": {...},13 "extensionProfile": {14 "extensions": [15 {16 "name": "dynatrace",17 "properties": {18 "publisher": "dynatrace.ruxit",19 "type": "<Extension-Type>",20 "typeHandlerVersion": "<Extension-Version>",21 "autoUpgradeMinorVersion": true,22 "settings": {23 "tenantId": "<Environment-ID>",24 "token": "<API-Token>",25 "enableLogAnalytics": "yes"2627 }28 }29 }30 ]31 }32 }33 }34} -
Configure the JSON file.
1{2 "name": "dynatrace",3 "properties": {4 "publisher": "dynatrace.ruxit",5 "type": "<Extension-Type>",6 "typeHandlerVersion": "<Extension-Version>",7 "autoUpgradeMinorVersion": true,8 "settings": {9 "tenantId": "<Environment-ID>",10 "token": "<API-Token>",11 "server": "<Server-Url>",12 "enableLogAnalytics": "yes",13 "hostGroup": "<Host-Group>"14 },15 }16}Parameter Required Description Resource-Group required Name of the resource group on which the VM is deployed. VMSS-Name required Name of the VMSS where you want to install the extension. Extension-Type required For Windows-based VMs, use oneAgentWindows
. For Linux-based VMs, useoneAgentLinux
.tenantId required The environment ID as described in Prerequisites. token required The PaaS token as described in Prerequisites. Extension-Version optional Required version1 of the extension. server optional The server URL, if you want to configure an alternative communication endpoint as described in Prerequisites. enableLogAnalytics optional Set to yes
if you want to enable Log Monitoring.hostGroup optional Define the host group to which the VM belongs. 1o fetch the list of extension versions, run
1az vm extension image list --name oneAgentLinux --publisher dynatrace.ruxit -
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.
Troubleshooting
Restart the VMSS nodes via PowerShell, replacing all values marked with <...>
with your actual values:
1Restart-AzureRmVmss -ResourceGroupName "<Resource-Group>" -VMScaleSetName "<VMSS-Name>"
Parameter | Required | Description |
---|---|---|
Resource-Group | required | Name of the resource group on which the Virtual Machine is deployed |
VMSS-Name | required | Name of the VMSS where you want to install the extension. |