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.

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

Rename query #19952

Merged
merged 4 commits into from
Jul 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions sdk/monitor/azure-monitor-query/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Release History


## 1.0.0b3 (Unreleased)

### Features Added
Expand All @@ -11,6 +12,7 @@
- `aggregation` param in the query API is renamed to `aggregations`
- `batch_query` API now returns a list of responses.
- `LogsBatchResults` model is now removed.
- `LogsQueryRequest` is renamed to `LogsBatchQueryRequest`

### Bugs Fixed

Expand Down
6 changes: 3 additions & 3 deletions sdk/monitor/azure-monitor-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,19 +194,19 @@ credential = DefaultAzureCredential()
client = LogsQueryClient(credential)

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query="AzureActivity | summarize count()",
duration=timedelta(hours=1),
workspace_id=os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= """AppRequests | take 10 |
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
duration=timedelta(hours=1),
start_time=datetime(2021, 6, 2),
workspace_id=os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= "AppRequests | take 2",
workspace_id=os.environ['LOG_WORKSPACE_ID']
),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
LogsQueryResultColumn,
MetricsResult,
LogsBatchResultError,
LogsQueryRequest,
LogsBatchQueryRequest,
MetricNamespace,
MetricDefinition,
MetricsMetadataValue,
Expand All @@ -33,7 +33,7 @@
"LogsQueryResults",
"LogsQueryResultColumn",
"LogsQueryResultTable",
"LogsQueryRequest",
"LogsBatchQueryRequest",
"MetricsQueryClient",
"MetricNamespace",
"MetricDefinition",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

from ._generated.models import BatchRequest, QueryBody as LogsQueryBody
from ._helpers import get_authentication_policy, process_error, construct_iso8601, order_results
from ._models import LogsQueryResults, LogsQueryRequest, LogsQueryResult
from ._models import LogsQueryResults, LogsBatchQueryRequest, LogsQueryResult

if TYPE_CHECKING:
from azure.core.credentials import TokenCredential
Expand Down Expand Up @@ -131,14 +131,14 @@ def query(self, workspace_id, query, duration=None, **kwargs):
process_error(e)

def batch_query(self, queries, **kwargs):
# type: (Union[Sequence[Dict], Sequence[LogsQueryRequest]], Any) -> Sequence[LogsQueryResult]
# type: (Union[Sequence[Dict], Sequence[LogsBatchQueryRequest]], Any) -> Sequence[LogsQueryResult]
"""Execute a list of analytics queries. Each request can be either a LogQueryRequest
object or an equivalent serialized model.

The response is returned in the same order as that of the requests sent.

:param queries: The list of queries that should be processed
:type queries: list[dict] or list[~azure.monitor.query.LogsQueryRequest]
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQueryRequest]
:return: BatchResponse, or the result of cls(response)
:rtype: ~list[~azure.monitor.query.LogsQueryResult]
:raises: ~azure.core.exceptions.HttpResponseError
Expand All @@ -153,7 +153,7 @@ def batch_query(self, queries, **kwargs):
:caption: Get a response for multiple Log Queries.
"""
try:
queries = [LogsQueryRequest(**q) for q in queries]
queries = [LogsBatchQueryRequest(**q) for q in queries]
except (KeyError, TypeError):
pass
try:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def _from_generated(cls, generated):
metrics=[Metric._from_generated(m) for m in generated.value] # pylint: disable=protected-access
)

class LogsQueryRequest(InternalLogQueryRequest):
class LogsBatchQueryRequest(InternalLogQueryRequest):
"""A single request in a batch.

Variables are only populated by the server, and will be ignored when sending a request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

from .._generated.models import BatchRequest, QueryBody as LogsQueryBody
from .._helpers import process_error, construct_iso8601, order_results
from .._models import LogsQueryResults, LogsQueryRequest, LogsQueryResult
from .._models import LogsQueryResults, LogsBatchQueryRequest, LogsQueryResult
from ._helpers_asyc import get_authentication_policy

