Add Javadocs for Monitor Query #38475
Merged
+415
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
API change check API changes are not detected in this pull request. |
g2vinay
requested review from
KevinBlasko,
ToddKingMSFT,
gulopesd,
nisha-bhatia,
pvaneck,
sarangan12 and
scottaddie
g2vinay
changed the title
jairmyree
approved these changes
Mar 21, 2024
srnagar
reviewed
Mar 21, 2024
| * <p><strong>Instantiating an asynchronous Logs query Client</strong></p> | ||
| * <p>Provides an asynchronous service client for querying logs in the Azure Monitor Service.</p> | ||
| * | ||
| * <p>The LogsQueryClient is an asynchronous client that provides methods to execute Kusto queries against |
| * <p>Fluent builder for creating instances of {@link LogsQueryClient} and {@link LogsQueryAsyncClient}.</p> | ||
| * | ||
| * <p><strong>Instantiating an asynchronous Logs query Client</strong></p> | ||
| * <p>The LogsQueryClientBuilder is responsible for authenticating a building instances of {@link LogsQueryClient} and |
Member
There was a problem hiding this comment.
for authenticating should be removed
| * <!-- end com.azure.monitor.query.LogsQueryAsyncClient.instantiation --> | ||
| * | ||
| * <p><strong>Instantiating a synchronous Logs query Client</strong></p> | ||
| * <p>The following sample shows instantiating a synchronous Logs query Client using Token Credential</p> |
Member
There was a problem hiding this comment.
Client -> client and using Token Credential should be updated to using {@link TokenCredential}
Comment on lines
+40
to
+41
| * of a system at a particular time. The MetricsQueryClient provides synchronous implementations of methods that query | ||
| * metrics from your Azure services.</p> |
Member
There was a problem hiding this comment.
This should be about the async client.
| * | ||
| * <p> | ||
| * Authenticating and building MetricsQueryAsyncClient instances are done through {@link MetricsQueryClientBuilder}. | ||
| * The following sample shows how to build a new MetricsQueryClient instance. |
Member
There was a problem hiding this comment.
MetricsQueryClient -> MetricsQueryAsyncClient
| */ | ||
| public MetricsQueryResourcesOptions() { } | ||
|
|
||
| private String rollupBy; |
Member
There was a problem hiding this comment.
The constructor should be below this property.
| /** | ||
| * Package containing clients for querying logs and metrics from Azure Monitor. | ||
| * <p>Azure Monitor Query service is a powerful tool that allows you to query and analyze log data from various sources | ||
| * in Azure. It is built on top of the Kusto Query Language (KQL), which is a powerful query language that allows you |
Member
There was a problem hiding this comment.
Only logs query uses Kusto Query Language. Metrics queries don't. So, we should update this doc to differentiate.
| * to perform complex queries on large datasets. With Azure Monitor Query, you can easily search and analyze | ||
| * log data from various sources, including virtual machines, containers, and applications.</p> | ||
| * | ||
| * <p>Azure Monitor Query java client library is a library that allows you to execute read-only queries against |
Member
There was a problem hiding this comment.
Azure Monitor Query java client library allows you to execute
| * | ||
| * <h2>Getting Started</h2> | ||
| * | ||
| * <p>In order to interact with the Monitor service you'll need to create an instance of the |
Member
There was a problem hiding this comment.
interact with the Azure Monitor service
Comment on lines
+93
to
+106
| * <p>The sample below shows how to query logs from the last 24 hours</p> | ||
| * | ||
| * <!-- src_embed com.azure.monitor.query.LogsQueryClient.query#String-String-QueryTimeInterval --> | ||
| * <pre> | ||
| * LogsQueryResult queryResult = logsQueryClient.queryWorkspace("{workspace-id}", "{kusto-query}", | ||
| * QueryTimeInterval.LAST_DAY); | ||
| * for (LogsTableRow row : queryResult.getTable().getRows()) { | ||
| * System.out.println(row.getRow() | ||
| * .stream() | ||
| * .map(LogsTableCell::getValueAsString) | ||
| * .collect(Collectors.joining(","))); | ||
| * } | ||
| * </pre> | ||
| * <!-- end com.azure.monitor.query.LogsQueryClient.query#String-String-QueryTimeInterval --> |
Member
There was a problem hiding this comment.
We should have a sample for querying metrics too if we are going to add a sample for querying logs here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Revamps Javadocs for Azure Monitor Query.