[DOCS] Move Archive Search to Log Explorer section, update rehydration references#37250
[DOCS] Move Archive Search to Log Explorer section, update rehydration references#37250martin-tournier wants to merge 10 commits into
Conversation
- Move archive_search.md from logs/log_configuration/ to logs/explorer/ with alias redirect for backward compatibility - Add Archive Search recommendation banner on Rehydrating from Archives page - Update rehydration mentions in _index.md, best-practices guide, glossary, and OP datadog_archives destination to also reference Archive Search - Update all internal links pointing to old archive_search location Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…s legacy Rehydration replacement Update all rehydration references to position Archive Search (with Search & Rehydration mode) as the recommended path, not just an alternative — covers rehydrating.md banner, log config index, best-practices guide, OP datadog_archives destination, and glossary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
…ntry Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…permissions and storage class sections Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
hey, thanks for the PR! the reframing here is well-reasoned and consistently executed. Archive Search is introduced as the recommended path, "Search & Rehydration mode" is used uniformly, the alias is correctly added to the moved page, and a couple of subject-verb agreement issues got fixed along the way (Archiving and Archive Search ... support). two structural items below would otherwise ship in a half-done/broken state, plus a few quick cleanups inline
navigation isn't updated for the move. config/_default/menus/main.en.yaml (around lines 7077–7079) still lists Archive Search under Log Configuration with the old URL:
- name: Archive Search
identifier: log_configuration_archive_search
url: logs/log_configuration/archive_searchthe goal of the PR is to relocate it to Log Explorer, but the left nav still shows it under Log Configuration and points at the old (now-aliased) path. the move needs a matching menu update (reparent the entry under Log Explorer and change the url to logs/explorer/archive_search) applied to the localized menu files too (main.fr.yaml, main.ja.yaml, main.ko.yaml, main.es.yaml), as is standard for a page move. (This file isn't in the diff, so noting it here rather than inline.)
must fix: orphaned reference in best-practices-for-log-management.md. after removing the [Log Rehydration][3]™ mention, [3]: /logs/log_configuration/rehydrating/ (line 228) is now defined but unused. remove the dangling definition. (Outside the diff, so noting here.)
Out-of-scope courtesy: in the same file, reference [31] is malformed (it has a nested ](https://... inside the URL). pre-existing, not from this PR, but easy to fix while you're in this reference block.
let me know if you need anything!
| @@ -57,3 +57,4 @@ Once you've completed configuration, start investigating and troubleshooting log | |||
| [9]: /logs/log_configuration/rehydrating | |||
There was a problem hiding this comment.
we don't need this reference now (its only usage was replaced by [12] (Archive Search) above). we can remove the unused [9]: /logs/log_configuration/rehydrating definition.
| - log management | ||
| --- | ||
| Rehydration is when archived logs are recalled back into Datadog. No newline at end of file | ||
| <div class="alert alert-warning"> |
There was a problem hiding this comment.
two things here:
- this is a recommendation pointer rather than a warning, so
alert-info(blue) fits better thanalert-warning(yellow), and it matches the banner onrehydrating.md. - glossary terms are concise definitions surfaced in tooltips and the glossary index. worth confirming a
<div class="alert">banner renders correctly in that context. it's unusual for a glossary entry, and may be better as a plain sentence pointer.
| {{% tab "Azure Storage" %}} | ||
|
|
||
| 1. Grant the Datadog app permission to write to and rehydrate from your storage account. | ||
| 1. Grant the Datadog app permission to write to and [search][2] your storage account. |
There was a problem hiding this comment.
"search your storage account" reads a little imprecisely (you search the archived logs, not the storage account itself). how about Grant the Datadog app permission to write to and read from your storage account. (or rephrase to reference searching the archived logs).
| #### Set up max scan size to manage costs | ||
|
|
||
| Set a limit on the volume of logs that can be rehydrated at one time. When setting up an archive, you can define the maximum volume of log data that can be scanned for Rehydration. See [Define maximum scan size][4] for more information. | ||
| Set a limit on the volume of logs that can be scanned at one time. When setting up an archive, you can define the maximum volume of log data that can be scanned per Archive Search query or Rehydration. See [Define maximum scan size][4] for more information. |
There was a problem hiding this comment.
Rehydration is capitalized mid-sentence here ("per Archive Search query or Rehydration"). make it lowercase for parallelism with "query": ...scanned per Archive Search query or rehydration.
…es.md Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
- Move Archive Search nav entry from Log Configuration to Log Explorer in main.en.yaml (localized menus had no entry to update) - Remove orphaned [3] reference in best-practices-for-log-management.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- glossary/rehydration: replace alert-warning div with plain sentence (unusual in glossary context) - archives.md Azure tab: "write to and read from" instead of "search" (more precise) - archives.md Azure tab: remove orphaned [2] reference - best-practices: lowercase "rehydration" for parallelism - log_configuration/_index.md: remove orphaned [9] rehydrating reference Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…(pre-existing) Remove duplicated/nested URL fragment and hardcoded from_ts/to_ts timestamps. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…rning) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Thanks @OliviaShoup for your comments - these should be addressed now! |
2 participants
What does this PR do? What is the motivation?
Moves the Archive Search documentation page from Log Configuration to Log Explorer, which is a better home since Archive Search is a search/exploration feature rather than a configuration one. Also adds Archive Search references where rehydration is mentioned, to help users discover the newer, recommended approach.
Changes:
logs/log_configuration/archive_search.md→logs/explorer/archive_search.md(with alias redirect so existing links continue to work)logs/log_configuration/_index.md— added Archive Search as the first option alongside rehydrationlogs/guide/best-practices-for-log-management.md— updated archives section to mention Archive Search first, updated scan size section to cover bothobservability_pipelines/destinations/datadog_archives.md— updated overview to mention Archive Search alongside rehydrationglossary/terms/rehydration.md— added pointer to Archive Searcharchives.mdto point to new Archive Search locationMerge instructions
Merge readiness:
Additional notes
All existing
/logs/log_configuration/archive_search/URLs redirect automatically via thealiasesfield in the front matter.