From ed3e5900412feb386733a87501221917a4bb4fb2 Mon Sep 17 00:00:00 2001 From: Quinn Date: Mon, 3 Nov 2025 16:13:58 +0000 Subject: [PATCH 1/2] Add image for new Presto UI. --- .gitattributes | 2 ++ docs/src/user-docs/clp-presto-ui.png | 3 ++ docs/src/user-docs/guides-using-presto.md | 35 +++++++++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 .gitattributes create mode 100644 docs/src/user-docs/clp-presto-ui.png diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..7b726c9cc6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +clp-presto-ui.png filter=lfs diff=lfs merge=lfs -text +docs/src/user-docs/clp-presto-ui.png filter=lfs diff=lfs merge=lfs -text diff --git a/docs/src/user-docs/clp-presto-ui.png b/docs/src/user-docs/clp-presto-ui.png new file mode 100644 index 0000000000..cd3b4444d8 --- /dev/null +++ b/docs/src/user-docs/clp-presto-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74216c9b2541e8791771401bc7e40f3658079f94bb00d278102bdb906d6fac81 +size 974344 diff --git a/docs/src/user-docs/guides-using-presto.md b/docs/src/user-docs/guides-using-presto.md index 1e73e40e3d..b93a202211 100644 --- a/docs/src/user-docs/guides-using-presto.md +++ b/docs/src/user-docs/guides-using-presto.md @@ -198,6 +198,41 @@ SELECT foo.bar FROM default LIMIT 1; CLP's UI should be available at [http://localhost:4000](http://localhost:4000) (if you changed `webui.host` or `webui.port` in `etc/clp-config.yml`, use the new values). +[Figure 1](#figure-1) shows the search page after applying a filter. + +(figure-1)= +:::{card} + +:::{image} clp-presto-ui.png + ++++ +**Figure 1**: The search page in CLP's Presto UI. +::: + +The numbered circles in [Figure 1](#figure-1) correspond to the following elements: + +1. **The filter input boxes**. Fill in the boxes to construct your filter. The state of the query + boxes shown in the image correspond to the following Presto command: + + ```SQL + SELECT timestamp, error_severity, message + FROM postgresql + WHERE error_severity LIKE '%DEBUG%' + ORDER BY timestamp ASC + ``` + +2. **The time range selector**. CLP will filter 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. +3. **The "Freeform" selector**. Click this button if you'd like to construct a filter from scratch, + without the aid of the filter input boxes. +4. **The filter results timeline**. After you apply a filter, the timeline will show the + distribution of results across your chosen time range. + * 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 results table**. The table will display the log events that match your filter. + :::{note} The UI can only run one query at a time, and queries must not end with a `;`. ::: From b6cfedf4deb64cac3871508e10c18c08cfce3331 Mon Sep 17 00:00:00 2001 From: Quinn Date: Mon, 3 Nov 2025 18:41:47 +0000 Subject: [PATCH 2/2] Add query selector info to image and explain. --- docs/src/user-docs/clp-presto-ui.png | 4 ++-- docs/src/user-docs/guides-using-presto.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/user-docs/clp-presto-ui.png b/docs/src/user-docs/clp-presto-ui.png index cd3b4444d8..410788aa2c 100644 --- a/docs/src/user-docs/clp-presto-ui.png +++ b/docs/src/user-docs/clp-presto-ui.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:74216c9b2541e8791771401bc7e40f3658079f94bb00d278102bdb906d6fac81 -size 974344 +oid sha256:00e72fe12d0ba262ebd9c332c86e4998a130418844523beaded2637064c64b08 +size 983601 diff --git a/docs/src/user-docs/guides-using-presto.md b/docs/src/user-docs/guides-using-presto.md index b93a202211..b51a0e8c9d 100644 --- a/docs/src/user-docs/guides-using-presto.md +++ b/docs/src/user-docs/guides-using-presto.md @@ -232,6 +232,8 @@ The numbered circles in [Figure 1](#figure-1) correspond to the following elemen * 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 results table**. The table will display the log events that match your filter. +6. **The query inspector**. Click this button if you'd like to see the full Presto filter generated + by the information you've entered into the filter input boxes. :::{note} The UI can only run one query at a time, and queries must not end with a `;`.