Skip to content

Add query type schemas for timeseries-query data sources #3379

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add query type schemas for timeseries-query data sources #3379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
575 changes: 575 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

140 changes: 140 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,69 @@ datadog\_api\_client.v2.model.api\_trigger\_wrapper module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_dependency\_stat\_name module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_dependency_stat_name
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_dependency\_stats\_data\_source module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_dependency_stats_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_dependency\_stats\_query module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_dependency_stats_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_metrics\_data\_source module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_metrics_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_metrics\_query module
--------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_metrics_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_metrics\_stat module
-------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_metrics_stat
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_resource\_stat\_name module
--------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_resource_stat_name
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_resource\_stats\_data\_source module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_resource_stats_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_resource\_stats\_query module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.apm_resource_stats_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.apm\_retention\_filter\_type module
-----------------------------------------------------------------

Expand Down Expand Up @@ -5527,6 +5590,13 @@ datadog\_api\_client.v2.model.container\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container\_data\_source module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.container_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container\_group module
-----------------------------------------------------

Expand Down Expand Up @@ -5716,6 +5786,20 @@ datadog\_api\_client.v2.model.container\_meta\_page\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container\_scalar\_query module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.container_scalar_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container\_timeseries\_query module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.container_timeseries_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container\_type module
----------------------------------------------------

Expand Down Expand Up @@ -22159,6 +22243,20 @@ datadog\_api\_client.v2.model.preview\_entity\_response\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.process\_data\_source module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.process_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.process\_scalar\_query module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.process_scalar_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.process\_summaries\_meta module
-------------------------------------------------------------

Expand Down Expand Up @@ -22201,6 +22299,13 @@ datadog\_api\_client.v2.model.process\_summary\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.process\_timeseries\_query module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.process_timeseries_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.product\_analytics\_analytics\_query module
-------------------------------------------------------------------------

Expand Down Expand Up @@ -28291,6 +28396,20 @@ datadog\_api\_client.v2.model.slack\_trigger\_wrapper module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slo\_data\_source module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.slo_data_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slo\_query module
-----------------------------------------------

.. automodule:: datadog_api_client.v2.model.slo_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slo\_report\_create\_request module
-----------------------------------------------------------------

Expand Down Expand Up @@ -28389,6 +28508,27 @@ datadog\_api\_client.v2.model.slo\_status\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slos\_group\_mode module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.slos_group_mode
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slos\_measure module
--------------------------------------------------

.. automodule:: datadog_api_client.v2.model.slos_measure
:members:
:show-inheritance:

datadog\_api\_client.v2.model.slos\_query\_type module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.slos_query_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.snapshot module
---------------------------------------------

Expand Down
60 changes: 60 additions & 0 deletions examples/v2/metrics/QueryScalarData_1479548882.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
"""
Scalar cross product query with apm_resource_stats data source returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.metrics_api import MetricsApi
from datadog_api_client.v2.model.apm_resource_stat_name import ApmResourceStatName
from datadog_api_client.v2.model.apm_resource_stats_data_source import ApmResourceStatsDataSource
from datadog_api_client.v2.model.apm_resource_stats_query import ApmResourceStatsQuery
from datadog_api_client.v2.model.formula_limit import FormulaLimit
from datadog_api_client.v2.model.query_formula import QueryFormula
from datadog_api_client.v2.model.query_sort_order import QuerySortOrder
from datadog_api_client.v2.model.scalar_formula_query_request import ScalarFormulaQueryRequest
from datadog_api_client.v2.model.scalar_formula_request import ScalarFormulaRequest
from datadog_api_client.v2.model.scalar_formula_request_attributes import ScalarFormulaRequestAttributes
from datadog_api_client.v2.model.scalar_formula_request_queries import ScalarFormulaRequestQueries
from datadog_api_client.v2.model.scalar_formula_request_type import ScalarFormulaRequestType

body = ScalarFormulaQueryRequest(
data=ScalarFormulaRequest(
attributes=ScalarFormulaRequestAttributes(
formulas=[
QueryFormula(
formula="a",
limit=FormulaLimit(
count=10,
order=QuerySortOrder.DESC,
),
),
],
_from=1636625471000,
queries=ScalarFormulaRequestQueries(
[
ApmResourceStatsQuery(
data_source=ApmResourceStatsDataSource.APM_RESOURCE_STATS,
name="a",
env="staging",
service="azure-bill-import",
stat=ApmResourceStatName.HITS,
operation_name="cassandra.query",
group_by=[
"resource_name",
],
primary_tag_name="datacenter",
primary_tag_value="*",
),
]
),
to=1636629071000,
),
type=ScalarFormulaRequestType.SCALAR_REQUEST,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = MetricsApi(api_client)
response = api_instance.query_scalar_data(body=body)

print(response)
57 changes: 57 additions & 0 deletions examples/v2/metrics/QueryScalarData_1904811219.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
"""
Scalar cross product query with apm_metrics data source returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.metrics_api import MetricsApi
from datadog_api_client.v2.model.apm_metrics_data_source import ApmMetricsDataSource
from datadog_api_client.v2.model.apm_metrics_query import ApmMetricsQuery
from datadog_api_client.v2.model.apm_metrics_stat import ApmMetricsStat
from datadog_api_client.v2.model.formula_limit import FormulaLimit
from datadog_api_client.v2.model.query_formula import QueryFormula
from datadog_api_client.v2.model.query_sort_order import QuerySortOrder
from datadog_api_client.v2.model.scalar_formula_query_request import ScalarFormulaQueryRequest
from datadog_api_client.v2.model.scalar_formula_request import ScalarFormulaRequest
from datadog_api_client.v2.model.scalar_formula_request_attributes import ScalarFormulaRequestAttributes
from datadog_api_client.v2.model.scalar_formula_request_queries import ScalarFormulaRequestQueries
from datadog_api_client.v2.model.scalar_formula_request_type import ScalarFormulaRequestType

