docs.microsoft.com Open in urlscan Pro
2a02:26f0:3400:192::353e  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to main content


This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security
updates, and technical support.

Download Microsoft Edge More info

Table of contents Exit focus mode

Read in English Save
Table of contents Read in English Save Feedback Edit

Twitter LinkedIn Facebook Email
Table of contents


ENABLE AND MANAGE AZURE STORAGE ANALYTICS LOGS (CLASSIC)

 * Article
 * 04/14/2022
 * 10 minutes to read
 * 5 contributors




IN THIS ARTICLE

Azure Storage Analytics provides logs for blobs, queues, and tables. You can use
the Azure portal to configure logs are recorded for your account. This article
shows you how to enable and manage logs. To learn how to enable metrics, see
Enable and manage Azure Storage Analytics metrics (classic). There are costs
associated with examining and storing monitoring data in the Azure portal. For
more information, see Storage Analytics.

Note

We recommend that you use Azure Storage logs in Azure Monitor instead of Storage
Analytics logs. See any of the following articles:

 * Monitoring Azure Blob Storage
 * Monitoring Azure Files
 * Monitoring Azure Queue Storage
 * Monitoring Azure Table storage




ENABLE LOGS

You can instruct Azure Storage to save diagnostics logs for read, write, and
delete requests for the blob, table, and queue services. The data retention
policy you set also applies to these logs.

Note

Azure Files currently supports Storage Analytics metrics, but does not support
Storage Analytics logging.

 * Portal
 * PowerShell
 * .NET v12 SDK
 * .NET v11 SDK

 1. In the Azure portal, select Storage accounts, then the name of the storage
    account to open the storage account blade.

 2. Select Diagnostic settings (classic) in the Monitoring (classic) section of
    the menu blade.
    
    

 3. Ensure Status is set to On, and select the services for which you'd like to
    enable logging.
    
    

 4. Ensure that the Delete data check box is selected. Then, set the number of
    days that you would like log data to be retained by moving the slider
    control beneath the check box, or by directly modifying the value that
    appears in the text box next to the slider control. The default for new
    storage accounts is seven days. If you do not want to set a retention
    policy, enter zero. If there is no retention policy, it is up to you to
    delete the log data.
    
    Warning
    
    Logs are stored as data in your account. log data can accumulate in your
    account over time which can increase the cost of storage. If you need log
    data for only a small period of time, you can reduce your costs by modifying
    the data retention policy. Stale log data (data older than your retention
    policy) is deleted by the system. We recommend setting a retention policy
    based on how long you want to retain the log data for your account. See
    Billing on storage metrics for more information.

 5. Click Save.
    
    The diagnostics logs are saved in a blob container named $logs in your
    storage account. You can view the log data using a storage explorer like the
    Microsoft Azure Storage Explorer, or programmatically using the storage
    client library or PowerShell.
    
    For information about accessing the $logs container, see Storage analytics
    logging.

 1. Open a Windows PowerShell command window.

 2. Sign in to your Azure subscription with the Connect-AzAccount command and
    follow the on-screen directions.
    
    Connect-AzAccount
    

 3. If your identity is associated with more than one subscription, then set
    your active subscription.
    
    $context = Get-AzSubscription -SubscriptionId <subscription-id>
    Set-AzContext $context
    
    
    Replace the <subscription-id> placeholder value with the ID of your
    subscription.

 4. Get the storage account context that defines the storage account you want to
    use.
    
    $storageAccount = Get-AzStorageAccount -ResourceGroupName "<resource-group-name>" -AccountName "<storage-account-name>"
    $ctx = $storageAccount.Context
    
    
    * Replace the <resource-group-name> placeholder value with the name of your
      resource group.
    
    * Replace the <storage-account-name> placeholder value with the name of your
      storage account.

 5. Use the Set-AzStorageServiceLoggingProperty to change the current log
    settings. The cmdlets that control Storage Logging use a LoggingOperations
    parameter that is a string containing a comma-separated list of request
    types to log. The three possible request types are read, write, and delete.
    To switch off logging, use the value none for the LoggingOperations
    parameter.
    
    The following command switches on logging for read, write, and delete
    requests in the Queue service in your default storage account with retention
    set to five days:
    
    Set-AzStorageServiceLoggingProperty -ServiceType Queue -LoggingOperations read,write,delete -RetentionDays 5 -Context $ctx
    
    
    Warning
    
    Logs are stored as data in your account. log data can accumulate in your
    account over time which can increase the cost of storage. If you need log
    data for only a small period of time, you can reduce your costs by modifying
    the data retention policy. Stale log data (data older than your retention
    policy) is deleted by the system. We recommend setting a retention policy
    based on how long you want to retain the log data for your account. See
    Billing on storage metrics for more information.
    
    The following command switches off logging for the table service in your
    default storage account:
    
    Set-AzStorageServiceLoggingProperty -ServiceType Table -LoggingOperations none -Context $ctx 
    
    
    For information about how to configure the Azure PowerShell cmdlets to work
    with your Azure subscription and how to select the default storage account
    to use, see: How to install and configure Azure PowerShell.

