Skip to content

Commit 8c3ef0c

Browse files
docs: Update clp-package quick-start to show and describe new webui. (#1069)
Co-authored-by: kirkrodrigues <[email protected]>
1 parent 691d002 commit 8c3ef0c

File tree

5 files changed

+61
-33
lines changed

5 files changed

+61
-33
lines changed
Lines changed: 3 additions & 0 deletions
Loading

docs/src/user-guide/quick-start/clp-json.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -121,23 +121,36 @@ To search your compressed logs from CLP's UI, open [http://localhost:4000](http:
121121
your browser (if you changed `webui.host` or `webui.port` in `etc/clp-config.yml`, use the new
122122
values).
123123

124-
:::{image} clp-search-ui.png
124+
[Figure 3](#figure-3) shows the search page after running a query.
125+
126+
(figure-3)=
127+
:::{card}
128+
129+
:::{image} clp-json-search-ui.png
130+
131+
+++
132+
**Figure 3**: The search page in CLP's UI.
125133
:::
126134

127-
The image above shows the search page after running a query. The numbered circles correspond to
128-
the following features:
129-
130-
1. The search box is where you can enter your query.
131-
2. The timeline shows the number of results across the time range of your query.
132-
* You can click and drag to zoom into a time range, or use the time range filter in (4).
133-
3. The table displays the search results for your query.
134-
4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters for your query.
135-
* The time range filter allows you to specify the period of time that matching log events must be
136-
in.
137-
* The case sensitivity filter allows you to specify whether CLP should respect the case of your
138-
query.
139-
5. Clicking the <i class="fa fa-cog"></i> icon reveals options for displaying results.
140-
6. The <i class="fa fa-trash"></i> icon clears the results of the last query.
135+
The numbered circles in [Figure 3](#figure-3) correspond to the following elements:
136+
137+
1. **The query input box**. The format of your query should conform to CLP's
138+
[JSON search syntax](../reference-json-search-syntax.md).
139+
2. **The query case-sensitivity toggle**. When turned on, CLP will search for log events that match
140+
the case of your query.
141+
3. **The time range selector**. CLP will search for log events that are in the specified time range.
142+
You can select a preset filter (e.g., `Last 15 minutes`; `Yesterday`) from the dropdown, or
143+
choose `Custom` and set the start time and end time directly.
144+
4. **The dataset selector**. CLP will search for log events that belong to the selected dataset.
145+
5. **The search results timeline**. After a query, the timeline will show the number of results
146+
across the time range of your query.
147+
* You can click and drag to zoom into a time range.
148+
* When you mouse over a bar in the timeline, a popup will display the range and the number of
149+
search results in that range.
150+
6. **The search results**.
151+
* You can sort by `Ascending` or `Descending` timestamp by clicking the `Timestamp` header in the
152+
table.
153+
* Each search result includes a link to the original file in which the log event was found.
141154

142155
:::{note}
143156
By default, the UI will only return 1,000 of the latest search results. To perform searches which

docs/src/user-guide/quick-start/clp-search-ui.png

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

docs/src/user-guide/quick-start/clp-text.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -102,23 +102,35 @@ To search your compressed logs from CLP's UI, open [http://localhost:4000](http:
102102
your browser (if you changed `webui.host` or `webui.port` in `etc/clp-config.yml`, use the new
103103
values).
104104

105-
:::{image} clp-search-ui.png
105+
[Figure 3](#figure-3) shows the search page after running a query.
106+
107+
(figure-3)=
108+
:::{card}
109+
110+
:::{image} clp-text-search-ui.png
111+
112+
+++
113+
**Figure 3**: The search page in CLP's UI.
106114
:::
107115

108-
The image above shows the search page after running a query. The numbered circles correspond to the
109-
following features:
110-
111-
1. The search box is where you can enter your query.
112-
2. The timeline shows the number of results across the time range of your query.
113-
* You can click and drag to zoom into a time range, or use the time range filter in (4).
114-
3. The table displays the search results for your query.
115-
4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters for your query.
116-
* The time range filter allows you to specify the period of time that matching log events must be
117-
in.
118-
* The case sensitivity filter allows you to specify whether CLP should respect the case of your
119-
query.
120-
5. Clicking the <i class="fa fa-cog"></i> icon reveals options for displaying results.
121-
6. The <i class="fa fa-trash"></i> icon clears the results of the last query.
116+
The numbered circles in [Figure 3](#figure-3) correspond to the following elements:
117+
118+
1. **The query input box**. The format of your query should conform to CLP's
119+
[unstructured text search syntax](../reference-text-search-syntax.md).
120+
2. **The query case-sensitivity toggle**. When turned on, CLP will search for log events that match
121+
the case of your query.
122+
3. **The time range selector**. CLP will search for log events that are in the specified time range.
123+
You can select a preset filter (e.g., `Last 15 minutes`; `Yesterday`) from the dropdown, or
124+
choose `Custom` and set the start time and end time directly.
125+
4. **The search results timeline**. After a query, the timeline will show the number of results
126+
across the time range of your query.
127+
* You can click and drag to zoom into a time range.
128+
* When you mouse over a bar in the timeline, a popup will display the range and the number of
129+
search results in that range.
130+
5. **The search results**.
131+
* You can sort by `Ascending` or `Descending` timestamp by clicking the `Timestamp` header in the
132+
table.
133+
* Each search result includes a link to the original file in which the log event was found.
122134

123135
:::{note}
124136
By default, the UI will only return 1,000 of the latest search results. To perform searches which

0 commit comments

Comments
 (0)