Skip to content

Latest commit

 

History

History
 
 

Diagnostic

README.md

Diagnostic Extension

Allow the owner of the Azure Virtual Machines to obtain diagnostic data for a Linux virtual machine.

Latest version is 2.3.9007.

You can read the User Guide below for detail:

Diagnostic Extension can:

  • Collects and uploads Linux VM's system performance, diagnostic, and syslog data to user’s storage table.
  • Enables user to customize the data metrics that will be collected and uploaded.
  • Enables user to upload specified log files to designated storage table.

Important Notice

The new Azure Portal's VM Diagnostic extension status and performance graphs will not work if the Linux Azure Diagnostic extension is configured using one of the methods described in this document (that is, using either Azure Powershell or Azure XPLAT CLI with the JSON configs below). The Azure Portal's VM Diagnostic extension status and the performance graphs requires that this extension be enabled only through the Azure Portal.

User Guide

1. Configuration schema

1.1. Public configuration

Schema for the public configuration file looks like this:

  • perfCfg: (optional) A list of WQL query clauses, supported counters could be found in this document. If no perfCfg entry is specified, then memory, CPU, and disk perf counters are added by default. If no perf counters should be collected, give an empty array ([]) as the value for this key.
  • enableSyslog: (optional) Whether syslog data should be reported, currently only rsyslog is supported. Can choose from 'true' and 'false', default value is true.
  • fileCfg: (optional) A list of files to be tracked, note this only works when enableSyslog is set to true.
  • mdsdHttpProxy: (optional) http proxy configuration for mdsd. Format: "http://proxy_host:proxy_port". "http:" part is optional. DO NOT specify username and password here!
{
  "perfCfg":[
    {
     "query":"SELECT UsedMemory,AvailableMemory FROM SCX_MemoryStatisticalInformation","table":"Memory"
    }
  ],
  "fileCfg":[
    {"file":"/var/log/a.log", "table":"aLog"},
    {"file":"/var/log/b.log", "table":"bLog"}
  ],
  "enableSyslog":"true",
  "mdsdHttpProxy":"http://your_proxy_host:3128"
}

1.2. Protected configuration

Schema for the protected configuration file looks like this:

  • storageAccountName: (required) the name of storage account
  • storageAccountKey: (required) the access key of storage account
  • mdsdHttpProxy: (optional) http proxy configuration for mdsd. Format: "http://username:password@proxy_host:proxy_port". "http:" part is optional. You may specify username and password here. If this is specified both on public and protected configurations, this protected configuration will prevail.
{
  "storageAccountName": "<storage-account-name>",
  "storageAccountKey": "<storage-account-key>",
  "mdsdHttpProxy":"http://proxy_username:password@your_proxy_host:3128"
}

NOTE:

The storage account is used for storing the diagnostic montioring data, the data would be sent to the Table storage of that account.

Please note that premium storage account could not be used since it does not support Table storage.

2. Deploying the Extension to a VM

You can deploy it using Azure CLI, Azure Powershell and ARM template.

NOTE:

Creating VM in Azure has two deployment model: Classic and Resource Manager. In diffrent models, the deploying commands have different syntaxes. Please select the right one in section 2.1 and 2.2 below.

2.1. Using Azure CLI

Before deploying Diagnostic Extension, you should configure your public.json and protected.json (in section 1.1 and 1.2 above).

2.1.1 Classic

The Classic mode is also called Azure Service Management mode. You can change to it by running:

$ azure config mode asm

You can deploy Diagnostic Extension by running:

$ azure vm extension set <vm-name> LinuxDiagnostic Microsoft.OSTCExtensions '2.*' -c public.json -e protected.json

In the command above, you can change version with '*' to use latest version available, or '2.*' to get newest version that does not introduce non-breaking schema changes.

2.1.2 Resource Manager

You can change to Azure Resource Manager mode by running:

$ azure config mode arm

You can deploy Diagnostic Extension by running:

$ azure vm extension set <resource-group> <vm-name> LinuxDiagnostic Microsoft.OSTCExtensions <version> -c public.json  -e protected.json

2.2. Using Azure Powershell

2.2.1 Classic

You can login to your Azure account (Azure Service Management mode) by running:

Add-AzureAccount

You can deploy Diagnostic Extension by running:

$VmName = '<vm-name>'
$vm = Get-AzureVM -ServiceName $VmName -Name $VmName

