Commit 89f49b1
[DOCS-8989][DOCS-12774][DOCS-12512] Improve Log Explorer and monitoring documentation (#34549)
* [DOCS-8989] Add prominent links to Log Explorer documentation
Add clearer pointers to comprehensive Log Explorer documentation in the
Getting Started with Logs page. Users reported difficulty finding
documentation about all Log Explorer features.
Changes:
- Add direct link to Log Explorer docs in introduction
- Add bulleted list highlighting key Log Explorer features (search,
analytics, visualizations, saved views, export)
- Add closing note pointing to comprehensive documentation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* [DOCS-12774] Clarify query_window and avg usage in anomaly monitors
Improve anomaly monitor API documentation based on user feedback about
confusion with query parameters.
Changes:
- Clarify query_window parameter: Explicitly state it controls
visualization time range in notifications, not alert evaluation
- Add explanation for dual use of avg in example query: One aggregates
anomaly data points for graphs, the other aggregates the metric
across nodes before anomaly detection
User feedback: Confusion about query_window behavior and why avg
appears twice in the query without clear explanation.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* [DOCS-12512] Clarify when to use @ prefix in log search syntax
Add explanation for when the @ prefix is required versus optional in log
attribute searches based on user feedback.
Changes:
- Add "Reserved attributes" subsection explaining that reserved attributes
(host, source, status, service, trace_id, message) do not require @ prefix
- Provide examples of searching reserved attributes without @
- Clarify that all other custom attributes require the @ prefix
- Link to reserved attributes documentation
User feedback: "Doesn't explain when to use @ and when not to. Why do we
use an @ for @http.response_time:foo but not service:foo?"
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* Apply suggestions from code review
* Update content/en/logs/explorer/search_syntax.md
* Apply suggestions from code review
Co-authored-by: May Lee <may.lee@datadoghq.com>
* Update content/en/getting_started/logs/_index.md
Co-authored-by: May Lee <may.lee@datadoghq.com>
---------
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: May Lee <may.lee@datadoghq.com>1 parent 742e279 commit 89f49b1
File tree
3 files changed
+29
-1
lines changed- content/en
- getting_started/logs
- logs/explorer
- monitors/types
3 files changed
+29
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
116 | 125 | | |
117 | 126 | | |
118 | 127 | | |
| |||
168 | 177 | | |
169 | 178 | | |
170 | 179 | | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
95 | 105 | | |
96 | 106 | | |
97 | 107 | | |
| |||
224 | 234 | | |
225 | 235 | | |
226 | 236 | | |
| 237 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
180 | 180 | | |
181 | 181 | | |
182 | 182 | | |
183 | | - | |
| 183 | + | |
184 | 184 | | |
185 | 185 | | |
186 | 186 | | |
| |||
215 | 215 | | |
216 | 216 | | |
217 | 217 | | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
218 | 222 | | |
219 | 223 | | |
220 | 224 | | |
| |||
0 commit comments