Getting Started
Back to
Getting Started.
Diagnostics
Windows Azure Diagnostics enables you to collect diagnostic data from a service running in Windows Azure. It can be used for tasks like debugging and troubleshooting, measuring performance, monitoring resource usage, traffic analysis, capacity planning, and auditing. Once collected, diagnostic data can be transferred to a Windows Azure storage account for persistence. Transfers can either be scheduled or on-demand.
You can configure Windows Azure Diagnostics from code running within a role. You can also configure it remotely from an application running outside of the Windows Azure; for example, you can manage Windows Azure Diagnostics from a custom dashboard application running locally. By managing Windows Azure Diagnostics remotely, you can start your service with an initial diagnostic configuration, and then tweak that configuration from code running outside of your service, without having to upgrade your service.
More information on which logs, performance counters, crash dumps, ... can be monitored can be found on the
corresponding MSDN web page.
Note: Diagnostics are configured on a per-role basis. This means that each role should be configured separately. Specifying diagnostics instructions for one role instance does not imply this configuration is loaded on other role instances.
The Diagnostics API in the Windows Azure SDK for PHP can only be used when the DiagnosticsMonitor has been started during role startup. Currently, this is only supported when an application is packaged with the Windows Azure Command-line Tools for PHP Developers or the latest drop of the Windows Azure tools for Eclipse
API examples
This topic lists some examples of using the PHPAzure SDK. Other features are available in the download package, as well as a detailed API documentation of those features.
Checking if a diagnostics configuration for the current role instance exists
Using the following code, you can check if a diagnostics configuration for the current role instance exists:
/** Microsoft_WindowsAzure_Storage_Blob */
require_once 'Microsoft/WindowsAzure/Storage/Blob.php';
/** Microsoft_WindowsAzure_Diagnostics_Manager */
require_once 'Microsoft/WindowsAzure/Diagnostics/Manager.php';
$storageClient = new Microsoft_WindowsAzure_Storage_Blob();
$manager = new Microsoft_WindowsAzure_Diagnostics_Manager($storageClient);
$configurationExists = $manager->configurationForCurrentRoleInstanceExists();
echo 'The configuration ' . ($configurationExists ? 'exists' : 'does not exist');
Loading the current role instance diagnostics configuration
Using the following code, you can load the current role instance diagnostics configuration:
/** Microsoft_WindowsAzure_Storage_Blob */
require_once 'Microsoft/WindowsAzure/Storage/Blob.php';
/** Microsoft_WindowsAzure_Diagnostics_Manager */
require_once 'Microsoft/WindowsAzure/Diagnostics/Manager.php';
$storageClient = new Microsoft_WindowsAzure_Storage_Blob();
$manager = new Microsoft_WindowsAzure_Diagnostics_Manager($storageClient);
$configuration = $manager->getConfigurationForCurrentRoleInstance();
Storing the current role instance diagnostics configuration
Using the following code, you can store the current role instance diagnostics configuration:
/** Microsoft_WindowsAzure_Storage_Blob */
require_once 'Microsoft/WindowsAzure/Storage/Blob.php';
/** Microsoft_WindowsAzure_Diagnostics_Manager */
require_once 'Microsoft/WindowsAzure/Diagnostics/Manager.php';
$storageClient = new Microsoft_WindowsAzure_Storage_Blob();
$manager = new Microsoft_WindowsAzure_Diagnostics_Manager($storageClient);
$configuration = // ...;
$manager->setConfigurationForCurrentRoleInstance($configuration);
Subscribing to a performance counter
Using the following code, you can subscribe to a performance counter:
/** Microsoft_WindowsAzure_Storage_Blob */
require_once 'Microsoft/WindowsAzure/Storage/Blob.php';
/** Microsoft_WindowsAzure_Diagnostics_Manager */
require_once 'Microsoft/WindowsAzure/Diagnostics/Manager.php';
$storageClient = new Microsoft_WindowsAzure_Storage_Blob();
$manager = new Microsoft_WindowsAzure_Diagnostics_Manager($storageClient);
$configuration = $manager->getConfigurationForCurrentRoleInstance();
// Subscribe to \Processor(*)\% Processor Time
$configuration->DataSources->PerformanceCounters->addSubscription('\Processor(*)\% Processor Time', 1);
$manager->setConfigurationForCurrentRoleInstance($configuration);
Getting the current role instance id
The current role instance id is defined in the server variable
RdRoleId. It will only be available when the application is run in Development Fabric or Windows Azure Fabric. For example:
echo 'The role instance id is ' . $_SERVER['RdRoleId'];