Quickstart

This page shows you how to perform basic operations for a project that is using Cloud Trace. For details on how to instrument your application in various environments and languages, see Setting up Cloud Trace.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. In the Cloud Console, on the project selector page, select or create a Cloud project.

    Go to the project selector page

  3. Make sure that billing is enabled for your Google Cloud project. Learn how to confirm billing is enabled for your project.

Tracing interface

To open the Cloud Trace interface, in the Google Cloud Console navigation pane, select Trace, or use the following button:

Go to Trace

Overview window

The Overview window is the default view in Trace. This window displays latency data and summary information:

Cloud Trace overview page.

The latency information contains links to specific traces and the summary information includes the number of spans ingested in the current and previous month.

A trace describes the time it takes an application to complete a single operation. Each trace consists of one of more spans. A span describes how long it takes to perform a complete sub-operation. For example, a trace might describe how long it takes to process an incoming request from a user and return a response. A span might describe how long a particular RPC call requires. For more information, see Cloud Trace's Data model.

Find a trace

Go to the Trace list page to view a list of recent requests to your application. The trace list allows you to browse and filter all associated traces by URI, module, version, time range, and other parameters.

If you haven't deployed an application that is instrumented to generate trace data, then the Trace list page displays the message There are no matched traces.

If you have trace data, you can use the trace list to find traces whose details you want to view:

Sample Cloud Trace list pane.

View trace details

Click the URI of any displayed trace in the trace list. The trace details appear in the Google Cloud Console.

The detail view shows a summary of details about the request, a graphical timeline that shows the root span for the end-to-end request and subspans for any RPC calls, and a detailed view of latency data collected for the spans:

Sample Cloud Trace details pane.

Create an analysis report

An analysis report shows you an overall view of latency for a set of requests to your application.

To create an analysis report:

  1. In the navigation panel, click Analysis reports. If you have any reports, they are listed:

    Sample analysis reports page.

  2. At the top of the analysis-reports page, click + New Report.

  3. To include all requests in the report, enter the root span name into the Request filter field. In the previous figure, the root span name is /. You can also enter filter terms in this field to select a subset of traces for the analysis report. See Analysis reports for more information.

  4. Accept the remainder of the default settings for the report. For the time span, the default is the hour previous to when the report was created.

  5. Click Submit to create the report. The new report appears in the analysis report list.

View an analysis report

To view an analysis report, in the analysis report list described above, click the name of the report:

Display of a specific analysis report.

  • To view the distribution of requests along a logarithmic axis of average latency times, click the Density distribution button.

  • To view the percentage of requests along a logarithmic axis of average latency times, click the Cumulative distribution button.

The Latency panel below the graph shows the average latency times by percentage with links to traces. To view trace details for representative samples of requests at different percentiles, click a number in the Sample Traces column.

If bottlenecks have been identified, then Trace displays a Bottlenecks panel. When displayed, this panel includes links to sample traces. By clicking these links, you can review and analyze specific traces.

What's next