if TYPE_CHECKING:
Expand Down Expand Up @@ -116,7 +116,7 @@ async def query(

async def batch_query(
self,
queries: Union[Sequence[Dict], Sequence[LogsQueryRequest]],
queries: Union[Sequence[Dict], Sequence[LogsBatchQueryRequest]],
**kwargs: Any
) -> Sequence[LogsQueryResult]:
"""Execute a list of analytics queries. Each request can be either a LogQueryRequest
Expand All @@ -125,13 +125,13 @@ async def batch_query(
The response is returned in the same order as that of the requests sent.

:param queries: The list of queries that should be processed
:type queries: list[dict] or list[~azure.monitor.query.LogsQueryRequest]
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQueryRequest]
:return: BatchResponse, or the result of cls(response)
:rtype: ~list[~azure.monitor.query.LogsQueryResult]
:raises: ~azure.core.exceptions.HttpResponseError
"""
try:
queries = [LogsQueryRequest(**q) for q in queries]
queries = [LogsBatchQueryRequest(**q) for q in queries]
except (KeyError, TypeError):
pass
try:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from datetime import datetime, timedelta
import os
import pandas as pd
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest
from azure.identity import DefaultAzureCredential


Expand All @@ -14,19 +14,19 @@

# [START send_batch_query]
requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query="AzureActivity | summarize count()",
duration=timedelta(hours=1),
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= """AppRequests | take 10 |
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
duration=timedelta(hours=1),
start_time=datetime(2021, 6, 2),
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= "AppRequests | take 5",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
include_statistics=True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os
from azure.identity.aio import ClientSecretCredential
from azure.core.exceptions import HttpResponseError
from azure.monitor.query import LogsQueryRequest
from azure.monitor.query import LogsBatchQueryRequest
from azure.monitor.query.aio import LogsQueryClient

def _credential():
Expand Down Expand Up @@ -44,18 +44,18 @@ async def test_logs_batch_query():
client = LogsQueryClient(_credential())

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query="AzureActivity | summarize count()",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= """AppRequests | take 10 |
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= "AppRequests | take 2",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
Expand Down Expand Up @@ -90,19 +90,19 @@ async def test_logs_batch_query_additional_workspaces():
query = "union * | where TimeGenerated > ago(100d) | project TenantId | summarize count() by TenantId"

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query,
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
),
LogsQueryRequest(
LogsBatchQueryRequest(
query,
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
),
LogsQueryRequest(
LogsBatchQueryRequest(
query,
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
Expand Down
20 changes: 10 additions & 10 deletions sdk/monitor/azure-monitor-query/tests/test_logs_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os
from azure.identity import ClientSecretCredential
from azure.core.exceptions import HttpResponseError
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest

def _credential():
credential = ClientSecretCredential(
Expand Down Expand Up @@ -66,18 +66,18 @@ def test_logs_batch_query():
client = LogsQueryClient(_credential())

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query="AzureActivity | summarize count()",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= """AppRequests | take 10 |
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= "AppRequests | take 2",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
Expand All @@ -102,19 +102,19 @@ def test_logs_batch_query_with_statistics_in_some():
client = LogsQueryClient(_credential())

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query="AzureActivity | summarize count()",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID']
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= """AppRequests|
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
include_statistics=True
),
LogsQueryRequest(
LogsBatchQueryRequest(
query= "AppRequests",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
include_statistics=True
Expand Down Expand Up @@ -150,19 +150,19 @@ def test_logs_batch_query_additional_workspaces():
query = "union * | where TimeGenerated > ago(100d) | project TenantId | summarize count() by TenantId"

requests = [
LogsQueryRequest(
LogsBatchQueryRequest(
query,
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
),
LogsQueryRequest(
LogsBatchQueryRequest(
query,
timespan="PT1H",
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
),
LogsQueryRequest(
LogsBatchQueryRequest(
query,
workspace_id= os.environ['LOG_WORKSPACE_ID'],
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

from azure.identity import ClientSecretCredential
from azure.core.exceptions import HttpResponseError
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest

from azure.monitor.query._helpers import construct_iso8601

Expand Down