QueueServiceClient queueServiceClient = new QueueServiceClient(connectionString);

QueueServiceProperties serviceProperties = queueServiceClient.GetProperties().Value;

serviceProperties.Logging.Delete = true;

QueueRetentionPolicy retentionPolicy = new QueueRetentionPolicy();
retentionPolicy.Enabled = true;
retentionPolicy.Days = 2;
serviceProperties.Logging.RetentionPolicy = retentionPolicy;

serviceProperties.HourMetrics = null;
serviceProperties.MinuteMetrics = null;
serviceProperties.Cors = null;

queueServiceClient.SetProperties(serviceProperties);


var storageAccount = CloudStorageAccount.Parse(connStr);  
var queueClient = storageAccount.CreateCloudQueueClient();  
var serviceProperties = queueClient.GetServiceProperties();

serviceProperties.Logging.LoggingOperations = LoggingOperations.All;  
serviceProperties.Logging.RetentionDays = 2;

queueClient.SetServiceProperties(serviceProperties);  





MODIFY LOG DATA RETENTION PERIOD

Log data can accumulate in your account over time which can increase the cost of
storage. If you need log data for only a small period of time, you can reduce
your costs by modifying the log data retention period. For example, if you need
logs for only three days, set your log data retention period to a value of 3.
That way logs will be automatically deleted from your account after 3 days. This
section shows you how to view your current log data retention period, and then
update that period if that's what you want to do.

Note

These steps apply only for accounts that do not have the Hierarchical namespace
setting enabled on them. If you've enabled that setting on your account, then
the setting for retention days is not yet supported. Instead, you'll have to
delete logs manually by using any supported tool such as Azure Storage Explorer,
REST or an SDK. To find those logs in your storage account, see How logs are
stored.

 * Portal
 * PowerShell
 * .NET v12 SDK
 * .NET v11 SDK

 1. In the Azure portal, select Storage accounts, then the name of the storage
    account to open the storage account blade.

 2. Select Diagnostic settings (classic) in the Monitoring (classic) section of
    the menu blade.
    
    

 3. Ensure that the Delete data check box is selected. Then, set the number of
    days that you would like log data to be retained by moving the slider
    control beneath the check box, or by directly modifying the value that
    appears in the text box next to the slider control.
    
    
    
    The default number of days for new storage accounts is seven days. If you do
    not want to set a retention policy, enter zero. If there is no retention
    policy, it is up to you to delete the monitoring data.

 4. Click Save.
    
    The diagnostics logs are saved in a blob container named $logs in your
    storage account. You can view the log data using a storage explorer like the
    Microsoft Azure Storage Explorer, or programmatically using the storage
    client library or PowerShell.
    
    For information about accessing the $logs container, see Storage analytics
    logging.

 1. Open a Windows PowerShell command window.

 2. Sign in to your Azure subscription with the Connect-AzAccount command and
    follow the on-screen directions.
    
    Connect-AzAccount
    

 3. If your identity is associated with more than one subscription, then set
    your active subscription.
    
    $context = Get-AzSubscription -SubscriptionId <subscription-id>
    Set-AzContext $context
    
    
    Replace the <subscription-id> placeholder value with the ID of your
    subscription.

 4. Get the storage account context that defines the storage account.
    
    $storageAccount = Get-AzStorageAccount -ResourceGroupName "<resource-group-name>" -AccountName "<storage-account-name>"
    $ctx = $storageAccount.Context
    
    
    * Replace the <resource-group-name> placeholder value with the name of your
      resource group.
    
    * Replace the <storage-account-name> placeholder value with the name of your
      storage account.

 5. Use the Get-AzStorageServiceLoggingProperty to view the current log
    retention policy. The following example prints to the console the retention
    period for blob and queue storage services.
    
    Get-AzStorageServiceLoggingProperty -ServiceType Blob, Queue -Context $ctx
    
    
    In the console output, the retention period appears beneath the
    RetentionDays column heading.
    
    

 6. Use the Set-AzStorageServiceLoggingProperty to change the retention period.
    The following example changes the retention period to 4 days.
    
    Set-AzStorageServiceLoggingProperty -ServiceType Blob, Queue -RetentionDays 4 -Context $ctx
    
    
    For information about how to configure the Azure PowerShell cmdlets to work
    with your Azure subscription and how to select the default storage account
    to use, see: How to install and configure Azure PowerShell.

The following example prints to the console the retention period for blob and
queue storage services.

BlobServiceClient blobServiceClient = new BlobServiceClient(connectionString);
QueueServiceClient queueServiceClient = new QueueServiceClient(connectionString);

BlobServiceProperties blobServiceProperties = blobServiceClient.GetProperties().Value;
QueueServiceProperties queueServiceProperties = queueServiceClient.GetProperties().Value;

Console.WriteLine("Retention period for logs from the blob service is: " +
    blobServiceProperties.Logging.RetentionPolicy.Days.ToString());

