Update docs for link parameter formatting

Signed-off-by: Drew Corlin <[email protected]>
jaegertracing · Nov 30, 2024 · 44c2274 · 44c2274
1 parent 67dc2a5
commit 44c2274
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/content/docs/next-release-v2/frontend-ui.md b/content/docs/next-release-v2/frontend-ui.md
@@ -66,6 +66,11 @@ An example configuration file (see [complete schema here](https://github.com/jae
     "key": "uniqueId",
     "url": "https://mykibana.com/uniqueId=#{uniqueId}&traceId=#{trace.traceID}",
     "text": "Redirect to kibana to view log"
+  },
+  {
+    "type": "traces",
+    "url": "https://mykibana.com/_dashboards/app/discover#/?_g=(time:(from:'#{startTime | epoch_micros_to_date_iso}',to:'#{endTime | epoch_micros_to_date_iso}'))&_a=(index:filebeat-all,query:(language:kuery,query:'#{traceID}'))",
+    "text": "Redirect to kibana to view log with formatted dates"
   }]
 }
 ```
@@ -146,6 +151,13 @@ For traces, the supported template fields are: `duration`, `endTime`, `startTime
 
 Further, the trace template fields are available for substitution in process/logs/tags type when the trace template fields are prefixed with `trace.`. For example: `trace.traceID`, `trace.startTime`.
 
+#### Formatting
+
+In addition to interpolating fields into links, formatting functions can be used. The syntax is `#{field | function}` (eg `#{endTime | epoch_micros_to_date_iso}'`). The available formatting functions and a description of their behavior are:
+| Function | Description | Example |
+| -------- | ----------- | ------- |
+| `epoch_micros_to_date_iso` | Format a date in microseconds since epoch to an ISO date time | `#{endTime \| epoch_micros_to_date_iso}` |
+
 ## 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.

diff --git a/content/docs/next-release/frontend-ui.md b/content/docs/next-release/frontend-ui.md
@@ -66,6 +66,11 @@ An example configuration file (see [complete schema here](https://github.com/jae
     "key": "uniqueId",
     "url": "https://mykibana.com/uniqueId=#{uniqueId}&traceId=#{trace.traceID}",
     "text": "Redirect to kibana to view log"
+  },
+  {
+    "type": "traces",
+    "url": "https://mykibana.com/_dashboards/app/discover#/?_g=(time:(from:'#{startTime | epoch_micros_to_date_iso}',to:'#{endTime | epoch_micros_to_date_iso}'))&_a=(index:filebeat-all,query:(language:kuery,query:'#{traceID}'))",
+    "text": "Redirect to kibana to view log with formatted dates"
   }]
 }
 ```
@@ -146,6 +151,13 @@ For traces, the supported template fields are: `duration`, `endTime`, `startTime
 
 Further, the trace template fields are available for substitution in process/logs/tags type when the trace template fields are prefixed with `trace.`. For example: `trace.traceID`, `trace.startTime`.
 
+#### Formatting
+
+In addition to interpolating fields into links, formatting functions can be used. The syntax is `#{field | function}` (eg `#{endTime | epoch_micros_to_date_iso}'`). The available formatting functions and a description of their behavior are:
+| Function | Description | Example |
+| -------- | ----------- | ------- |
+| `epoch_micros_to_date_iso` | Format a date in microseconds since epoch to an ISO date time | `#{endTime \| epoch_micros_to_date_iso}` |
+
 ## 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.