Learn how to query for Wavefront trace data.

After your application sends trace data to Wavefront, you can examine that data in the Traces browser. By fine-tuning the trace query in the Traces browser, you find the traces that you’re interested in by describing the spans they must contain.

Get Started with Trace Queries

To query traces, select Applications > Traces and navigate to the Traces browser.

Query traces using a trace ID:

  1. Click Trace ID and enter the ID of the trace or traces you want to query. query traces by trace ID
  2. Click Search in the query bar.

Query traces using an operation:

  1. Click Operation and select an operation.
  2. Optionally, add one or more filters to refine your query. tracing query builder
  3. Click Search in the query bar.

Select an Operation

You select an operation to display traces with at least one span that represents the work done by that operation.

1. Select Applications > Traces to open the Traces browser.

 

2. Click the Operation selector to open the cascading menu.
tracing query builder operation selector
3. Use the drill-down to select the application, service, and operation.

 

4. Either add filters (see below) or click Search to display results.
tracing query builder operation menu

Wildcard Selection

You can select * instead of name components to select all operations in a service, or all operations in all services:

tracing query builder operation menu

Add Filters

After you have selected an operation, you can optionally add filters to further describe the traces you want to see. You can add different types of filters in any order.

  1. Select an operation.
  2. Click Add Filter and select a filter type. tracing query builder filter type menu
    Choose This Filter TypeTo Return
    Tag Traces that have at least one span with a selected tag or a selected source (host). Use this type for indexed tags that your application uses, typically cluster, shard, component, source, and so on.
    RawTag Traces that have at least one span with a specified tag, for example, env="prod". Use this type for custom or unindexed span tags.
    SpanLog Traces that have span logs.
    Duration (Trace) Traces that have a specified minimum and/or maximum length (in milliseconds).
    Duration (Span) Traces that have a specified minimum and/or maximum span length (in milliseconds).
    Limit Up to a specified number of traces.
    Error Traces with at least one span that contains an error (error=true).
    TraceId The trace or traces that match the trace ID or trace IDs.
  3. Click next to the filter type and specify the filter setting. See the example given below.
  4. Click Add Filter to add another filter or click Search to display results.

Remove Filters

You can remove an individual filter:

  1. Click the X in the filter box:
  2. Click Search to update the displayed results.
tracing query builder remove filter

If you want to start the query all over, click Clear to remove the operation name and all filters:

tracing query builder clear

Example

Suppose you want to find traces that contain spans for an operation called notify, which is called from the notification service of the beachshirts application. You’re interested only in seeing traces that are emitted from a particular source and that are longer than 30 milliseconds.

  1. Select the operation from the cascading Operation menu.
  2. Click Add Filter and select Tag.
  3. Click the Tags selector to open a cascading menu of tag types.
  4. Select the source tag type to display a menu of source names, and select the source name you want. tracing query builder select source
  5. Click Add Filter and select Duration.
  6. Click the min/max Duration selector to display fields for specifying durations. tracing query builder select duration
  7. Type 30 in the Min Duration field and click Apply.
  8. Click Search to display the results. tracing query builder complete

View Trace Queries in Query Editor

Query Builder generates a query that includes the traces() function and one or more filtering functions. You can:

Note: If you change a query using Query Editor, you cannot go back to Query Builder.

Trace Query Results

A trace query:

  1. Finds the spans that match the description you specify.
  2. Finds the traces that contain at least one matching span.
  3. Uses duration thresholds (if you specified any) to filter the set of returned traces.

For example, you can query for traces with at least one member span that meets the following criteria:

  • Represents an operation called dispatch that is performed by a service called delivery.
  • Represents work done on a cluster called us-west-2.
  • Is associated with a custom tag env=production.

If you also specified a minimum (or maximum) duration, the query filters out any traces that are shorter (longer) than the threshold you specified.

Graphic Representation of a Returned Trace

Wavefront displays a bar for each trace that is returned by a trace query. The bar’s length visually indicates the trace’s duration. A blue area in the bar indicates where a matching span occurs in the trace, and how much of the trace it occupies:

tracing query results

How Wavefront Labels a Returned Trace

Each bar that is returned by a query represents a unique trace that has a unique trace ID. For readability, we label each trace by its root span, which is the first span in the trace. The trace’s label is the name of the operation that the root span represents.

For example, the two returned traces shown above both have a root span that represents work done by an operation called ShoppingWebResource.getShoppingMenu. However, these root spans represent different executions of the operation, with different start times. Although the two root spans have the same operation name, they mark the beginning of two different traces.

Note: A trace’s root span might differ from the span that was specified in the query. For example, suppose you query for spans that represent getAvailableColors operations. The query could return traces that begin with ShoppingWebResource.getShoppingMenu, if those traces contain a getAvailableColors span.

Limit and Sort the Result Set

The browser allows you to fine-tune what you see.

  • Use the Limit filter to limit the number of returned traces and make your query complete faster. The trace query starts by returning the most recent traces. After reaching the limit, the query stops looking for more traces.

    Note: The current time window for the Traces browser also implicitly limits by the result set. Traces are returned only if they contain a matching span and start in the current time window.

  • Sort a set of returned traces by selecting a sort order from the Sort By menu. For example, choose Outliers to start with the traces whose duration is unusually long or unusually short. Or, choose Most Spans to start with the traces that contain the largest number of spans.

If you both limit and sort the query results, sorting applies after limiting. For example, suppose you limit the number of returned traces to 50, and then sort the result set from shortest to longest. The sorted list includes only the 50 traces that were originally returned by the query. We do not first sort all traces containing a matching span, and then display the 50 shortest traces.

Note: If you’ve enabled a sampling strategy, results are found among the spans that have actually been ingested. The query does not search through spans before they’ve been sampled.

Use Query Editor (Power Users)

Query Builder works well for many use cases, but sometimes Query Editor is your best option.

  1. Select Applications > Traces in the task bar to display the Traces browser.
  2. Click the icon to toggle to Query Editor:
  3. Type a query that includes the traces() function.
  4. Click Search to update the list of traces.
tracing query toggle