body = ScalarFormulaQueryRequest(
data=ScalarFormulaRequest(
attributes=ScalarFormulaRequestAttributes(
formulas=[
QueryFormula(
formula="a",
limit=FormulaLimit(
count=10,
order=QuerySortOrder.DESC,
),
),
],
_from=1636625471000,
queries=ScalarFormulaRequestQueries(
[
ApmMetricsQuery(
data_source=ApmMetricsDataSource.APM_METRICS,
name="a",
stat=ApmMetricsStat.HITS,
service="web-store",
query_filter="env:prod",
group_by=[
"resource_name",
],
),
]
),
to=1636629071000,
),
type=ScalarFormulaRequestType.SCALAR_REQUEST,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = MetricsApi(api_client)
response = api_instance.query_scalar_data(body=body)

print(response)
58 changes: 58 additions & 0 deletions examples/v2/metrics/QueryScalarData_2298288525.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
"""
Scalar cross product query with slo data source returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.metrics_api import MetricsApi
from datadog_api_client.v2.model.formula_limit import FormulaLimit
from datadog_api_client.v2.model.query_formula import QueryFormula
from datadog_api_client.v2.model.query_sort_order import QuerySortOrder
from datadog_api_client.v2.model.scalar_formula_query_request import ScalarFormulaQueryRequest
from datadog_api_client.v2.model.scalar_formula_request import ScalarFormulaRequest
from datadog_api_client.v2.model.scalar_formula_request_attributes import ScalarFormulaRequestAttributes
from datadog_api_client.v2.model.scalar_formula_request_queries import ScalarFormulaRequestQueries
from datadog_api_client.v2.model.scalar_formula_request_type import ScalarFormulaRequestType
from datadog_api_client.v2.model.slo_data_source import SloDataSource
from datadog_api_client.v2.model.slo_query import SloQuery
from datadog_api_client.v2.model.slos_group_mode import SlosGroupMode
from datadog_api_client.v2.model.slos_measure import SlosMeasure
from datadog_api_client.v2.model.slos_query_type import SlosQueryType

body = ScalarFormulaQueryRequest(
data=ScalarFormulaRequest(
attributes=ScalarFormulaRequestAttributes(
formulas=[
QueryFormula(
formula="a",
limit=FormulaLimit(
count=10,
order=QuerySortOrder.DESC,
),
),
],
_from=1636625471000,
queries=ScalarFormulaRequestQueries(
[
SloQuery(
data_source=SloDataSource.SLO,
name="a",
slo_id="12345678910",
measure=SlosMeasure.SLO_STATUS,
slo_query_type=SlosQueryType.METRIC,
group_mode=SlosGroupMode.OVERALL,
additional_query_filters="*",
),
]
),
to=1636629071000,
),
type=ScalarFormulaRequestType.SCALAR_REQUEST,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = MetricsApi(api_client)
response = api_instance.query_scalar_data(body=body)

print(response)
Loading
Loading