feat: Add custom trace-level attributes above trace waterfall #1356

pulpdrew · 2025-11-12T20:18:33Z

Ref HDX-2752

Summary

This PR adds a new Source setting which specifies additional Span-Level attributes which should be displayed above the Trace Waterfall. The attributes may be specified for both Log and Trace kind sources.

These are displayed on the trace panel rather than at the top of the side panel because they are trace level (from any span in the trace), whereas the top of the side panel shows information specific to the span. In a followup PR, we'll add row-level attributes, which will appear at the top of the side panel.

Notes:

The attributes are pulled from the log and trace source (if configured for each) despite the search page only being set to query one of those sources. If an attribute value comes from the log source while the trace source is currently configured on the search page, the attribute tag will not offer the option to show the "Add to search" button and instead will just show a "search this value" option, which navigates the search page to search the value in the correct source.

Demo

First, source is configured with highlighted attributes:

Values for those attributes within the trace show up on the trace panel above the waterfall:

Values are searchable when clicked, and if a lucene version of the property is provided, the lucene version will be used in the search box

changeset-bot · 2025-11-12T20:18:37Z

🦋 Changeset detected

Latest commit: 31cb5e9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@hyperdx/common-utils	Patch
@hyperdx/api	Patch
@hyperdx/app	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-11-12T20:18:38Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
hyperdx-v2-oss-app	Ready	Preview	Comment	Nov 18, 2025 7:34pm

claude · 2025-11-12T20:19:45Z

PR Review - feat: Add custom trace-level attributes above trace waterfall

Critical Issues

None found

Code Quality Issues

SQL Injection Risk in EventTag.tsx:48 - Using SqlString.format with SqlString.raw(name) allows raw SQL. Validate name parameter or use prepared statements
Missing error boundary in DBHighlightedAttributesList - Wrap component in try-catch or error boundary to prevent entire panel crash if attribute rendering fails
Deprecated props removed without migration path in NetworkPropertyPanel.tsx:28,29 - Removed onPropertyAddClick and generateSearchUrl props. Verify no breaking changes to existing usages
useMemo missing dependency in DBTraceWaterfallChart.tsx:297 - dateRangeStartInclusive marked as added dependency but not verified in implementation

Observations

Comprehensive test coverage (480 lines of tests)
Proper TypeScript typing throughout
Good separation of concerns (utility functions in separate file)
Zod schema validation for new fields
Handles edge cases (null, undefined, empty strings)

Recommendations

Add input validation for SQL expressions before using SqlString.raw()
Consider adding error boundaries around new components
Verify NetworkPropertyPanel change does not break existing features

github-actions · 2025-11-12T20:25:31Z

E2E Test Results

✅ All tests passed • 39 passed • 3 skipped • 395s

Status	Count
✅ Passed	39
❌ Failed	0
⚠️ Flaky	1
⏭️ Skipped	3

View full report →

pulpdrew · 2025-11-13T13:18:43Z

packages/app/src/hooks/useRowWhere.tsx


          // Currently we can't distinguish null or 'null'
