Log Rows: Added popover menu with filter options when a log line is selected #75306

matyax · 2023-09-22T16:02:51Z

Easier search and filter through the use of a popover menu.

It makes use of the preexisting Explore methods to add filters from Log Details, adding this function to the situation where the user highlights part of a log line.

Hghlights:

Supports:
- Copy text
- Add line contains filter
- Add line does not contain filter
It is dismissed when:
- An option is selected
- The user clears the current selection
- By pressing escape
Shows up when the user selected text in a log line; doesn't show up when multiple log lines are selected.
Hides the log row menu while selecting text in a log line.

Which issue(s) does this PR fix?:

Part of #76129

Related PRs:

Filtering functions: Logs Popover Menu: add string filtering functions #76757
Feature flag and tracking: Logs Popover Menu: add feature flag and interaction tracking #77616

Demos

Elasticsearch:

Elastic.demo.mov

Loki:

Loki.demo.mov

github-actions · 2023-09-22T16:15:29Z

Backend code coverage report for PR #75306
No changes

github-actions · 2023-09-22T16:15:30Z

Frontend code coverage report for PR #75306

Plugin	Main	PR	Difference
explore	85.28%	85.24%	-.04%
loki	86.28%	86.15%	-.13%

matyax · 2023-10-17T14:36:19Z

Demo updated.

gtk-grafana · 2023-11-02T13:20:46Z

This won't work in safari due to #74135

matyax · 2023-11-03T13:19:47Z

@grafana/observability-logs This is ready for review ✨

ifrost · 2023-11-06T12:49:40Z

public/app/features/logs/components/PopoverMenu.tsx

