package trace

Import Path
	cloud.google.com/go/trace/apiv2 (on go.dev)

Dependency Relation
	imports 17 packages, and imported by one package

Involved Source Files

	   d➜ doc.go
		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.

	      path_funcs.go
	      trace_client.go
Package-Level Type Names (total 4, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type CallOptions (struct)
		CallOptions contains the retry settings for each method of Client.

		Fields (total 2, both are exported)
			BatchWriteSpans []gax.CallOption
			CreateSpan []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultCallOptions() *CallOptions

	 type Client (struct)
		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.

		Fields (total 5, in which 1 are exported)
			CallOptions *CallOptions
				The call options for this service.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			client cloudtracepb.TraceServiceClient
				The gRPC API client.

			connPool gtransport.ConnPool
				Connection pool of gRPC connections to the service.

			disableDeadlines bool
				flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE

			xGoogMetadata metadata.MD
				The x-goog-* metadata to be sent with each request.

		Methods (total 5, in which 4 are exported)
			(*T) 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.

			(*T) Close() error
				Close closes the connection to the API service. The user should invoke this when
				the client is no longer required.

			(*T) Connection() *grpc.ClientConn
				Connection returns a connection to the API service.

				Deprecated.

			(*T) CreateSpan(ctx context.Context, req *cloudtracepb.Span, opts ...gax.CallOption) (*cloudtracepb.Span, error)
				CreateSpan creates a new span.

			/* one unexported ... *//* one unexported: */
			(*T) 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.

		Implements (at least one exported)
			*T : io.Closer
		As Outputs Of (at least one exported)
			func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func contrib.go.opencensus.io/exporter/stackdriver.newTraceExporterWithClient(o stackdriver.Options, c *Client) *stackdriver.traceExporter

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type clientHook (func)

		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var newClientHook

	 type clientHookParams (struct)
		For more information on implementing a client constructor hook, see
		https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors.



Package-Level Functions (total 9, in which 4 are exported)

	 func DefaultAuthScopes() []string
		DefaultAuthScopes reports the default set of authentication scopes to use with this package.

	 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.

	 func ProjectPath(project string) string
		ProjectPath returns the path for the project resource.

		Deprecated: Use
		  fmt.Sprintf("projects/%s", project)
		instead.

	 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.

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 func checkDisableDeadlines() (bool, error)
	 func defaultCallOptions() *CallOptions
	 func defaultClientOptions() []option.ClientOption
	 func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context
	 func versionGo() string
		versionGo returns the Go runtime version. The returned string
		has no whitespace, suitable for reporting in header.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var newClientHook clientHook
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const versionClient = "20200912"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.