Skip to content

Commit f055689

Browse files
authored
Merge pull request #9682 from DataDog/pcarioufr/unified_log_explorer
Document the unified Query Editor for the Log Explorer
2 parents 2846a63 + 4ee860e commit f055689

File tree

79 files changed

+250
-531
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+250
-531
lines changed

config/_default/menus/menus.en.yaml

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1694,30 +1694,18 @@ main:
16941694
url: logs/explorer/live_tail/
16951695
parent: log_explorer
16961696
weight: 601
1697-
- name: Log List
1698-
url: logs/explorer/list/
1697+
- name: Log Side Panel
1698+
url: logs/explorer/side_panel/
16991699
parent: log_explorer
17001700
weight: 602
1701-
- name: Log Patterns
1702-
url: logs/explorer/patterns/
1703-
parent: log_explorer
1704-
weight: 603
1705-
- name: Log Transactions
1706-
url: logs/explorer/transactions/
1707-
parent: log_explorer
1708-
weight: 604
1709-
- name: Log Analytics
1710-
url: logs/explorer/analytics/
1711-
parent: log_explorer
1712-
weight: 605
17131701
- name: Saved Views
17141702
url: logs/explorer/saved_views/
17151703
parent: log_explorer
1716-
weight: 606
1704+
weight: 603
17171705
- name: Facets
17181706
url: logs/explorer/facets/
17191707
parent: log_explorer
1720-
weight: 607
1708+
weight: 604
17211709
- name: Search Syntax
17221710
url: logs/search_syntax/
17231711
parent: log_management

content/en/logs/explorer/_index.md

Lines changed: 109 additions & 96 deletions
Large diffs are not rendered by default.

content/en/logs/explorer/analytics.md

Lines changed: 0 additions & 170 deletions
This file was deleted.

content/en/logs/explorer/list.md

Lines changed: 0 additions & 56 deletions
This file was deleted.
Lines changed: 18 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,42 @@
11
---
22
title: Live Tail
33
kind: documentation
4-
description: 'See all your logs in real time.'
4+
description: 'Search through all of your logs and perform Log Analytics'
55
aliases:
6-
- /logs/live_tail
6+
- /logs/explore/livetail
77
further_reading:
8-
- link: 'logs/explorer/analytics'
9-
tag: 'Documentation'
10-
text: 'Perform Log Analytics'
118
- link: 'logs/processing'
129
tag: 'Documentation'
1310
text: 'Learn how to process your logs'
14-
- link: 'logs/processing/parsing'
11+
- link: 'logs/explorer/side_panel'
12+
tag: 'Documentation'
13+
text: 'The log side panel'
14+
- link: 'logs/explorer/#list-of-logs'
1515
tag: 'Documentation'
16-
text: 'Learn more about parsing'
16+
text: 'The list view of logs'
1717
---
1818

19-
{{< img src="logs/explorer/livetail/live_tail_demo.mp4" alt="Live tail" video="true" >}}
20-
2119
## Overview
2220

23-
The Live Tail feature gives you the ability to see all your log events in near real time from anywhere in your infrastructure. It displays logs as soon as they get out of the [Pipeline section][1] and before they are [indexed][2] by Datadog, hence:
24-
25-
1. All logs ingested by Datadog are displayed. ([It's Logging without Limits][2]\*)
26-
2. Displayed logs have been processed.
27-
3. The stream can be paused.
28-
4. You can't go back in time.
29-
30-
This feature allows you, for instance, to check if a process has correctly started, or if a new deployment went smoothly.
31-
32-
## Live Tail view
33-
34-
Choose the `Live Tail` option in the time range selector to switch to the Live Tail view:
35-
36-
{{< img src="logs/explorer/livetail/live_tail_time_selector.png" alt="Live Tail time selector" >}}
37-
38-
The number of received events per second is displayed at the top left, as well as the sampling rate. Since a stream of thousands of logs per second is not human readable, high throughput log streams are sampled.
39-
40-
Use the [Live Tail search bar filtering features](#filtering-the-log-stream) to filter the log stream and the **Pause/Play** button at the top right of the screen to pause or resume the stream.
41-
42-
**Note**: Selecting any log pauses the stream and displays more details about the selected log.
43-
44-
### Display Options
45-
46-
Customize the Live Tail view to better highlight the relevant information in your logs.
47-
Click on the gear at the top right of the page to activate one of the options below:
48-
49-
{{< img src="logs/explorer/livetail/live_tail_column.png" alt="Live tail column" style="width:30%;">}}
50-
51-
1. Choose to display one, three, or ten lines from your logs attributes in your logstream.
52-
2. Enable/Disable the Date and Message column.
53-
3. Add any log attribute as a column either in this panel or by clicking on it directly:
54-
55-
{{< img src="logs/explorer/livetail/live_tail_add_as_column.png" alt="Live tail add as column" style="width:50%;">}}
56-
57-
## Filtering the log Stream
58-
59-
A valid query in the search bar displays logs that match your search criteria.
60-
The search syntax is the same in the Live Tail views as in the other Log views, but here, your query is matched against all of the ingested logs and not just the indexed ones.
61-
62-
### JSON attributes
63-
64-
Any query that works in other views works in the Live Tail view, but you can even go further and **filter on attributes that are not defined as facets**.
65-
66-
For example, to filter on the following `filename` attribute there are two options:
21+
With Live Tail, access all your log events in near real time from anywhere in your infrastructure. The Live Tail view provides visibility on **all** logs, whether you choose to index them or not - see also [Exclusion Filters][1] on logs indexes. Logs flowing through the Live Tail are all structured, processed, and enriched from [Log Pipelines][2].
6722

68-
{{< img src="logs/explorer/livetail/live_tail_save.png" alt="Live tail save" style="width:50%;">}}
23+
For example, Live Tail is specifically useful to check if a process has correctly started or if a new deployment went smoothly.
6924

70-
1. Click on the attribute and add it to the search:
25+
## Live Tail View
7126

72-
{{< img src="logs/explorer/livetail/live_tail_click_attribute.png" alt="Live tail click attribute" style="width:50%;">}}
27+
In the [Log Explorer][3], choose the Live Tail option in the timerange to query logs as they flow into Datadog.
7328

74-
2. Use the following query `@filename:runner.go`:
29+
{{< img src="logs/explorer/live_tail/livetail.gif" alt="Log Live Tail" style="width:100%;" >}}
7530

76-
{{< img src="logs/explorer/livetail/live_tail_filtered.png" alt="Live tail filtered" style="width:50%;">}}
31+
Contrary to queries on indexed logs happening in the [Log Explorer][3], queries in the Live Tail do *not* require that you [declare a facet][4] beforehand.
7732

78-
To filter on all logs with a line number above 150 use the following query: `@linenumber:>150`
33+
**Note**: For the sake of readability, the Live Tail output is sampled when too many logs matching the query are flowing in. The sampling applied is uniformly random, so that your Live Tail logs are statistically representative of your actual log throughput. Scope your query down with additional search filters if you need visibility on every single log flowing in.
7934

8035
## Further Reading
8136

8237
{{< partial name="whats-next/whats-next.html" >}}
83-
<br>
84-
\*Logging without Limits is a trademark of Datadog, Inc.
8538

86-
[1]: /logs/processing/pipelines/
87-
[2]: /logs/
39+
[1]: /logs/indexes#exclusion-filters
40+
[2]: /logs/processing
41+
[3]: /logs/explorer
42+
[4]: /logs/explorer/facets/

0 commit comments

Comments
 (0)