Console.WriteLine("Retention period for logs from the queue service is: " +
    queueServiceProperties.Logging.RetentionPolicy.Days.ToString());


The following example changes the retention period to 4 days.

BlobRetentionPolicy blobRetentionPolicy = new BlobRetentionPolicy();

blobRetentionPolicy.Enabled = true;
blobRetentionPolicy.Days = 4;

QueueRetentionPolicy queueRetentionPolicy = new QueueRetentionPolicy();

queueRetentionPolicy.Enabled = true;
queueRetentionPolicy.Days = 4;

blobServiceProperties.Logging.RetentionPolicy = blobRetentionPolicy;
blobServiceProperties.Cors = null;

queueServiceProperties.Logging.RetentionPolicy = queueRetentionPolicy;
queueServiceProperties.Cors = null;

blobServiceClient.SetProperties(blobServiceProperties);
queueServiceClient.SetProperties(queueServiceProperties);

Console.WriteLine("Retention policy for blobs and queues is updated");


The following example prints to the console the retention period for blob and
queue storage services.

var storageAccount = CloudStorageAccount.Parse(connectionString);

var blobClient = storageAccount.CreateCloudBlobClient();
var queueClient = storageAccount.CreateCloudQueueClient();

var blobserviceProperties = blobClient.GetServiceProperties();
var queueserviceProperties = queueClient.GetServiceProperties();

Console.WriteLine("Retention period for logs from the blob service is: " +
   blobserviceProperties.Logging.RetentionDays.ToString());

Console.WriteLine("Retention period for logs from the queue service is: " +
   queueserviceProperties.Logging.RetentionDays.ToString());


The following example changes the retention period for logs for the blob and
queue storage services to 4 days.


blobserviceProperties.Logging.RetentionDays = 4;
queueserviceProperties.Logging.RetentionDays = 4;

blobClient.SetServiceProperties(blobserviceProperties);
queueClient.SetServiceProperties(queueserviceProperties);  



VERIFY THAT LOG DATA IS BEING DELETED

You can verify that logs are being deleted by viewing the contents of the $logs
container of your storage account. The following image shows the contents of a
folder in the $logs container. The folder corresponds to January 2021 and each
folder contains logs for one day. If the day today was January 29th 2021, and
your retention policy is set to only one day, then this folder should contain
logs for only one day.






VIEW LOG DATA

To view and analyze your log data, you should download the blobs that contain
the log data you are interested in to a local machine. Many storage-browsing
tools enable you to download blobs from your storage account; you can also use
the Azure Storage team provided command-line Azure Copy Tool AzCopy to download
your log data.

Note

The $logs container isn't integrated with Event Grid, so you won't receive
notifications when log files are written.

To make sure you download the log data you are interested in and to avoid
downloading the same log data more than once:

 * Use the date and time naming convention for blobs containing log data to
   track which blobs you have already downloaded for analysis to avoid
   re-downloading the same data more than once.

 * Use the metadata on the blobs containing log data to identify the specific
   period for which the blob holds log data to identify the exact blob you need
   to download.

To get started with AzCopy, see Get started with AzCopy

The following example shows how you can download the log data for the queue
service for the hours starting at 09 AM, 10 AM, and 11 AM on 20th May, 2014.

azcopy copy 'https://mystorageaccount.blob.core.windows.net/$logs/queue' 'C:\Logs\Storage' --include-path '2014/05/20/09;2014/05/20/10;2014/05/20/11' --recursive


To learn more about how to download specific files, see Download blobs from
Azure Blob storage by using AzCopy v10.

When you have downloaded your log data, you can view the log entries in the
files. These log files use a delimited text format that many log reading tools
are able to parse (for more information, see the guide Monitoring, Diagnosing,
and Troubleshooting Microsoft Azure Storage). Different tools have different
facilities for formatting, filtering, sorting, ad searching the contents of your
log files. For more information about the Storage Logging log file format and
content, see Storage Analytics Log Format and Storage Analytics Logged
Operations and Status Messages.


NEXT STEPS

 * To learn more about Storage Analytics, see Storage Analytics for Storage
   Analytics.
 * For more information about using a .NET language to configure Storage
   Logging, see Storage Client Library Reference.
 * For general information about configuring Storage Logging using the REST API,
   see Enabling and Configuring Storage Analytics.
 * Learn more about the format of Storage Analytics logs. See Storage Analytics
   Log Format.









FEEDBACK

Submit and view feedback for

This product This page
View all page feedback

Theme
 * Light
 * Dark
 * High contrast

 * 
 * Previous Version Docs
 * Blog
 * Contribute
 * Privacy & Cookies
 * Terms of Use
 * Trademarks
 * © Microsoft 2022


IN THIS ARTICLE




Theme
 * Light
 * Dark
 * High contrast

 * 
 * Previous Version Docs
 * Blog
 * Contribute
 * Privacy & Cookies
 * Terms of Use
 * Trademarks
 * © Microsoft 2022