What is a Direct Trace Link?
A direct trace link is a Honeycomb URL that opens a trace waterfall view using a Trace ID. When someone opens a direct trace link, Honeycomb displays the trace waterfall view for that specific trace.Embedding Honeycomb pages, including trace waterfalls, within an
iframe isn’t supported.Creating a Direct Link to a Trace
Construct a direct trace link by combining your Honeycomb region, trace context, and time range into a URL.URL Format
To open a trace directly, construct a URL in this format:trace_id within the specified time range.
If you are linking to a dataset in Honeycomb Classic, use this URL format instead:
URL Parameters
Each part of the URL identifies the trace and its context:Region Parameters
subdomain: Subdomain of the Honeycomb UI instance for your region:- US:
ui - EU:
ui-eu1
- US:
Trace Context Parameters
-
team: Slug for the Team in Honeycomb. This short, URL-friendly string uniquely identifies your Team and appears in Honeycomb URLs. -
environment: Slug for the Environment in Honeycomb. This short, URL-friendly string uniquely identifies your Environment and appears in Honeycomb URLs. -
dataset: Slug for the Dataset in Honeycomb. This short, URL-friendly string uniquely identifies your Dataset and appears in Honeycomb URLs.You can omit/datasets/<dataset>/from the URL and the link will still work: -
trace_id: Unique identifier of the trace. URL-encode if necessary. -
span: Unique identifier of the span to jump to within the trace. If no matching span is found, the link opens to the trace’s root span.
Time Range Parameters
trace_start_ts: Start time for the time range to search. Specified as a UNIX/Epoch-style integer timestamp in seconds (UTC). If only a start time is provided, Honeycomb searches for traces within ten minutes after this timestamp.trace_end_ts: End time for the time range to search. Specified as a UNIX/Epoch-style integer timestamp in seconds (UTC).
If you omit a time range entirely, Honeycomb searches from the current time back two hours.
Example
This example shows a complete direct trace link for the US region, including a span and a defined time range:Best Practices
Follow these tips to build direct trace links that load efficiently and return complete, reliable results:- Include a full time range for faster, more accurate results:
Adding both
trace_start_tsandtrace_end_tshelps Honeycomb locate the trace efficiently. - Keep the search window reasonable: Narrow ranges return results faster, while wider ranges help ensure all spans are included. Choose a range that balances speed and completeness.
- Adjust as needed for completeness: If some spans don’t appear, try slightly widening the time range to capture the full trace.
- Use flexible ranges when timing is uncertain:
If you only provide
trace_start_ts, Honeycomb automatically searches for traces within ten minutes after that time.
Limitations
Keep these points in mind to ensure your direct trace links work as expected:- Time range affects trace visibility: Narrow search windows may omit some spans, while very broad ranges can increase load time.
- Embedding isn’t supported:
Honeycomb pages, including trace waterfalls, cannot be displayed within an
iframe. - Honeycomb Classic datasets use a different URL format: Links to Honeycomb Classic datasets follow a slightly different template. To learn more, visit the Creating a Direct Link to a Trace section.