Skip to content

docs: clarify tag search behavior in Jaeger UI (fixes jaegertracing/jaeger#7333) #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chethanac15 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify tag search behavior in Jaeger UI (fixes jaegertracing/jaeger#7333) #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97c340c
docs: clarify tag search behavior in Jaeger UI (fixes jaegertracing/j…
chethanac15 Jul 19, 2025
71a5b89
docs: clarify tag search behavior in Jaeger UI (move to v2 _dev, clar…
chethanac15 Jul 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/docs/v1/1.71/deployment/frontend-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ Arguments:

Example: `#{startTime | add 1000000}`

## Tag Search Behavior

Jaeger UI indexes and allows searching for tags/attributes only if their values are strings. If a tag is set as an array (e.g., `["value"]`), it will not be searchable in the UI. This is important for users who want to search for specific tags, such as request IDs, in the Jaeger UI.
Copy link
Member

@yurishkuro yurishkuro Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is accurate. If the array tag can be retrieved from db then it was indexed as well, but most likely as a JSON string.


When instrumenting your application, ensure that important tags (such as request IDs) are set as string values, not arrays. For example, when using OpenTelemetry SDKs, avoid configurations that result in array values for tags you wish to search. This behavior is discussed in [issue #7333](https://github.com/jaegertracing/jaeger/issues/7333).

## Embedded Mode

Starting with version 1.9, Jaeger UI provides an "embedded" layout mode which is intended to support integrating Jaeger UI into other applications. Currently (as of `v0`), the approach taken is to remove various UI elements from the page to make the UI better suited for space-constrained layouts.
Expand Down
8 changes: 8 additions & 0 deletions content/docs/v2/_dev/deployment/frontend-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,14 @@ Field | Description

This will display trace IDs like: `1a2b3c4d5e6f` (instead of the full 32-character ID or default 7-character).

## Tag Search Behavior

Jaeger UI indexes and allows searching for tags (attributes) whose values are strings. If a tag is set as an array (for example, `["value"]`), it may be indexed as a JSON string (e.g., `'["value"]'`). In such cases, you would need to search for the exact JSON string representation in the UI. This can be confusing, as searching for just `value` will not match an array-valued tag; you must search for the full JSON string (e.g., `'["value"]'`).
Copy link
Member

@yurishkuro yurishkuro Jul 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it may be indexed as a JSON string (e.g., '["value"]'

are you just restating what I said or did you validate it? Can you search by a string like that?

Copy link
Member

@yurishkuro yurishkuro Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a bug. I don't want to make changes to documentation before we fix the bug. jaegertracing/jaeger#7346


For best results, ensure that important tags (such as request IDs) are set as strings, not arrays, when instrumenting your applications. This will make them directly searchable in the Jaeger UI.

> See also: [GitHub issue #7333](https://github.com/jaegertracing/jaeger/issues/7333) for more context on this behavior.

## Embedded Mode

Starting with version 1.9, Jaeger UI provides an "embedded" layout mode which is intended to support integrating Jaeger UI into other applications. Currently (as of `v0`), the approach taken is to remove various UI elements from the page to make the UI better suited for space-constrained layouts.
Expand Down