feat(explore): Add to filter option in heatmaps tooltip #116690
+207
−58
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| import 'echarts/lib/chart/heatmap'; | ||
|
|
||
| import {Fragment, useEffect, useRef} from 'react'; | ||
| import {useTheme} from '@emotion/react'; | ||
| import type { | ||
| TooltipFormatterCallback, | ||
|
|
@@ -15,18 +15,18 @@ import {defaultFormatAxisLabel} from 'sentry/components/charts/components/toolti | |
| import {isChartHovered} from 'sentry/components/charts/utils'; | ||
| import {usePageFilters} from 'sentry/components/pageFilters/usePageFilters'; | ||
| import {t} from 'sentry/locale'; | ||
| import type {PageFilters} from 'sentry/types/core'; | ||
| import type {ReactEchartsRef} from 'sentry/types/echarts'; | ||
| import {defined} from 'sentry/utils'; | ||
| import {formatAbbreviatedNumber} from 'sentry/utils/formatters'; | ||
| import {ECHARTS_MISSING_DATA_VALUE} from 'sentry/utils/timeSeries/timeSeriesItemToEChartsDataPoint'; | ||
| import {useNavigate} from 'sentry/utils/useNavigate'; | ||
| import {NO_PLOTTABLE_VALUES} from 'sentry/views/dashboards/widgets/common/settings'; | ||
| import {formatYAxisValue} from 'sentry/views/dashboards/widgets/heatMapWidget/formatters/formatYAxisValue'; | ||
| import {plottablesCanBeVisualized} from 'sentry/views/dashboards/widgets/plottablesCanBeVisualized'; | ||
| import {formatTooltipValue} from 'sentry/views/dashboards/widgets/timeSeriesWidget/formatters/formatTooltipValue'; | ||
| import {formatXAxisTimestamp} from 'sentry/views/dashboards/widgets/timeSeriesWidget/formatters/formatXAxisTimestamp'; | ||
| import {FALLBACK_TYPE} from 'sentry/views/dashboards/widgets/timeSeriesWidget/settings'; | ||
|
|
||
| import {HeatMap} from './plottables/heatMap'; | ||
| import type {HeatMapPlottable} from './plottables/heatMapPlottable'; | ||
|
|
@@ -41,26 +41,69 @@ interface HeatMapWidgetVisualizationProps { | |
| * An single `HeatMap` object to render on the chart, and any number of other compatible Heat Map plottables. | ||
| */ | ||
| plottables: [HeatMap, ...HeatMapPlottable[]]; | ||
| /** | ||
| * Callback that returns an explore URL for a given query and filtered datetime selection | ||
| */ | ||
| makeExploreUrl?: (query: string, filteredSelection: PageFilters) => string; | ||
| /** | ||
| * Experimental! Specify the Z-axis scale type. Logarithmic scales can be much more useful for values with a high range. | ||
| */ | ||
| scale?: 'linear' | 'log'; | ||
| /** | ||
| * Callback that returns an updated query string. | ||
| */ | ||
| updateLocalFilterQuery?: (query: string) => void; | ||
| } | ||
|
|
||
| export function HeatMapWidgetVisualization(props: HeatMapWidgetVisualizationProps) { | ||
| const {plottables, updateLocalFilterQuery, makeExploreUrl} = props; | ||
| const theme = useTheme(); | ||
| const renderToString = useRenderToString(); | ||
| const navigate = useNavigate(); | ||
| const pageFilters = usePageFilters(); | ||
| const {start, end, period, utc} = pageFilters.selection.datetime; | ||
| const chartRef = useRef<ReactEchartsRef | null>(null); | ||
|
|
||
| // yes i am aware that this is UGLY but it's a hack so that we can use proper react routing. | ||
| // Basically the way ECharts renders the tooltip is by creating a string out of the dom tree. | ||
| // This means that we can't use any of the normal linking/routing tools that we use in React trees | ||
| // because they require contexts that won't be available properly in this string tree. | ||
| // Using the `<a>` tag will make the page reload and navigate to the url because it doesn't have | ||
| // link history context. Doing the navigation here preserves the link history context and makes the | ||
| // page navigation smoother instead of reloading the page every time a link is clicked. | ||
|
Comment on lines
+67
to
+73
|
||
| useEffect(() => { | ||
| const handleClick = (e: MouseEvent) => { | ||
| if (!chartRef.current?.ele.contains(e.target as Node)) { | ||
|
sentry[bot] marked this conversation as resolved.
Outdated
|
||
| return; | ||
| } | ||
| const localQueryUpdateTarget = (e.target as Element).closest('[data-local-query]'); | ||
| const tracesLinkTarget = (e.target as Element).closest('[data-traces-link]'); | ||
|
Contributor
There was a problem hiding this comment. Text clicks break tooltip routingMedium Severity The document click handler calls   Reviewed by Cursor Bugbot for commit b81dc9d. Configure here.
Member
Author
There was a problem hiding this comment. idk what they're talking about the client side navigation works
nikkikapadia marked this conversation as resolved.
|
||
| if (!localQueryUpdateTarget && !tracesLinkTarget) { | ||
| return; | ||
| } | ||
| e.preventDefault(); | ||
| const openInNewTab = e.metaKey || e.ctrlKey; | ||
| if (localQueryUpdateTarget) { | ||
| const localQuery = localQueryUpdateTarget.getAttribute('data-local-query'); | ||
| if (localQuery && updateLocalFilterQuery) { | ||
| updateLocalFilterQuery(localQuery); | ||
| } | ||
| } | ||
| if (tracesLinkTarget) { | ||
| const tracesUrl = tracesLinkTarget.getAttribute('data-traces-link'); | ||
| if (tracesUrl) { | ||
| if (openInNewTab) { | ||
| window.open(tracesUrl, '_blank'); | ||
| } else { | ||
| navigate(tracesUrl); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| document.addEventListener('click', handleClick); | ||
| return () => document.removeEventListener('click', handleClick); | ||
| }, [navigate, updateLocalFilterQuery]); | ||
|
|
||
| if (!plottablesCanBeVisualized(plottables)) { | ||
| throw new Error(NO_PLOTTABLE_VALUES); | ||
| } | ||
|
|
@@ -126,7 +169,7 @@ export function HeatMapWidgetVisualization(props: HeatMapWidgetVisualizationProp | |
|
|
||
| return renderToString( | ||
| <Fragment> | ||
| <div className="tooltip-series" style={{cursor: 'default'}}> | ||
| {filteredParams.map(param => { | ||
| let rawXValue: number | undefined; | ||
| let rawYValue: number | undefined; | ||
|
|
@@ -175,42 +218,29 @@ export function HeatMapWidgetVisualization(props: HeatMapWidgetVisualizationProp | |
| } | ||
| } | ||
|
|
||
| let tracesLink: string | undefined; | ||
| const metricsQuery = defined(rawYValue) | ||
| ? yAxisBucketSize === 0 | ||
| ? `value:<=${rawYValue}` | ||
| : `value:>=${rawYValue} value:<${rawYValue + yAxisBucketSize}` | ||
| : undefined; | ||
|
|
||
| if (defined(rawXValue) && defined(rawYValue)) { | ||
| const xAxisMaxValue = rawXValue + xAxisBucketSize * 1000; | ||
|
|
||
| const filteredSelection = { | ||
| ...pageFilters.selection, | ||
| datetime: { | ||
| ...pageFilters.selection.datetime, | ||
| start: new Date(rawXValue), | ||
| end: new Date(xAxisMaxValue), | ||
| period: null, | ||
| }, | ||
| }; | ||
|
|
||
| if (makeExploreUrl && metricsQuery) { | ||
| tracesLink = makeExploreUrl(metricsQuery, filteredSelection); | ||
| } | ||
| } | ||
|
|
||
| return ( | ||
|
|
@@ -221,18 +251,32 @@ export function HeatMapWidgetVisualization(props: HeatMapWidgetVisualizationProp | |
| </span>{' '} | ||
| {formattedZValue} | ||
| </div> | ||
| {makeExploreUrl && defined(tracesLink) && ( | ||
| <div> | ||
| <span className="tooltip-label tooltip-label-centered"> | ||
| <a data-traces-link={tracesLink} href={tracesLink}> | ||
| {t('View connected spans')} | ||
| </a> | ||
| </span> | ||
| </div> | ||
| )} | ||
| {updateLocalFilterQuery && defined(metricsQuery) && ( | ||
| <div> | ||
| <span className="tooltip-label tooltip-label-centered"> | ||
| <a data-local-query={metricsQuery}>{t('Add to filter')}</a> | ||
| </span> | ||
| </div> | ||
| )} | ||
| </Fragment> | ||
| ); | ||
| })} | ||
| </div> | ||
| <div | ||
| className="tooltip-footer tooltip-footer-centered" | ||
| style={{cursor: 'default'}} | ||
| > | ||
| {formattedXValue} | ||
| </div> | ||
| <div className="tooltip-arrow" /> | ||
| </Fragment> | ||
| ); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Since we're setting this directly and not returning anything in it, should the description be updated 👀