Azure-docs: how to install Linux Azure Diagnostics extension

[kazshi]

Do we need to install Linux Azure Diagnostics extension to custom image, or is it possible to install the extension using template like described in the following link?
https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/diagnostics-template#add-the-azure-diagnostics-extension-to-the-vm-resource-definition

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 5f592bc9-2278-2336-bf26-fe2e270d1c42
• Version Independent ID: 5f540486-53db-0d5f-d3b0-6ebe39f0fa6f
• Content: Use Azure autoscale with guest metrics in a Linux scale set template
• Content Source: articles/virtual-machine-scale-sets/virtual-machine-scale-sets-mvss-guest-based-autoscale-linux.md
• Service: virtual-machine-scale-sets
• GitHub Login: @gatneil
• Microsoft Alias: negat

[Karishma-Tiwari-MSFT]

Thanks for the question! We are currently investigating and will update you shortly.

[Karishma-Tiwari-MSFT]

@kazshi Here is the document on how to install Linux Diagnostics Extension.
You will find more information on Azure Linux Extensions in this doc.

[kazshi]

@Karishma-Tiwari-MSFT I read the document on how to install Linux Diagnostics Extension, but I'd like to know if it's possible to install the extension using template and how to do if it's possible. Thanks.

[kazshi]

@Karishma-Tiwari-MSFT Actually I want to know how we can enable Linux Diagnostics Extension to get Guest metric and alert in Linux VMSS.

[Karishma-Tiwari-MSFT]

@kazshi Thanks for the clarification on the ask. Guest metrics require you to install the Linux Azure Diagnostics extension in the guest VM. The Azure diagnostics extension is an agent that runs inside a VM instance. To use the Azure diagnostics extension, you must create Azure storage accounts for your VM instances, install the Azure diagnostics agent, then configure the VMs to stream specific performance counters to the storage account.

Refer to the Autoscale using guest metrics in a Linux scale set template document which provides detailed explanation on deploying the Linux scale set with guest-based autoscale.

[kazshi]

@Karishma-Tiwari-MSFT Thanks. I understand that we cannot install the Linux Azure Diagnostics extension in the guest VM using template (that's the answer for my first question) and we need to install the Linux Azure Diagnostics extension to a custom image for VMSS deployment beforehand, correct?
I'll close this if it's true.

I wasn't sure because it's possible to add the Azure Diagnostics extension to the VM resource definition for Windows VM. It would be great if it's written clearly in this content.

[Karishma-Tiwari-MSFT]

@kazshi You can install the Linux Diagnostic extension using template just like any other extension.
This is one of the example that you can follow, search for "extensionProfile" and add the details of the extension you want to install.
https://github.com/Azure/azure-quickstart-templates/blob/master/201-vmss-windows-webapp-dsc-autoscale/azuredeploy.json
I agree that we do not have a document dedicated to this topic. I am working with the content team to create a doc specifically on "How to install LAD in VMSS" so that customers do not have to navigate to multiple docs. Thanks for your patience. We appreciate your feedback and working towards making documentation clearer.

[kazshi]

@Karishma-Tiwari-MSFT Thanks for the additional info, but I'm not sure if I can forward the info to my customer since I'm not still clear yet myself - I need to check what property values we should specify to the sample template.

I couldn't find property list of the the Linux Diagnostic extension and cannot figure out how to make it. I will ask my customer to wait for new content.

[Karishma-Tiwari-MSFT]

@kazshi I apologize for the inconvenience. I have assigned the issue to the content author to update the document to make it as clear and descriptive as possible.
The properties for the extension should look like this as per this doc:

"properties": {
            "publisher": "Microsoft.Azure.Diagnostics",
            "type": "LinuxDiagnostic",
            "typeHandlerVersion": "3.0",
            "autoUpgradeMinorVersion": true,
            "settings": {
            },
            "protectedSettings": {
            }
}

[Karishma-Tiwari-MSFT]

@jpconnock Currently customers have to go through multiple docs to understand the process to Install Linux Diagnostics Extension on Virtual Machine Scale sets using templates (VMSS). I have shared multiple docs in the comments above to help out the customer. I think we need to consolidate them as well as add clear template on the same.
Let me know if you have any questions regarding this, happy to help. Assigning this to you as doc-enhancement as Neil Gat is not a member of Azure-docs.

[jpconnock]

Thank you, @Karishma-Tiwari-MSFT !

Could you please assign this to @mmccrory , who is our new PM for VMSS?

FYI @cynthn

[kazshi]

@Karishma-Tiwari-MSFT Thank you for the update - looks like the sample would be useful for the customer. I really appreciate your quick response.

[cynthn]

please-close I've created a work item to get this covered in an upcoming update to the extensions docs. Thank you!