-          if (value === 'null') {
+          if (value == null || value === 'null') {


JSON column values were being returned as actual null values here, which then broke the value.length check below.

nit: it would be helpful to add examples in the comment (for null case)

packages/app/src/components/SourceForm.tsx

pulpdrew · 2025-11-14T19:59:13Z

packages/app/src/searchFilters.tsx

  React.useEffect(() => {
-    if (
-      !areFiltersEqual(filters, parsedQuery.filters) &&
-      Object.values(parsedQuery.filters).length > 0


This check was preventing us from clearing the filter state if all filters were removed from the URL params (which happens when changing sources due to clicking on an attribute from a different source)

packages/app/src/components/EventTag.tsx

packages/app/src/DBSearchPage.tsx

wrn14897 · 2025-11-18T18:41:26Z

packages/api/src/models/source.ts

      statusCodeExpression: String,
      statusMessageExpression: String,
      spanEventsValueExpression: String,
+      highlightedTraceAttributeExpressions: {


does the ordering matter here?

The ordering of elements in this array? No I don't think it matters - the Event Tags are sorted before they're displayed client-side. Why?

since it's an array type, it makes sense to sort them before deploying, or we can sort them during query time

The way we end up sorting them on the UI can depend on the values that are queried for each attribute and for each trace. There also should not be very many attributes (dozens at most, I would guess) so I don't think it should be any issue with sorting them on the client side when used.

wrn14897

lgtm

Closes HDX-2776 Closes HDX-2752 # Summary This PR extends the custom attributes feature from #1356 to support custom attributes on individual rows (rather than entire traces). Further, attributes which are URLs are now rendered as links, supporting use-cases which require building custom external links from queried data. ## Demo Source Configuration: <img width="972" height="649" alt="Screenshot 2025-11-18 at 6 01 55 PM" src="https://github.com/user-attachments/assets/42e9cc95-d9e3-4155-8e25-58e4dcf0b787" /> Side panel: <img width="1587" height="511" alt="Screenshot 2025-11-18 at 6 02 12 PM" src="https://github.com/user-attachments/assets/3a1d7683-eb79-4925-99fe-4e2d7cdad78f" /> Inferred link: <img width="727" height="173" alt="Screenshot 2025-11-18 at 6 02 32 PM" src="https://github.com/user-attachments/assets/68f42f95-598c-4b30-b616-9556e32945bf" /> <details> <summary>logview attribute definition</summary> ```sql if( NOT empty(TraceId) AND NOT empty(SpanId) AND NOT empty(ServiceName), concat('https://logview.com?q=', 'trace_id=', TraceId, '&span_id=', SpanId, '&service=', ServiceName, '&start_time=', formatDateTime(Timestamp - INTERVAL 1 SECOND, '%FT%T.%fZ'), '&end_time=', formatDateTime(Timestamp + Duration/1e9 + INTERVAL 1 SECOND, '%FT%T.%fZ') ), '' ) ``` </details>

vercel bot had a problem deploying to Preview November 12, 2025 20:23 Failure

vercel bot deployed to Preview November 12, 2025 22:05 View deployment

pulpdrew commented Nov 13, 2025

View reviewed changes

pulpdrew marked this pull request as ready for review November 13, 2025 13:24

pulpdrew requested review from a team and wrn14897 and removed request for a team November 13, 2025 13:24

elizabetdev reviewed Nov 13, 2025

View reviewed changes

packages/app/src/components/SourceForm.tsx Outdated Show resolved Hide resolved

packages/app/src/components/SourceForm.tsx Outdated Show resolved Hide resolved

vercel bot deployed to Preview November 13, 2025 14:09 View deployment

pulpdrew marked this pull request as draft November 14, 2025 02:04

feat: Add custom trace-level attributes above trace waterfall

744024c

pulpdrew force-pushed the drew/trace-attribute-tags branch from c3a22b0 to 744024c Compare November 14, 2025 18:21

vercel bot deployed to Preview November 14, 2025 18:25 View deployment

pulpdrew added 2 commits November 14, 2025 14:33

fix: Clear filter state when URL filters param is removed

617bd16

test: Fix tests

d895a3a

vercel bot deployed to Preview November 14, 2025 19:43 View deployment

pulpdrew commented Nov 14, 2025

View reviewed changes

feat: Improvements to the custom trace attributes

ad3fdf3

vercel bot deployed to Preview November 14, 2025 20:16 View deployment

test: Add additional tests for getAttributesFromData

f6e12c8

vercel bot deployed to Preview November 14, 2025 20:37 View deployment

pulpdrew marked this pull request as ready for review November 14, 2025 21:08

refactor: Rename highlightedTraceAttributeExpressions

2f5d71f

vercel bot deployed to Preview November 17, 2025 15:17 View deployment

refactor: Create DBHighlightedAttributesList and related utils

c1f6abd

vercel bot deployed to Preview November 18, 2025 13:51 View deployment

wrn14897 reviewed Nov 18, 2025

View reviewed changes

packages/app/src/components/EventTag.tsx Outdated Show resolved Hide resolved

wrn14897 reviewed Nov 18, 2025

View reviewed changes

packages/app/src/components/EventTag.tsx Show resolved Hide resolved

wrn14897 reviewed Nov 18, 2025

View reviewed changes

packages/app/src/DBSearchPage.tsx Show resolved Hide resolved

wrn14897 reviewed Nov 18, 2025

View reviewed changes

review: Fix style

9dd50a7

vercel bot deployed to Preview November 18, 2025 18:51 View deployment

wrn14897 approved these changes Nov 18, 2025

View reviewed changes

pulpdrew added the automerge label Nov 18, 2025

Merge branch 'main' into drew/trace-attribute-tags

31cb5e9

kodiakhq bot merged commit c4915d4 into main Nov 18, 2025
10 of 11 checks passed

kodiakhq bot deleted the drew/trace-attribute-tags branch November 18, 2025 19:34

vercel bot deployed to Preview November 18, 2025 19:34 View deployment

pulpdrew mentioned this pull request Nov 18, 2025

feat: Add custom attributes for individual rows #1379

Merged

feat: Add custom trace-level attributes above trace waterfall #1356

feat: Add custom trace-level attributes above trace waterfall #1356

Uh oh!

Conversation

pulpdrew commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Demo

Uh oh!

changeset-bot bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

claude bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review - feat: Add custom trace-level attributes above trace waterfall

Critical Issues

Code Quality Issues

Observations

Recommendations

Uh oh!

github-actions bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Test Results

Uh oh!

pulpdrew Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

wrn14897 Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pulpdrew Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wrn14897 Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

pulpdrew Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

wrn14897 Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

pulpdrew Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

wrn14897 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pulpdrew commented Nov 12, 2025 •

edited

Loading

changeset-bot bot commented Nov 12, 2025 •

edited

Loading

vercel bot commented Nov 12, 2025 •

edited

Loading

claude bot commented Nov 12, 2025 •

edited

Loading

github-actions bot commented Nov 12, 2025 •

edited

Loading