Board Review: Introducing Azure Monitor Logs and Metrics query

[srnagar]

Thank you for starting the process for approval of the client library for your Azure service. Thorough review of your client library ensures that your APIs are consistent with the guidelines and the consumers of your client library have a consistently good experience when using Azure.

The Architecture Board reviews Track 2 libraries only. If your library does not meet this requirement, please reach out to Architecture Board before creating the issue.

Please reference our review process guidelines to understand what is being asked for in the issue template.

Before submitting, ensure you adjust the title of the issue appropriately.

Note that the required material must be included before a meeting can be scheduled.

Contacts and Timeline

• Service team responsible for the client library: SDK team
• Main contacts: Josh Free, Srikanta Nagaraja, Pavel Krymets, Rakshit Bhyravabhotla, Richard Park, Karishma Ghiya
• Expected GA date for this library: September 2021

About the Service

• Link to documentation introducing/describing the service:
  https://docs.microsoft.com/en-us/azure/azure-monitor/overview
  https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/data-platform-metrics
  https://docs.microsoft.com/en-us/azure/azure-monitor/logs/data-platform-logs

• Link to the service REST APIs:

  • Logs
  • Metrics
  • Metrics Definitions
  • Metrics Namespaces

• Is the goal to release a Public Preview, Private Preview, or GA?
  Public Preview

About the client library

• Name of client library: Azure Monitor Log and Metrics Query
• Link to library reference documentation:
• Is there an existing SDK library? If yes, provide link:

Step 1: Champion Scenarios

Ultimately the library should be easy to use for common scenarios that developers want. Consider the following questions when thinking about champion scenarios:

1. What is the app the developer is building that uses your client library?
2. Who is the end-user of the application (the developer's customer)?
3. What features of the API need to be explained in the sample so that someone could use this API in real app?
4. How does the authentication workflow look?

See Champion Scenario section here.

Code is appreciated but optional. Pseudocode is fine.

• Champion scenario 1
  Make a simple query to the service "requests | summarize count() by bin(timestamp, 1h)", "timestamp = P1D"

  • Get the results in tabular form
  • Get the results in key-value form

• Champion scenario 2
  Run 5 queries in 1 api call

  • Get the results in tabular form
  • Get the results in key-value form

• Champion scenario 3
  Run a complex query that requires a longer duration to complete and extend server timeout (default 3 minutes) to allow query execution to complete.

• Champion scenario 4
  Query metrics for an Azure resource id.

Artifacts required (per language)

Please read through “API Review” section here to understand how these artifacts are generated. It is critical that these artifacts are present and are in the right format. If not, the language architects cannot review them with the SDK Team’s API review tool.

.NET

• APIView Link: link
• Link to Champion Scenarios/Quickstart samples: link

Java

• APIView Link: link
• Link to Champion Scenarios/Quickstart samples: link

Python

• APIView Link: link
• Link to Champion Scenarios/Quickstart samples: link

TypeScript

• APIView Link: link
• Link to Champion Scenarios/Quickstart samples: link

Thank you for your submission!

[lilyjma]

scheduled for 5/6

[tg-msft]

Recording[MS INTERNAL ONLY]

[lilyjma]

scheduled for 8/24 2-4pm pst

[tg-msft]

Recording[MS INTERNAL ONLY]

[scottaddie]

Round 2 (.NET and JS) scheduled for 8/25 @ 3:00 - 4:00 PM PST

[srnagar]

Recording[MS INTERNAL ONLY]

[srnagar]

Closing this issue as the Azure Monitor Query library is now GA in all tier-1 languages.