+            close();
+          }}
+        />
+        {onClickFilterValue && (


I think we may need a better API to check what types of filters the given data source supports. At the moment we have a single check in https://github.com/grafana/grafana/blob/main/public/app/features/explore/Logs/LogsContainer.tsx#L91 but a datasource may support only label/tag filter (ADD_FILTER / ADD_FILTER_OUT) but not line filters (ADD_LINE_FILTER / ADD_LINE_FILTER_OUT) which may lead to showing no-op items in the menu.

We did a very similar thing with Supplementary Queries. A data source implements getSupportedSupplementaryQueryTypes() providing list of supported types.

I think at some point we should deprecate checking for modifyQuery in favor of hasToggleableQueryFiltersSupport() which is the desired behavior (and API) for log details filters.

Are you making more changing around this in this PR? I think at the moment the popover will show for data sources that may not support ADD_LINE_FILTER but they support ADD_FILTER 🤔

You're right @ifrost, thanks for the reminder! I'll take another look at this.

I will follow up this PR with a fix for this. Something similar to getSupportedSupplementaryQueryTypes() would make an interesting approach, as I don't think we need a new interface for this.

Will be addressed by #78322

ifrost · 2023-11-06T12:52:32Z

Really cool feature 🙌 Have you considered extending popover menu with Grafana UI Extensions?

matyax · 2023-11-06T12:57:15Z

@ifrost thanks for the feedback!

Have you considered extending popover menu with Grafana UI Extensions?

I've no reference of Grafana UI Extensions. What is it?

ifrost · 2023-11-06T13:54:42Z

@ifrost thanks for the feedback!

Have you considered extending popover menu with Grafana UI Extensions?

I've no reference of Grafana UI Extensions. What is it?

Check docs at https://grafana.com/developers/plugin-tools/ui-extensions/. We have one extension point in Explore https://github.com/grafana/grafana/blob/v10.2.0/packages/grafana-data/src/types/pluginExtensions.ts#L119-L123 - it allows plugins and other parts of Grafana to hook into "Add +" button in Explore toolbar.

I was thinking that if there was an extension point we could use it to allow creating correlations with defined regex transformation 🤯 Anyway, just wanted to mention it. Extenstion UI is not needed for this PR, just something to think about in the future.

matyax · 2023-11-06T14:21:12Z

Gotcha! It's definitely a great idea to "explore" 😉

* Loki modifyQuery: add line does not contain query modification * Elastic modifyQuery: implement line filters * Modify query: change action name to not be loki specific * Prettier * Prettier * Elastic: escape filter values

matyax · 2023-11-14T14:36:52Z

@svennergr FYI I merged all the sub-PRs into this one.

svennergr

LGTM, just one nit: sometimes the menu does not disappear after left-clicks on the selected text.

Screen.Recording.2023-11-15.at.15.49.24.mov

matyax · 2023-11-16T09:42:06Z

Had to cheery-pick the commits from the feature flag and tracking because they were missing in the other PR, probably due to a bad rebase.

Will follow up with a PR to address:

Log Rows: Added popover menu with filter options when a log line is selected #75306 (comment)
Log Rows: Added popover menu with filter options when a log line is selected #75306 (review)

grafana-delivery-bot bot added this to the 10.2.x milestone Sep 22, 2023

grafana-pr-automation bot added datasource/Loki area/frontend labels Sep 22, 2023

matyax mentioned this pull request Sep 25, 2023

[Proposal] Log Rows: Log details no longer toggled when text is selected #75384

Closed

matyax force-pushed the matyax/log-row-filtering-menu branch from 44cb409 to 0092ae4 Compare October 16, 2023 10:08

matyax changed the title ~~[Experiment] Log Rows: Add popover menu displayed on-selection with filtering options~~ Log Rows: Add popover menu displayed on-selection with filtering options Oct 16, 2023

grafana-pr-automation bot added the area/explore label Oct 17, 2023

matyax force-pushed the matyax/log-row-filtering-menu branch from 761c06d to 7dc0323 Compare October 17, 2023 14:27

matyax force-pushed the matyax/log-row-filtering-menu branch from 8b17841 to 9a66d77 Compare October 18, 2023 09:41

matyax marked this pull request as ready for review November 2, 2023 13:01

matyax requested review from a team as code owners November 2, 2023 13:01

matyax force-pushed the matyax/log-row-filtering-menu branch from 9a66d77 to c73d9a9 Compare November 2, 2023 13:18

matyax added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Nov 3, 2023

matyax modified the milestones: 10.2.x, 10.3.x Nov 3, 2023

matyax added add to changelog and removed no-changelog Skip including change in changelog/release notes labels Nov 3, 2023

matyax changed the title ~~Log Rows: Add popover menu displayed on-selection with filtering options~~ Log Rows: Added popover menu with filter options when a log line is selected Nov 3, 2023

ifrost reviewed Nov 6, 2023

View reviewed changes

Fix style declaration

8c69abf

matyax force-pushed the matyax/log-row-filtering-menu branch from f2889a9 to 8c69abf Compare November 14, 2023 11:01

Logs Popover Menu: add string filtering functions (#76757)

3a19bbc

* Loki modifyQuery: add line does not contain query modification * Elastic modifyQuery: implement line filters * Modify query: change action name to not be loki specific * Prettier * Prettier * Elastic: escape filter values

grafana-pr-automation bot added the datasource/Elasticsearch label Nov 14, 2023

matyax mentioned this pull request Nov 14, 2023

Logs: add an extension point on the popover menu #78117

Open

svennergr approved these changes Nov 15, 2023

View reviewed changes

matyax added 7 commits November 15, 2023 18:26

Popover menu: create feature flag

f5aff47

Log Rows: integrate logsRowsPopoverMenu flag

c70ff5f

Rename feature flag

0119785

Popover menu: track interactions

26ec3ce

Prettier

084e38b

logRowsPopoverMenu: update stage

eaf67b8

Popover menu: add ds type to tracking data

8d5e885

matyax requested review from grafanabot and a team as code owners November 15, 2023 17:31

grafana-pr-automation bot added type/docs area/backend labels Nov 15, 2023

matyax added 2 commits November 15, 2023 18:32

Log rows: move feature flag check

2ae0091

Improve handle deselection

58ff3a6

matyax removed the type/docs label Nov 16, 2023

Merge branch 'main' into matyax/log-row-filtering-menu

500d06c

matyax enabled auto-merge (squash) November 16, 2023 09:37

grafana-pr-automation bot added the type/docs label Nov 16, 2023

matyax merged commit 9cb303c into main Nov 16, 2023
25 checks passed

matyax deleted the matyax/log-row-filtering-menu branch November 16, 2023 09:48

svennergr mentioned this pull request Nov 21, 2023

Logs: create DataSourceWithQueryModificationSupport + determine popover menu support #78322

Merged

aangelisc modified the milestones: 10.3.x, 10.2.3 Dec 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log Rows: Added popover menu with filter options when a log line is selected #75306

Log Rows: Added popover menu with filter options when a log line is selected #75306

matyax commented Sep 22, 2023 •

edited

github-actions bot commented Sep 22, 2023

github-actions bot commented Sep 22, 2023 •

edited

matyax commented Oct 17, 2023

gtk-grafana commented Nov 2, 2023

matyax commented Nov 3, 2023

ifrost Nov 6, 2023

matyax Nov 10, 2023

ifrost Nov 15, 2023

matyax Nov 15, 2023

matyax Nov 15, 2023

matyax Nov 17, 2023

ifrost commented Nov 6, 2023

matyax commented Nov 6, 2023

ifrost commented Nov 6, 2023

matyax commented Nov 6, 2023

matyax commented Nov 14, 2023

svennergr left a comment

matyax commented Nov 16, 2023

Log Rows: Added popover menu with filter options when a log line is selected #75306

Log Rows: Added popover menu with filter options when a log line is selected #75306

Conversation

matyax commented Sep 22, 2023 • edited

github-actions bot commented Sep 22, 2023

github-actions bot commented Sep 22, 2023 • edited

matyax commented Oct 17, 2023

gtk-grafana commented Nov 2, 2023

matyax commented Nov 3, 2023

ifrost Nov 6, 2023

Choose a reason for hiding this comment

matyax Nov 10, 2023

Choose a reason for hiding this comment

ifrost Nov 15, 2023

Choose a reason for hiding this comment

matyax Nov 15, 2023

Choose a reason for hiding this comment

matyax Nov 15, 2023

Choose a reason for hiding this comment

matyax Nov 17, 2023

Choose a reason for hiding this comment

ifrost commented Nov 6, 2023

matyax commented Nov 6, 2023

ifrost commented Nov 6, 2023

matyax commented Nov 6, 2023

matyax commented Nov 14, 2023

svennergr left a comment

Choose a reason for hiding this comment

matyax commented Nov 16, 2023

matyax commented Sep 22, 2023 •

edited

github-actions bot commented Sep 22, 2023 •

edited