Skip to content
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

Monitor Query SDK README and samples updates #22221

Merged
merged 2 commits into from
Jun 30, 2021
Merged

Monitor Query SDK README and samples updates #22221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3af338
Rebase
scottaddie Jun 30, 2021
a184d97
Monitor Query SDK README/samples updates
scottaddie Jun 26, 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
98 changes: 55 additions & 43 deletions sdk/monitor/Azure.Monitor.Query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,46 @@
# Azure Monitor Query client library for .NET

The `Azure.Monitor.Query` package provides an ability to query [Azure Monitor Logs](https://docs.microsoft.com/azure/azure-monitor/logs/data-platform-logs) and [Azure Monitor Metrics](https://docs.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) data.
The `Azure.Monitor.Query` package provides the ability to query the following Azure Monitor data sources:

[Azure Monitor Logs](https://docs.microsoft.com/azure/azure-monitor/logs/data-platform-logs) is a feature of Azure Monitor that collects and organizes log and performance data from monitored resources. Data from different sources such as platform logs from Azure services, log and performance data from virtual machines agents, and usage and performance data from applications can be consolidated into a single workspace so they can be analyzed together using a sophisticated query language that's capable of quickly analyzing millions of records.

[Azure Monitor Metrics](https://docs.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) is a feature of Azure Monitor that collects numeric data from monitored resources into a time series database. Metrics are numerical values that are collected at regular intervals and describe some aspect of a system at a particular time. Metrics in Azure Monitor are lightweight and capable of supporting near real-time scenarios making them particularly useful for alerting and fast detection of issues.
- [Azure Monitor Logs](https://docs.microsoft.com/azure/azure-monitor/logs/data-platform-logs) - Collects and organizes log and performance data from monitored resources. Data from different sources such as platform logs from Azure services, log and performance data from virtual machines agents, and usage and performance data from apps can be consolidated into a single workspace. The various data types can be analyzed together using the [Kusto Query Language](https://docs.microsoft.com/azure/data-explorer/kusto/query).
- [Azure Monitor Metrics](https://docs.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) - Collects numeric data from monitored resources into a time series database. Metrics are numerical values that are collected at regular intervals and describe some aspect of a system at a particular time. Metrics in Azure Monitor are lightweight and capable of supporting near real-time scenarios, making them particularly useful for alerting and fast detection of issues.

[Source code][query_client_src] | [Package (NuGet)][query_client_nuget_package]

## Getting started

### Install the package

Install the Azure Monitor Query client library for .NET with [NuGet][query_client_nuget_package]:

```
dotnet add package Azure.Monitor.Query --prerelease
```

### Prerequisites
* An [Azure subscription][azure_sub].
* To be able to query logs you would need an existing Log Analytics workspace. You can create it in one of the following approaches:
* [Azure Portal](https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace)
* [Azure CLI](https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace-cli)
* [PowerShell](https://docs.microsoft.com/azure/azure-monitor/logs/powershell-workspace-configuration)

* To be able to query metrics all you need is an Azure resource of any kind (Storage Account, KeyVault, CosmosDB etc.)
- An [Azure subscription][azure_sub].
- To query logs, you need an existing Log Analytics workspace. You can create it with one of the following approaches:
- [Azure Portal](https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace)
- [Azure CLI](https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace-cli)
- [PowerShell](https://docs.microsoft.com/azure/azure-monitor/logs/powershell-workspace-configuration)
- To query metrics, all you need is an Azure resource of any kind (Storage Account, Key Vault, Cosmos DB, etc.).

### Authenticate the Client
### Authenticate the client

In order to interact with the Azure Monitor service, you will need to create an instance of a [TokenCredential](https://docs.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet) class and pass it to the constructor of your `LogsClient` or `MetricsClient` class.
To interact with the Azure Monitor service, create an instance of a [TokenCredential](https://docs.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet) class. Pass it to the constructor of your `LogsQueryClient` or `MetricsQueryClient` class.

## Key concepts

- `LogsClient` - Client that provides methods to query logs from Azure Monitor Logs.
- `MetricsClient` - Client that provides methods to query metrics from Azure Monitor Metrics.
- `LogsQueryClient` - Client that provides methods to query logs from Azure Monitor Logs.
- `MetricsQueryClient` - Client that provides methods to query metrics from Azure Monitor Metrics.

### Thread safety
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.

All client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.

### Additional concepts

<!-- CLIENT COMMON BAR -->
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
Expand All @@ -60,14 +62,17 @@ We guarantee that all client instance methods are thread-safe and independent of

### Query logs

You can query logs using the `LogsClient.QueryAsync`. The result would be returned as a table with a collection of rows:
You can query logs using the `LogsQueryClient.QueryAsync` method. The result is returned as a table with a collection of rows:

```C# Snippet:QueryLogsAsTable
var endpoint = new Uri("https://api.loganalytics.io");
string workspaceId = "<workspace_id>";

var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());
Response<LogsQueryResult> response = await client.QueryAsync(workspaceId, "AzureActivity | top 10 by TimeGenerated", TimeSpan.FromDays(1));
Response<LogsQueryResult> response = await client.QueryAsync(
workspaceId,
"AzureActivity | top 10 by TimeGenerated",
TimeSpan.FromDays(1));

LogsQueryResultTable table = response.Value.PrimaryTable;

Expand All @@ -79,7 +84,7 @@ foreach (var row in table.Rows)

### Query logs as model

You can map query results to a model using the `LogsClient.QueryAsync<T>` method.
You can map query results to a model using the `LogsQueryClient.QueryAsync<T>` method.

```C# Snippet:QueryLogsAsModelsModel
public class MyLogEntryModel
Expand All @@ -94,7 +99,8 @@ var client = new LogsQueryClient(TestEnvironment.LogsEndpoint, new DefaultAzureC
string workspaceId = "<workspace_id>";

// Query TOP 10 resource groups by event count
Response<IReadOnlyList<MyLogEntryModel>> response = await client.QueryAsync<MyLogEntryModel>(workspaceId,
Response<IReadOnlyList<MyLogEntryModel>> response = await client.QueryAsync<MyLogEntryModel>(
workspaceId,
"AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count",
TimeSpan.FromDays(1));

Expand All @@ -106,7 +112,7 @@ foreach (var logEntryModel in response.Value)

### Query logs as primitive

If your query return a single column (or a single value) of a primitive type you can use `LogsClient.QueryAsync<T>` overload to deserialize it:
If your query returns a single column (or a single value) of a primitive type, use the `LogsQueryClient.QueryAsync<T>` overload to deserialize it:

```C# Snippet:QueryLogsAsPrimitive
var endpoint = new Uri("https://api.loganalytics.io");
Expand All @@ -115,7 +121,8 @@ string workspaceId = "<workspace_id>";
var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());

// Query TOP 10 resource groups by event count
Response<IReadOnlyList<string>> response = await client.QueryAsync<string>(workspaceId,
Response<IReadOnlyList<string>> response = await client.QueryAsync<string>(
workspaceId,
"AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count | project ResourceGroup",
TimeSpan.FromDays(1));

Expand All @@ -127,7 +134,7 @@ foreach (var resourceGroup in response.Value)

### Batch query

You can execute multiple queries in on request using the `LogsClient.CreateBatchQuery`:
You can execute multiple queries in a single request using the `LogsQueryClient.CreateBatchQuery` method:

```C# Snippet:BatchQuery
var endpoint = new Uri("https://api.loganalytics.io");
Expand All @@ -139,8 +146,14 @@ var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());
// And total event count
var batch = new LogsBatchQuery();

string countQueryId = batch.AddQuery(workspaceId, "AzureActivity | count", TimeSpan.FromDays(1));
string topQueryId = batch.AddQuery(workspaceId, "AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count", TimeSpan.FromDays(1));
string countQueryId = batch.AddQuery(
workspaceId,
"AzureActivity | count",
TimeSpan.FromDays(1));
string topQueryId = batch.AddQuery(
workspaceId,
"AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count",
TimeSpan.FromDays(1));

Response<LogsBatchQueryResults> response = await client.QueryBatchAsync(batch);

Expand All @@ -156,14 +169,17 @@ foreach (var logEntryModel in topEntries)

### Query dynamic table

You can also dynamically inspect the list of columns. The following example prints the result of the query as a table:
You can also dynamically inspect the list of columns. The following example prints the query result as a table:

```C# Snippet:QueryLogsPrintTable
var endpoint = new Uri("https://api.loganalytics.io");
string workspaceId = "<workspace_id>";

var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());
Response<LogsQueryResult> response = await client.QueryAsync(workspaceId, "AzureActivity | top 10 by TimeGenerated", TimeSpan.FromDays(1));
Response<LogsQueryResult> response = await client.QueryAsync(
workspaceId,
"AzureActivity | top 10 by TimeGenerated",
TimeSpan.FromDays(1));

LogsQueryResultTable table = response.Value.PrimaryTable;

Expand Down Expand Up @@ -197,10 +213,11 @@ string workspaceId = "<workspace_id>";
var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());

// Query TOP 10 resource groups by event count
Response<IReadOnlyList<int>> response = await client.QueryAsync<int>(workspaceId,
Response<IReadOnlyList<int>> response = await client.QueryAsync<int>(
workspaceId,
"AzureActivity | summarize count()",
TimeSpan.FromDays(1),
options: new LogsQueryOptions()
options: new LogsQueryOptions
{
ServerTimeout = TimeSpan.FromMinutes(10)
});
Expand All @@ -211,9 +228,9 @@ foreach (var resourceGroup in response.Value)
}
```

### Querying metrics
### Query metrics

You can query metrics using the `MetricsClient.QueryAsync`. For every requested metric a set of aggregated values would be returned inside the `TimeSeries` collection.
You can query metrics using the `MetricsQueryClient.QueryAsync` method. For every requested metric, a set of aggregated values is returned inside the `TimeSeries` collection.

```C# Snippet:QueryMetrics
var endpoint = new Uri("https://management.azure.com");
Expand Down Expand Up @@ -248,7 +265,7 @@ foreach (var metric in results.Value.Metrics)

When you interact with the Azure Monitor Query client library using the .NET SDK, errors returned by the service correspond to the same HTTP status codes returned for [REST API][monitor_rest_api] requests.

For example, if you submit an invalid query a `400` error is returned, indicating "Bad Request".
For example, if you submit an invalid query, an HTTP 400 error is returned, indicating "Bad Request".

```C# Snippet:BadRequest
var endpoint = new Uri("https://api.loganalytics.io");
Expand All @@ -258,7 +275,8 @@ var client = new LogsQueryClient(endpoint, new DefaultAzureCredential());

try
{
await client.QueryAsync(workspaceId, "My Not So Valid Query", TimeSpan.FromDays(1));
await client.QueryAsync(
workspaceId, "My Not So Valid Query", TimeSpan.FromDays(1));
}
catch (Exception e)
{
Expand All @@ -279,28 +297,22 @@ Content:

### Setting up console logging

The simplest way to see the logs is to enable the console logging.
To create an Azure SDK log listener that outputs messages to console use AzureEventSourceListener.CreateConsoleLogger method.
The simplest way to see the logs is to enable the console logging. To create an Azure SDK log listener that outputs messages to the console, use the [AzureEventSourceListener.CreateConsoleLogger](https://docs.microsoft.com/dotnet/api/azure.core.diagnostics.azureeventsourcelistener.createconsolelogger?view=azure-dotnet) method:

```C#
// Setup a listener to monitor logged events.
// Set up a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
```

To learn more about other logging mechanisms see [here][logging].
To learn more about other logging mechanisms, see [here][logging].

## Next steps

## Contributing

This project welcomes contributions and suggestions. Most contributions require
you to agree to a Contributor License Agreement (CLA) declaring that you have
the right to, and actually do, grant us the rights to use your contribution. For
details, visit [cla.microsoft.com][cla].
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].

This project has adopted the [Microsoft Open Source Code of Conduct][coc].
For more information see the [Code of Conduct FAQ][coc_faq] or contact
[opencode@microsoft.com][coc_contact] with any additional questions or comments.
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.

[query_client_src]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/monitor/Azure.Monitor.Query/src
[query_client_nuget_package]: https://www.nuget.org/packages?q=Azure.Monitor.Query
Expand Down
32 changes: 24 additions & 8 deletions sdk/monitor/Azure.Monitor.Query/src/LogsQueryClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,16 @@ protected LogsQueryClient()
///
/// Example of querying a model:
/// <code snippet="Snippet:QueryLogsAsModelCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
/// </code>
///
/// Example of querying a primitive:
/// <code snippet="Snippet:QueryLogsAsPrimitiveCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count | project ResourceGroup&quot;,
/// TimeSpan.FromDays(1));
/// </code>
Expand All @@ -113,14 +115,16 @@ public virtual Response<IReadOnlyList<T>> Query<T>(string workspaceId, string qu
///
/// Example of querying a model:
/// <code snippet="Snippet:QueryLogsAsModelCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;MyLogEntryModel&gt;&gt; response = await client.QueryAsync&lt;MyLogEntryModel&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
/// </code>
///
/// Example of querying a primitive:
/// <code snippet="Snippet:QueryLogsAsPrimitiveCall" language="csharp">
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(workspaceId,
/// Response&lt;IReadOnlyList&lt;string&gt;&gt; response = await client.QueryAsync&lt;string&gt;(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count | project ResourceGroup&quot;,
/// TimeSpan.FromDays(1));
/// </code>
Expand Down Expand Up @@ -198,8 +202,14 @@ public virtual async Task<Response<LogsQueryResult>> QueryAsync(string workspace
/// // And total event count
/// var batch = new LogsBatchQuery();
///
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down Expand Up @@ -246,8 +256,14 @@ public virtual Response<LogsBatchQueryResults> QueryBatch(LogsBatchQuery batch,
/// // And total event count
/// var batch = new LogsBatchQuery();
///
/// string countQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | count&quot;, TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(workspaceId, &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;, TimeSpan.FromDays(1));
/// string countQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | count&quot;,
/// TimeSpan.FromDays(1));
/// string topQueryId = batch.AddQuery(
/// workspaceId,
/// &quot;AzureActivity | summarize Count = count() by ResourceGroup | top 10 by Count&quot;,
/// TimeSpan.FromDays(1));
///
/// Response&lt;LogsBatchQueryResults&gt; response = await client.QueryBatchAsync(batch);
///
Expand Down
Loading