go: cloud.google.com/go/trace/apiv2 Index | Examples | Files

package trace

import "cloud.google.com/go/trace/apiv2"

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 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 godoc.org/cloud.google.com/go.

Index

Examples

Package Files

doc.go path_funcs.go trace_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

func ProjectPath Uses

func ProjectPath(project string) string

ProjectPath returns the path for the project resource.

Deprecated: Use

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

instead.

func SpanPath Uses

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.

type CallOptions Uses

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

CallOptions contains the retry settings for each method of Client.

type Client Uses

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 Uses

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.

Code:

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

func (*Client) BatchWriteSpans Uses

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.

Code:

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

func (*Client) Close Uses

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 Uses

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

Connection returns the client's connection to the API service.

func (*Client) CreateSpan Uses

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

CreateSpan creates a new span.

Code:

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

Package trace imports 15 packages (graph) and is imported by 2 packages. Updated 2019-08-24. Refresh now. Tools for package owners.