Add support for querying logs in Online Archives (#1199)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-10-24 13:15:53.347203",
-            "spec_repo_commit": "18dc2450"
+            "regenerated": "2022-10-25 14:15:26.509580",
+            "spec_repo_commit": "ecf2f022"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-10-24 13:15:53.359570",
-            "spec_repo_commit": "18dc2450"
+            "regenerated": "2022-10-25 14:15:26.532267",
+            "spec_repo_commit": "ecf2f022"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -5235,6 +5235,8 @@ components:
           description: The search query - following the log search syntax.
           example: service:web* AND @http.status_code:[200 TO 299]
           type: string
+        storage_tier:
+          $ref: '#/components/schemas/LogsStorageTier'
         to:
           default: now
           description: The maximum time for the requested logs, supports date math
@@ -5314,6 +5316,17 @@ components:
       x-enum-varnames:
       - ASCENDING
       - DESCENDING
+    LogsStorageTier:
+      default: indexes
+      description: Specifies storage type as indexes or online-archives
+      enum:
+      - indexes
+      - online-archives
+      example: indexes
+      type: string
+      x-enum-varnames:
+      - INDEXES
+      - ONLINE_ARCHIVES
     LogsWarning:
       description: A warning message indicating something that went wrong with the
         query
@@ -13136,6 +13149,13 @@ paths:
         schema:
           format: date-time
           type: string
+      - description: Specifies the storage type to be used
+        example: indexes
+        in: query
+        name: filter[storage_tier]
+        required: false
+        schema:
+          $ref: '#/components/schemas/LogsStorageTier'
       - description: Order of logs in results.
         in: query
         name: sort

docs/datadog_api_client.v2.model.rst

@@ -2304,6 +2304,13 @@ logs\_sort\_order
    :members:
    :show-inheritance:
 
+logs\_storage\_tier
+-------------------
+
+.. automodule:: datadog_api_client.v2.model.logs_storage_tier
+   :members:
+   :show-inheritance:
+
 logs\_warning
 -------------
 

src/datadog_api_client/v2/api/logs_api.py

@@ -19,6 +19,7 @@
 from datadog_api_client.v2.model.logs_aggregate_response import LogsAggregateResponse
 from datadog_api_client.v2.model.logs_aggregate_request import LogsAggregateRequest
 from datadog_api_client.v2.model.logs_list_response import LogsListResponse
+from datadog_api_client.v2.model.logs_storage_tier import LogsStorageTier
 from datadog_api_client.v2.model.logs_sort import LogsSort
 from datadog_api_client.v2.model.log import Log
 from datadog_api_client.v2.model.logs_list_request import LogsListRequest
@@ -106,6 +107,11 @@ def __init__(self, api_client=None):
                     "attribute": "filter[to]",
                     "location": "query",
                 },
