From 97c340cafc4fdaeba0dc8088496d0f92e403a021 Mon Sep 17 00:00:00 2001 From: Chethan A C Date: Sat, 19 Jul 2025 17:36:41 +0530 Subject: [PATCH 1/2] docs: clarify tag search behavior in Jaeger UI (fixes jaegertracing/jaeger#7333) Signed-off-by: Chethan A C --- content/docs/v1/1.71/deployment/frontend-ui.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/docs/v1/1.71/deployment/frontend-ui.md b/content/docs/v1/1.71/deployment/frontend-ui.md index a7dcde8e..f36894c6 100644 --- a/content/docs/v1/1.71/deployment/frontend-ui.md +++ b/content/docs/v1/1.71/deployment/frontend-ui.md @@ -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. + +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. From 71a5b8911f9e5bb86375945d7a4ef7432d8aa78b Mon Sep 17 00:00:00 2001 From: Chethan A C Date: Sat, 19 Jul 2025 20:34:14 +0530 Subject: [PATCH 2/2] docs: clarify tag search behavior in Jaeger UI (move to v2 _dev, clarify array tag indexing) Signed-off-by: Chethan A C --- content/docs/v2/_dev/deployment/frontend-ui.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/docs/v2/_dev/deployment/frontend-ui.md b/content/docs/v2/_dev/deployment/frontend-ui.md index 06fcb87b..e70d2b66 100644 --- a/content/docs/v2/_dev/deployment/frontend-ui.md +++ b/content/docs/v2/_dev/deployment/frontend-ui.md @@ -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"]'`). + +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.