diff --git a/docs/src/user-guide/quick-start/clp-json-search-ui.png b/docs/src/user-guide/quick-start/clp-json-search-ui.png new file mode 100644 index 0000000000..e93871fd27 --- /dev/null +++ b/docs/src/user-guide/quick-start/clp-json-search-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e7d73633002cff5e69816a961df9e5b3d76afcc08c8729fd12dcd90711f4ef0e +size 384107 diff --git a/docs/src/user-guide/quick-start/clp-json.md b/docs/src/user-guide/quick-start/clp-json.md index d83971fd6e..7f080a3d87 100644 --- a/docs/src/user-guide/quick-start/clp-json.md +++ b/docs/src/user-guide/quick-start/clp-json.md @@ -121,23 +121,36 @@ To search your compressed logs from CLP's UI, open [http://localhost:4000](http: your browser (if you changed `webui.host` or `webui.port` in `etc/clp-config.yml`, use the new values). -:::{image} clp-search-ui.png +[Figure 3](#figure-3) shows the search page after running a query. + +(figure-3)= +:::{card} + +:::{image} clp-json-search-ui.png + ++++ +**Figure 3**: The search page in CLP's UI. ::: -The image above shows the search page after running a query. The numbered circles correspond to -the following features: - -1. The search box is where you can enter your query. -2. The timeline shows the number of results across the time range of your query. - * You can click and drag to zoom into a time range, or use the time range filter in (4). -3. The table displays the search results for your query. -4. Clicking the icon reveals additional filters for your query. - * The time range filter allows you to specify the period of time that matching log events must be - in. - * The case sensitivity filter allows you to specify whether CLP should respect the case of your - query. -5. Clicking the icon reveals options for displaying results. -6. The icon clears the results of the last query. +The numbered circles in [Figure 3](#figure-3) correspond to the following elements: + +1. **The query input box**. The format of your query should conform to CLP's + [JSON search syntax](../reference-json-search-syntax.md). +2. **The query case-sensitivity toggle**. When turned on, CLP will search for log events that match + the case of your query. +3. **The time range selector**. CLP will search for log events that are in the specified time range. + You can select a preset filter (e.g., `Last 15 minutes`; `Yesterday`) from the dropdown, or + choose `Custom` and set the start time and end time directly. +4. **The dataset selector**. CLP will search for log events that belong to the selected dataset. +5. **The search results timeline**. After a query, the timeline will show the number of results + across the time range of your query. + * You can click and drag to zoom into a time range. + * When you mouse over a bar in the timeline, a popup will display the range and the number of + search results in that range. +6. **The search results**. + * You can sort by `Ascending` or `Descending` timestamp by clicking the `Timestamp` header in the + table. + * Each search result includes a link to the original file in which the log event was found. :::{note} By default, the UI will only return 1,000 of the latest search results. To perform searches which diff --git a/docs/src/user-guide/quick-start/clp-search-ui.png b/docs/src/user-guide/quick-start/clp-search-ui.png deleted file mode 100644 index 74530978a8..0000000000 --- a/docs/src/user-guide/quick-start/clp-search-ui.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:80e2309f9b03856672edd73ae34dde67814ca04e2cd5235586b78a67fc4f18bf -size 57858 diff --git a/docs/src/user-guide/quick-start/clp-text-search-ui.png b/docs/src/user-guide/quick-start/clp-text-search-ui.png new file mode 100644 index 0000000000..7874219c4d --- /dev/null +++ b/docs/src/user-guide/quick-start/clp-text-search-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5c8ab4fcb07f56482f0bd02a2e59dcb0e65ccb4393d8cac7397b13aab832ce0 +size 313876 diff --git a/docs/src/user-guide/quick-start/clp-text.md b/docs/src/user-guide/quick-start/clp-text.md index cfc3469b71..89af511003 100644 --- a/docs/src/user-guide/quick-start/clp-text.md +++ b/docs/src/user-guide/quick-start/clp-text.md @@ -102,23 +102,35 @@ To search your compressed logs from CLP's UI, open [http://localhost:4000](http: your browser (if you changed `webui.host` or `webui.port` in `etc/clp-config.yml`, use the new values). -:::{image} clp-search-ui.png +[Figure 3](#figure-3) shows the search page after running a query. + +(figure-3)= +:::{card} + +:::{image} clp-text-search-ui.png + ++++ +**Figure 3**: The search page in CLP's UI. ::: -The image above shows the search page after running a query. The numbered circles correspond to the -following features: - -1. The search box is where you can enter your query. -2. The timeline shows the number of results across the time range of your query. - * You can click and drag to zoom into a time range, or use the time range filter in (4). -3. The table displays the search results for your query. -4. Clicking the icon reveals additional filters for your query. - * The time range filter allows you to specify the period of time that matching log events must be - in. - * The case sensitivity filter allows you to specify whether CLP should respect the case of your - query. -5. Clicking the icon reveals options for displaying results. -6. The icon clears the results of the last query. +The numbered circles in [Figure 3](#figure-3) correspond to the following elements: + +1. **The query input box**. The format of your query should conform to CLP's + [unstructured text search syntax](../reference-text-search-syntax.md). +2. **The query case-sensitivity toggle**. When turned on, CLP will search for log events that match + the case of your query. +3. **The time range selector**. CLP will search for log events that are in the specified time range. + You can select a preset filter (e.g., `Last 15 minutes`; `Yesterday`) from the dropdown, or + choose `Custom` and set the start time and end time directly. +4. **The search results timeline**. After a query, the timeline will show the number of results + across the time range of your query. + * You can click and drag to zoom into a time range. + * When you mouse over a bar in the timeline, a popup will display the range and the number of + search results in that range. +5. **The search results**. + * You can sort by `Ascending` or `Descending` timestamp by clicking the `Timestamp` header in the + table. + * Each search result includes a link to the original file in which the log event was found. :::{note} By default, the UI will only return 1,000 of the latest search results. To perform searches which