+                "filter_storage_tier": {
+                    "openapi_types": (LogsStorageTier,),
+                    "attribute": "filter[storage_tier]",
+                    "location": "query",
+                },
                 "sort": {
                     "openapi_types": (LogsSort,),
                     "attribute": "sort",
@@ -293,6 +299,7 @@ def list_logs_get(
         filter_index: Union[str, UnsetType] = unset,
         filter_from: Union[datetime, UnsetType] = unset,
         filter_to: Union[datetime, UnsetType] = unset,
+        filter_storage_tier: Union[LogsStorageTier, UnsetType] = unset,
         sort: Union[LogsSort, UnsetType] = unset,
         page_cursor: Union[str, UnsetType] = unset,
         page_limit: Union[int, UnsetType] = unset,
@@ -317,6 +324,8 @@ def list_logs_get(
         :type filter_from: datetime, optional
         :param filter_to: Maximum timestamp for requested logs.
         :type filter_to: datetime, optional
+        :param filter_storage_tier: Specifies the storage type to be used
+        :type filter_storage_tier: LogsStorageTier, optional
         :param sort: Order of logs in results.
         :type sort: LogsSort, optional
         :param page_cursor: List following results with a cursor provided in the previous query.
@@ -338,6 +347,9 @@ def list_logs_get(
         if filter_to is not unset:
             kwargs["filter_to"] = filter_to
 
+        if filter_storage_tier is not unset:
+            kwargs["filter_storage_tier"] = filter_storage_tier
+
         if sort is not unset:
             kwargs["sort"] = sort
 
@@ -356,6 +368,7 @@ def list_logs_get_with_pagination(
         filter_index: Union[str, UnsetType] = unset,
         filter_from: Union[datetime, UnsetType] = unset,
         filter_to: Union[datetime, UnsetType] = unset,
+        filter_storage_tier: Union[LogsStorageTier, UnsetType] = unset,
         sort: Union[LogsSort, UnsetType] = unset,
         page_cursor: Union[str, UnsetType] = unset,
         page_limit: Union[int, UnsetType] = unset,
@@ -373,6 +386,8 @@ def list_logs_get_with_pagination(
         :type filter_from: datetime, optional
         :param filter_to: Maximum timestamp for requested logs.
         :type filter_to: datetime, optional
+        :param filter_storage_tier: Specifies the storage type to be used
+        :type filter_storage_tier: LogsStorageTier, optional
         :param sort: Order of logs in results.
         :type sort: LogsSort, optional
         :param page_cursor: List following results with a cursor provided in the previous query.
@@ -396,6 +411,9 @@ def list_logs_get_with_pagination(
         if filter_to is not unset:
             kwargs["filter_to"] = filter_to
 
+        if filter_storage_tier is not unset:
+            kwargs["filter_storage_tier"] = filter_storage_tier
+
         if sort is not unset:
             kwargs["sort"] = sort
 

src/datadog_api_client/v2/model/logs_query_filter.py

@@ -3,7 +3,7 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import List, Union
+from typing import List, TYPE_CHECKING, Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
@@ -13,20 +13,28 @@
 )
 
 
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.logs_storage_tier import LogsStorageTier
+
+
 class LogsQueryFilter(ModelNormal):
     @cached_property
     def openapi_types(_):
+        from datadog_api_client.v2.model.logs_storage_tier import LogsStorageTier
+
         return {
             "_from": (str,),
             "indexes": ([str],),
             "query": (str,),
+            "storage_tier": (LogsStorageTier,),
             "to": (str,),
         }
 
     attribute_map = {
         "_from": "from",
         "indexes": "indexes",
         "query": "query",
+        "storage_tier": "storage_tier",
         "to": "to",
     }
 
@@ -35,6 +43,7 @@ def __init__(
         _from: Union[str, UnsetType] = unset,
         indexes: Union[List[str], UnsetType] = unset,
         query: Union[str, UnsetType] = unset,
+        storage_tier: Union[LogsStorageTier, UnsetType] = unset,
         to: Union[str, UnsetType] = unset,
         **kwargs,
     ):
@@ -50,6 +59,9 @@ def __init__(
         :param query: The search query - following the log search syntax.
         :type query: str, optional
 
+        :param storage_tier: Specifies storage type as indexes or online-archives
+        :type storage_tier: LogsStorageTier, optional
+
         :param to: The maximum time for the requested logs, supports date math and regular timestamps (milliseconds).
         :type to: str, optional
         """
@@ -59,6 +71,8 @@ def __init__(
             kwargs["indexes"] = indexes
         if query is not unset:
             kwargs["query"] = query
+        if storage_tier is not unset:
+            kwargs["storage_tier"] = storage_tier
         if to is not unset:
             kwargs["to"] = to
         super().__init__(kwargs)

src/datadog_api_client/v2/model/logs_storage_tier.py

@@ -0,0 +1,38 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class LogsStorageTier(ModelSimple):
+    """
+    Specifies storage type as indexes or online-archives
+
+    :param value: If omitted defaults to "indexes". Must be one of ["indexes", "online-archives"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "indexes",
+        "online-archives",
+    }
+    INDEXES: ClassVar["LogsStorageTier"]
+    ONLINE_ARCHIVES: ClassVar["LogsStorageTier"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+LogsStorageTier.INDEXES = LogsStorageTier("indexes")
+LogsStorageTier.ONLINE_ARCHIVES = LogsStorageTier("online-archives")

src/datadog_api_client/v2/models/__init__.py

@@ -379,6 +379,7 @@
 from datadog_api_client.v2.model.logs_response_metadata_page import LogsResponseMetadataPage
 from datadog_api_client.v2.model.logs_sort import LogsSort
 from datadog_api_client.v2.model.logs_sort_order import LogsSortOrder
+from datadog_api_client.v2.model.logs_storage_tier import LogsStorageTier
 from datadog_api_client.v2.model.logs_warning import LogsWarning
 from datadog_api_client.v2.model.metric import Metric
 from datadog_api_client.v2.model.metric_active_configuration_type import MetricActiveConfigurationType

tests/v2/features/logs.feature

@@ -26,7 +26,7 @@ Feature: Logs
   Scenario: Aggregate events returns "Bad Request" response
     Given a valid "appKeyAuth" key in the system
     And new "AggregateLogs" request
-    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "to": "now"}, "group_by": [{"facet": "host", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="}}
+    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "storage_tier": "indexes", "to": "now"}, "group_by": [{"facet": "host", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="}}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -77,7 +77,7 @@ Feature: Logs
   Scenario: Search logs returns "Bad Request" response
     Given a valid "appKeyAuth" key in the system
     And new "ListLogs" request
-    And body with value {"filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "to": "now"}, "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "timestamp"}
+    And body with value {"filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "storage_tier": "indexes", "to": "now"}, "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "timestamp"}
     When the request is sent
     Then the response status is 400 Bad Request