Skip to content

Log Analytics .md files updates #14203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VeryEarly merged 4 commits into from
Feb 19, 2021
Merged

Log Analytics .md files updates #14203

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6cc382c
desc update and results
Sandido Feb 15, 2021
d1fcad9
changelog
Sandido Feb 15, 2021
e41630c
Update ChangeLog.md
wyunchi-ms Feb 17, 2021
eef9d5a
Update ChangeLog.md
Sandido Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Compute/Compute/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

-->
## Upcoming Release

@VeryEarly VeryEarly Feb 18, 2021

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no changelog needed for doc changes, please remove these section

@Sandido Sandido Feb 18, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated as suggested, @VeryEarly .

* Updated the documentation files for cmdlets `Export-AzLogAnalyticRequestRateByInterval` and `Export-AzLogAnalyticThrottledRequest`. Updates include showing the expected results and use of the new parameters `-GroupByUserAgent` and `-GroupByApplicationId`.

## Version 4.9.0
* Added parameter `-EnableAutomaticUpgrade` to `Set-AzVmExtension` and `Add-AzVmssExtension`.
Expand Down
27 changes: 26 additions & 1 deletion src/Compute/Compute/help/Export-AzLogAnalyticRequestRateByInterval.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Export-AzLogAnalyticRequestRateByInterval [-Location] <String> [-FromTime] <Date
```

## DESCRIPTION
Exports statistical data about the subscription's calls to the Microsoft.Compute API by Success, Failure, or Throttled status, in predefined time intervals. The logs can be further grouped by three parameters: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName.
Exports statistical data about the subscription's calls to the Microsoft.Compute API by Success, Failure, or Throttled status, in predefined time intervals. The logs can be further grouped by five parameters: GroupByOperationName, GroupByThrottlePolicy, GroupByResourceName, GroupByUserAgent, or GroupByApplicationId.
Note that this cmdlet collects only Compute Resource Provider logs; moreover, data about the Disk and Snapshot resource types is not yet available.

For an overview of the Compute Resource Provider's API throttling, see https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits.
Expand All @@ -30,20 +30,45 @@ For an overview of the Compute Resource Provider's API throttling, see https://d
### Example 1: Export records aggregated by operation name
```
PS C:\> Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByOperationName
This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP operationName TotalRequests SuccessfulRequests ThrottledRequests
--------- ------------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <operationName> 10 10 0
2/21/2018 7:30:00 PM <operationName> 8 8 0
2/21/2018 9:00:00 PM <operationName> 9 9 0

```

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name.

### Example 2: Export records aggregated by application id
```
PS C:\> Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByApplicationId

This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP clientApplicationId TotalRequests SuccessfulRequests ThrottledRequests
--------- ------------------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <clientApplicationId> 10 10 0
2/21/2018 7:30:00 PM <clientApplicationId> 8 8 0
2/21/2018 9:00:00 PM <clientApplicationId> 9 9 0

```

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by application id.

### Example 3: Export records aggregated by user agent
```
PS C:\> Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByUserAgent
This command downloads a .csv file to the provided container. The format of the file is:

TIMESTAMP userAgent TotalRequests SuccessfulRequests ThrottledRequests
--------- --------- ------------- ------------------ -----------------
2/21/2018 7:00:00 PM <userAgent> 10 10 0
2/21/2018 7:30:00 PM <userAgent> 8 8 0
2/21/2018 9:00:00 PM <userAgent> 9 9 0

```

This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by user agent.
Expand Down
2 changes: 1 addition & 1 deletion src/Compute/Compute/help/Export-AzLogAnalyticThrottledRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Export-AzLogAnalyticThrottledRequest [-Location] <String> [-FromTime] <DateTime>

## DESCRIPTION
This exports the total number of throttled Microsoft.Compute API calls.
The logs can be further aggregated by three options: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName.
The logs can be further aggregated by five options: GroupByOperationName, GroupByThrottlePolicy, GroupByResourceName, GroupByUserAgent, or GroupByApplicationId.
Note that this cmdlet collects only CRP logs.

For an overview of the Compute Resource Provider's API throttling, see https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits.
Expand Down