trace

Documentation

Overview

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

NOTE: This package is in alpha. It is not stable, and is likely to change.

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.

Use the client at cloud.google.com/go/trace in preference to this.

Index

• func DefaultAuthScopes() []string
• type CallOptions
• type Client
  • func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Connection() *grpc.ClientConn
  • func (c *Client) GetTrace(ctx context.Context, req *cloudtracepb.GetTraceRequest, opts ...gax.CallOption) (*cloudtracepb.Trace, error)
  • func (c *Client) ListTraces(ctx context.Context, req *cloudtracepb.ListTracesRequest, ...) *TraceIterator
  • func (c *Client) PatchTraces(ctx context.Context, req *cloudtracepb.PatchTracesRequest, ...) error
  • func (c *Client) SetGoogleClientInfo(keyval ...string)
• type TraceIterator
  • func (it *TraceIterator) Next() (*cloudtracepb.Trace, error)
  • func (it *TraceIterator) PageInfo() *iterator.PageInfo

Examples

• Client.GetTrace
• Client.ListTraces
• Client.PatchTraces
• NewClient

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 {
	PatchTraces []gax.CallOption
	GetTrace    []gax.CallOption
	ListTraces  []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

ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c

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 the client's connection to the API service.

func (*Client) GetTrace

func (c *Client) GetTrace(ctx context.Context, req *cloudtracepb.GetTraceRequest, opts ...gax.CallOption) (*cloudtracepb.Trace, error)

GetTrace gets a single trace by its ID.

Example

ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &cloudtracepb.GetTraceRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetTrace(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

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

ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &cloudtracepb.ListTracesRequest{
	// TODO: Fill request struct fields.
}
it := c.ListTraces(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

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

ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &cloudtracepb.PatchTracesRequest{
	// TODO: Fill request struct fields.
}
err = c.PatchTraces(ctx, req)
if err != nil {
	// TODO: Handle error.
}

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. Intended for use by Google-written clients.

type TraceIterator

type TraceIterator struct {

	// 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.