trace

package
Version: v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 9, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

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.

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 deprecated

This function has been deprecated.
func ProjectPath(project string) string

ProjectPath returns the path for the project resource.

Deprecated: Use

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

instead.

func SpanPath deprecated

This function has been deprecated.
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.

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
ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
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
ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &cloudtracepb.BatchWriteSpansRequest{
	// TODO: Fill request struct fields.
}
err = c.BatchWriteSpans(ctx, req)
if err != nil {
	// TODO: Handle error.
}
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 the client's connection to the API service.

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
ctx := context.Background()
c, err := trace.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL