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.

    Types

    type CallOptions

    type CallOptions struct {
    	ListTraces  []gax.CallOption
    	GetTrace    []gax.CallOption
    	PatchTraces []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. Spans for a single trace may span multiple services.

          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) GetTrace

                GetTrace gets a single trace by its ID.

                Example
                Output:
                
                

                func (*Client) ListTraces

                func (c *Client) ListTraces(ctx context.Context, req *cloudtracepb.ListTracesRequest, opts ...gax.CallOption) *TraceIterator

                  ListTraces returns of a list of traces that match the specified filter conditions.

                  Example
                  Output:
                  
                  

                  func (*Client) PatchTraces

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

                    PatchTraces sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.

                    Example
                    Output:
                    
                    

                    func (*Client) SetGoogleClientInfo

                    func (c *Client) SetGoogleClientInfo(keyval ...string)

                      SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Also passes any provided key-value pairs. Intended for use by Google-written clients.

                      Internal use only.

                      type TraceIterator

                      type TraceIterator struct {
                      
                      	// Response is the raw response for the current page.
                      	// It must be cast to the RPC response type.
                      	// Calling Next() or InternalFetch() updates this value.
                      	Response interface{}
                      
                      	// InternalFetch is for use by the Google Cloud Libraries only.
                      	// It is not part of the stable interface of this package.
                      	//
                      	// InternalFetch returns results from a single call to the underlying RPC.
                      	// The number of results is no greater than pageSize.
                      	// If there are no more results, nextPageToken is empty and err is nil.
                      	InternalFetch func(pageSize int, pageToken string) (results []*cloudtracepb.Trace, nextPageToken string, err error)
                      	// contains filtered or unexported fields
                      }

                        TraceIterator manages a stream of *cloudtracepb.Trace.

                        func (*TraceIterator) Next

                        func (it *TraceIterator) Next() (*cloudtracepb.Trace, error)

                          Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

                          func (*TraceIterator) PageInfo

                          func (it *TraceIterator) PageInfo() *iterator.PageInfo

                            PageInfo supports pagination. See the google.golang.org/api/iterator package for details.