Share via

LogsQueryClient Class

Package:
com.azure.monitor.query
Maven Artifact:
com.azure:azure-monitor-query:1.3.0-beta.3
  • java.lang.Object
    • com.azure.monitor.query.LogsQueryClient

public final class LogsQueryClient

The synchronous client for querying Azure Monitor logs.

Instantiating a synchronous Logs query Client

LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
         .credential(tokenCredential)
         .buildClient();

Method Summary

Modifier and Type Method and Description
LogsBatchQueryResultCollection queryBatch(LogsBatchQuery logsBatchQuery)

Returns all the Azure Monitor logs matching the given batch of queries.
Response<LogsBatchQueryResultCollection> queryBatchWithResponse(LogsBatchQuery logsBatchQuery, Context context)

Returns all the Azure Monitor logs matching the given batch of queries.
LogsQueryResult queryResource(String resourceId, String query, QueryTimeInterval timeInterval)

Returns all the Azure Monitor logs matching the given query for an Azure resource.
List<T> queryResource(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type)

Returns all the Azure Monitor logs matching the given query for an Azure resource.
List<T> queryResource(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options)

Returns all the Azure Monitor logs matching the given query for an Azure resource.
Response<List<T>> queryResourceWithResponse(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query for an Azure resource.
Response<LogsQueryResult> queryResourceWithResponse(String resourceId, String query, QueryTimeInterval timeInterval, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query for an Azure resource.
LogsQueryResult queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.
List<T> queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.
List<T> queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.
Response<List<T>> queryWorkspaceWithResponse(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.
Response<LogsQueryResult> queryWorkspaceWithResponse(String workspaceId, String query, QueryTimeInterval timeInterval, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

queryBatch

public LogsBatchQueryResultCollection queryBatch(LogsBatchQuery logsBatchQuery)

Returns all the Azure Monitor logs matching the given batch of queries.

Execute a batch of logs queries

LogsBatchQuery batchQuery = new LogsBatchQuery();
 String queryId1 = batchQuery.addWorkspaceQuery("{workspace-id-1}", "{kusto-query-1}", QueryTimeInterval.LAST_DAY);
 String queryId2 = batchQuery.addWorkspaceQuery("{workspace-id-2}", "{kusto-query-2}",
         QueryTimeInterval.LAST_7_DAYS, new LogsQueryOptions().setServerTimeout(Duration.ofMinutes(2)));

 LogsBatchQueryResultCollection batchQueryResponse = logsQueryClient.queryBatch(batchQuery);

 for (LogsBatchQueryResult queryResult : batchQueryResponse.getBatchResults()) {
     System.out.println("Logs query result for query id " + queryResult.getId());
     for (LogsTableRow row : queryResult.getTable().getRows()) {
         System.out.println(row.getRow()
                 .stream()
                 .map(LogsTableCell::getValueAsString)
                 .collect(Collectors.joining(",")));
     }
 }

Parameters:

logsBatchQuery - LogsBatchQuery containing a batch of queries.

Returns:

A collection of query results corresponding to the input batch of queries.@return

queryBatchWithResponse

public Response<LogsBatchQueryResultCollection> queryBatchWithResponse(LogsBatchQuery logsBatchQuery, Context context)

Returns all the Azure Monitor logs matching the given batch of queries.

Parameters:

logsBatchQuery - LogsBatchQuery containing a batch of queries.
context - Additional context that is passed through the Http pipeline during the service call. If no additional context is required, pass NONE instead.

Returns:

A collection of query results corresponding to the input batch of queries.@return

queryResource

public LogsQueryResult queryResource(String resourceId, String query, QueryTimeInterval timeInterval)

Returns all the Azure Monitor logs matching the given query for an Azure resource.

Query logs from the last 24 hours

LogsQueryResult queryResult = logsQueryClient.queryResource("{resource-id}", "{kusto-query}",
     QueryTimeInterval.LAST_DAY);
 for (LogsTableRow row : queryResult.getTable().getRows()) {
     System.out.println(row.getRow()
         .stream()
         .map(LogsTableCell::getValueAsString)
         .collect(Collectors.joining(",")));
 }

Parameters:

resourceId - The resourceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.

Returns:

The logs matching the query.

queryResource

public List<T> <T>queryResource(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type)

Returns all the Azure Monitor logs matching the given query for an Azure resource.

Parameters:

resourceId - The resourceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.

Returns:

The logs matching the query as a list of objects of type T.

queryResource

public List<T> <T>queryResource(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options)

Returns all the Azure Monitor logs matching the given query for an Azure resource.

Parameters:

resourceId - The resourceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.

Returns:

The logs matching the query as a list of objects of type T.

queryResourceWithResponse

public Response<List<T>> <T>queryResourceWithResponse(String resourceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query for an Azure resource.

Parameters:

resourceId - The resourceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.
context - Additional context that is passed through the Http pipeline during the service call. If no additional context is required, pass NONE instead.

Returns:

The logs matching the query including the HTTP response.

queryResourceWithResponse

public Response<LogsQueryResult> queryResourceWithResponse(String resourceId, String query, QueryTimeInterval timeInterval, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query for an Azure resource.

Query logs from the last 7 days and set the service timeout to 2 minutes

Response<LogsQueryResult> queryResult = logsQueryClient.queryResourceWithResponse("{resource-id}",
     "{kusto-query}",
     QueryTimeInterval.LAST_7_DAYS,
     new LogsQueryOptions().setServerTimeout(Duration.ofMinutes(2)),
     Context.NONE);

 for (LogsTableRow row : queryResult.getValue().getTable().getRows()) {
     System.out.println(row.getRow()
         .stream()
         .map(LogsTableCell::getValueAsString)
         .collect(Collectors.joining(",")));
 }

Parameters:

resourceId - The resourceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.
context - Additional context that is passed through the Http pipeline during the service call. If no additional context is required, pass NONE instead.

Returns:

The logs matching the query including the HTTP response.

queryWorkspace

public LogsQueryResult queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Query logs from the last 24 hours

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(",")));
 }

Parameters:

workspaceId - The workspaceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.

Returns:

The logs matching the query.

queryWorkspace

public List<T> <T>queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Parameters:

workspaceId - The workspaceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.

Returns:

The logs matching the query as a list of objects of type T.

queryWorkspace

public List<T> <T>queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Parameters:

workspaceId - The workspaceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.

Returns:

The logs matching the query as a list of objects of type T.

queryWorkspaceWithResponse

public Response<List<T>> <T>queryWorkspaceWithResponse(String workspaceId, String query, QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Parameters:

workspaceId - The workspaceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
type - The type the result of this query should be mapped to.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.
context - Additional context that is passed through the Http pipeline during the service call. If no additional context is required, pass NONE instead.

Returns:

The logs matching the query including the HTTP response.

queryWorkspaceWithResponse

public Response<LogsQueryResult> queryWorkspaceWithResponse(String workspaceId, String query, QueryTimeInterval timeInterval, LogsQueryOptions options, Context context)

Returns all the Azure Monitor logs matching the given query in the specified workspaceId.

Query logs from the last 7 days and set the service timeout to 2 minutes

Response<LogsQueryResult> queryResult = logsQueryClient.queryWorkspaceWithResponse("{workspace-id}",
         "{kusto-query}",
         QueryTimeInterval.LAST_7_DAYS,
         new LogsQueryOptions().setServerTimeout(Duration.ofMinutes(2)),
         Context.NONE);

 for (LogsTableRow row : queryResult.getValue().getTable().getRows()) {
     System.out.println(row.getRow()
             .stream()
             .map(LogsTableCell::getValueAsString)
             .collect(Collectors.joining(",")));
 }

Parameters:

workspaceId - The workspaceId where the query should be executed.
query - The Kusto query to fetch the logs.
timeInterval - The time period for which the logs should be looked up.
options - The log query options to configure server timeout, set additional workspaces or enable statistics and rendering information in response.
context - Additional context that is passed through the Http pipeline during the service call. If no additional context is required, pass NONE instead.

Returns:

The logs matching the query including the HTTP response.

Applies to