$ExtensionName = 'LinuxDiagnostic'
$Publisher = 'Microsoft.OSTCExtensions'
$Version = '<version>'

# Add "mdsdHttpProxy" setting to $PublicConf or $PrivateConf as needed (as mentioned above)

$PublicConf = '{
  "perfCfg":[
    {
     "query":"SELECT UsedMemory,AvailableMemory FROM SCX_MemoryStatisticalInformation","table":"Memory"
    }
  ],
  "fileCfg":[
    {"file":"/var/log/a.log", "table":"aLog"},
    {"file":"/var/log/b.log", "table":"bLog"}
  ],
  "enableSyslog":"true"
}'

$PrivateConf = '{
    "storageAccountName": "<storage-account-name>",
    "storageAccountKey": "<storage-account-key>"
}'

Set-AzureVMExtension -ExtensionName $ExtensionName -VM $vm `
  -Publisher $Publisher -Version $Version `
  -PrivateConfiguration $PrivateConf -PublicConfiguration $PublicConf |
  Update-AzureVM

2.2.2 Resource Manager

You can login to your Azure account (Azure Resource Manager mode) by running:

Login-AzureRmAccount

Click HERE to learn more about how to use Azure Powershell with Azure Resource Manager.

You can deploy LinuxDiagnostic Extension by running:

$RGName = '<resource-group-name>'
$VmName = '<vm-name>'
$Location = '<location>'

$ExtensionName = 'LinuxDiagnostic'
$Publisher = 'Microsoft.OSTCExtensions'
$Version = '<version>'

# Add "mdsdHttpProxy" setting to $PublicConf or $PrivateConf if needed (as mentioned above).

$PublicConf = '{
  "perfCfg":[
    {
     "query":"SELECT UsedMemory,AvailableMemory FROM SCX_MemoryStatisticalInformation","table":"Memory"
    }
  ],
  "fileCfg":[
    {"file":"/var/log/a.log", "table":"aLog"},
    {"file":"/var/log/b.log", "table":"bLog"}
  ],
  "enableSyslog":"true"
}'

$PrivateConf = '{
    "storageAccountName": "<storage-account-name>",
    "storageAccountKey": "<storage-account-key>"
}'

Set-AzureRmVMExtension -ResourceGroupName $RGName -VMName $VmName -Location $Location `
  -Name $ExtensionName -Publisher $Publisher `
  -ExtensionType $ExtensionName -TypeHandlerVersion $Version `
  -Settingstring $PublicConf -ProtectedSettingString $PrivateConf

2.3. Using ARM Template

Add "mdsdHttpProxy" setting to "settings" section or "protectedSettings" section if needed (as mentioned above).

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "<extension-deployment-name>",
  "apiVersion": "<api-version>",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vmName>)]"
  ],
  "properties": {
    "publisher": "Microsoft.OSTCExtensions",
    "type": "LinuxDiagnostic",
    "typeHandlerVersion": "2.3",
    "settings": {
       "perfCfg":[
          {
            "query":"SELECT UsedMemory,AvailableMemory FROM SCX_MemoryStatisticalInformation","table":"Memory"
          }
        ]
    },
    "protectedSettings": {
      "storageAccountName": "<storage-account-name>",
      "storageAccountKey": "<storage-account-key>"
    }
  }
}

For more details about ARM template, please visit Authoring Azure Resource Manager templates.

Supported Linux Distributions

  • Ubuntu 12.04 and higher. Ubuntu 16.04 support is currently not official, as our OMI dependency is not officially supported on Ubuntu 16.04 as of LAD 2.3.9. Also as of the same version, MySQL monitoring using OMI/SCX is not working on Ubuntu 16.04, due to the fact that Ubuntu 16.04's MySQL build is changed in a way that current OMI/SCX doesn't support.
  • CentOS 6.5 and higher
  • Oracle Linux 6.4.0.0.0 and higher
  • OpenSUSE 13.1 and higher
  • SUSE Linux Enterprise Server 11 and higher
  • Debian 7 and higher (7 is now supported with static mdsd build)
  • RHEL 6.7 and higher

Debug

  • The status of the extension is reported back to Azure so that user can see the status on Azure Portal
  • The operation log of the extension is /var/log/azure/Microsoft.OSTCExtensions.LinuxDiagnostic/<version>/ directory.