package trace

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

Index ¶

• func DefaultAuthScopes() []string
• func ProjectPath(project string) string
• func SpanPath(project, trace, span string) string
• type CallOptions
• type Client
• func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
• func (c *Client) BatchWriteSpans(ctx context.Context, req *cloudtracepb.BatchWriteSpansRequest, opts ...gax.CallOption) error
• func (c *Client) Close() error
• func (c *Client) Connection() *grpc.ClientConn
• func (c *Client) CreateSpan(ctx context.Context, req *cloudtracepb.Span, opts ...gax.CallOption) (*cloudtracepb.Span, error)

Examples ¶

• Client.BatchWriteSpans
• Client.CreateSpan
• NewClient

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.

package main

import (
	"context"

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

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

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.

package main

import (
	"context"

	trace "cloud.google.com/go/trace/apiv2"
	cloudtracepb "google.golang.org/genproto/googleapis/devtools/cloudtrace/v2"
)

func main() {
	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 ¶

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.

package main

import (
	"context"

	trace "cloud.google.com/go/trace/apiv2"
	cloudtracepb "google.golang.org/genproto/googleapis/devtools/cloudtrace/v2"
)

func main() {
	// import cloudtracepb "google.golang.org/genproto/googleapis/devtools/cloudtrace/v2"

	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
}

Source Files ¶

doc.go path_funcs.go trace_client.go