Document traceIdDisplayLength option (#885)

Fixes jaegertracing/jaeger-ui#2092

----

![image](https://github.com/user-attachments/assets/74e04d90-df8c-44ba-96c6-f4f1df0f288c)

![image](https://github.com/user-attachments/assets/6394718c-ab06-4d3a-a2ee-25a4b45c8fee)

Signed-off-by: Abhay Kumar Gupta <abhayakg123@gmail.com>
This commit is contained in:
Abhay Porwal 2025-05-22 04:11:30 +05:30 committed by GitHub
parent f5e43aa925
commit 726bfdf1ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 1 deletions

View File

@ -71,7 +71,8 @@ An example configuration file (see [complete schema here](https://github.com/jae
"type": "traces",
"url": "https://my-logs.server?from=#{startTime | add -60000000 | epoch_micros_to_date_iso}&to=#{endTime | add 60000000 | epoch_micros_to_date_iso}'",
"text": "Redirect to kibana to view log with formatted dates"
}]
}],
"traceIdDisplayLength": 20
}
```
@ -185,6 +186,24 @@ Arguments:
Example: `#{startTime | add 1000000}`
### Trace ID Display Length
The `traceIdDisplayLength` setting controls how many characters of the trace ID are displayed in the Jaeger UI (e.g., in the trace list or trace detail header). This is useful for improving readability or aligning with trace IDs in other systems like logs or dashboards.
Field | Description
------|------------
`traceIdDisplayLength` | Optional. Integer value that determines the number of characters shown from the trace ID. Default is `7`.
**Example:**
```json
{
"traceIdDisplayLength": 12
}
```
This will display trace IDs like: `1a2b3c4d5e6f` (instead of the full 32-character ID or default 7-character).
## 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.