diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index d086bab5d0..e287750c31 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -246526,11 +246526,19 @@ tags: Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. name: Logs - description: |- - Search the logs stored in a Logs Archive without reindexing them, and optionally rehydrate - the matches into a retained historical view. + Archive Search queries logs directly from long-term storage archives without prior + rehydration and charges only for the data scanned. - See the [Rehydrating from Archives](https://app.datadoghq.com/logs/pipelines/historical-views) - page for the searches currently running in Datadog. + A search runs in one of two modes. By default, it scans the archive and retains up to + 100,000 matching logs for 24 hours on a dedicated results page. Include a `rehydration` + object to run a Search & Rehydration instead, which retains the matches for a longer + custom retention period and makes them available beyond Log Explorer, such as in Dashboards and Notebooks. + + A search requires the `logs_write_historical_view` or `logs_write_archive_search` + permission. Rehydration requires `logs_write_historical_view`. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/explorer/archive_search/ name: Logs Archive Searches - description: |- Archives forward all the logs ingested to a cloud storage system. diff --git a/src/datadog_api_client/v2/api/logs_archive_searches_api.py b/src/datadog_api_client/v2/api/logs_archive_searches_api.py index dc9c7576dd..aa512468c8 100644 --- a/src/datadog_api_client/v2/api/logs_archive_searches_api.py +++ b/src/datadog_api_client/v2/api/logs_archive_searches_api.py @@ -13,11 +13,16 @@ class LogsArchiveSearchesApi: """ - Search the logs stored in a Logs Archive without reindexing them, and optionally rehydrate - the matches into a retained historical view. + Archive Search queries logs directly from long-term storage archives without prior + rehydration and charges only for the data scanned. - See the `Rehydrating from Archives `_ - page for the searches currently running in Datadog. + A search runs in one of two modes. By default, it scans the archive and retains up to + 100,000 matching logs for 24 hours on a dedicated results page. Include a ``rehydration`` + object to run a Search & Rehydration instead, which retains the matches for a longer + custom retention period and makes them available beyond Log Explorer, such as in Dashboards and Notebooks. + + A search requires the ``logs_write_historical_view`` or ``logs_write_archive_search`` + permission. Rehydration requires ``logs_write_historical_view``. """ def __init__(self, api_client=None): diff --git a/tests/v2/features/logs_archive_searches.feature b/tests/v2/features/logs_archive_searches.feature index 6f3af4d456..452f5bc642 100644 --- a/tests/v2/features/logs_archive_searches.feature +++ b/tests/v2/features/logs_archive_searches.feature @@ -1,10 +1,15 @@ @endpoint(logs-archive-searches) @endpoint(logs-archive-searches-v2) Feature: Logs Archive Searches - Search the logs stored in a Logs Archive without reindexing them, and - optionally rehydrate the matches into a retained historical view. See the - [Rehydrating from - Archives](https://app.datadoghq.com/logs/pipelines/historical-views) page - for the searches currently running in Datadog. + Archive Search queries logs directly from long-term storage archives + without prior rehydration and charges only for the data scanned. A search + runs in one of two modes. By default, it scans the archive and retains up + to 100,000 matching logs for 24 hours on a dedicated results page. Include + a `rehydration` object to run a Search & Rehydration instead, which + retains the matches for a longer custom retention period and makes them + available beyond Log Explorer, such as in Dashboards and Notebooks. A + search requires the `logs_write_historical_view` or + `logs_write_archive_search` permission. Rehydration requires + `logs_write_historical_view`. Background: Given a valid "apiKeyAuth" key in the system