Documentation

Overview

Package trace is an auto-generated package for the Stackdriver Trace API.

Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

    DefaultAuthScopes reports the default set of authentication scopes to use with this package.

    func ProjectPath

    func ProjectPath(project string) string

      ProjectPath returns the path for the project resource.

      Deprecated: Use

      fmt.Sprintf("projects/%s", project)
      

      instead.

      func SpanPath

      func SpanPath(project, trace, span string) string

        SpanPath returns the path for the span resource.

        Deprecated: Use

        fmt.Sprintf("projects/%s/traces/%s/spans/%s", project, trace, span)
        

        instead.

        Types

        type CallOptions

        type CallOptions struct {
        	BatchWriteSpans []gax.CallOption
        	CreateSpan      []gax.CallOption
        }

          CallOptions contains the retry settings for each method of Client.

          type Client

          type Client struct {
          
          	// The call options for this service.
          	CallOptions *CallOptions
          	// contains filtered or unexported fields
          }

            Client is a client for interacting with Stackdriver Trace API.

            Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

            func NewClient

            func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

              NewClient creates a new trace service client.

              This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. A single trace may contain span(s) from multiple services.

              Example
              Output:
              
              

              func (*Client) BatchWriteSpans

              func (c *Client) BatchWriteSpans(ctx context.Context, req *cloudtracepb.BatchWriteSpansRequest, opts ...gax.CallOption) error

                BatchWriteSpans sends new spans to new or existing traces. You cannot update existing spans.

                Example
                Output:
                
                

                func (*Client) Close

                func (c *Client) Close() error

                  Close closes the connection to the API service. The user should invoke this when the client is no longer required.

                  func (*Client) Connection

                  func (c *Client) Connection() *grpc.ClientConn

                    Connection returns a connection to the API service.

                    Deprecated.

                    func (*Client) CreateSpan

                    func (c *Client) CreateSpan(ctx context.Context, req *cloudtracepb.Span, opts ...gax.CallOption) (*cloudtracepb.Span, error)

                      CreateSpan creates a new span.

                      Example
                      Output: