cloudtrace

package
v0.213.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: BSD-3-Clause Imports: 18 Imported by: 72

Documentation

Overview

Package cloudtrace provides access to the Cloud Trace API.

For product documentation, see: https://cloud.google.com/trace

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/cloudtrace/v1"
...
ctx := context.Background()
cloudtraceService, err := cloudtrace.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes: 

cloudtraceService, err := cloudtrace.NewService(ctx, option.WithScopes(cloudtrace.TraceReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

cloudtraceService, err := cloudtrace.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudtraceService, err := cloudtrace.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// Write Trace data for a project or application
	TraceAppendScope = "https://www.googleapis.com/auth/trace.append"

	// Read Trace data for a project or application
	TraceReadonlyScope = "https://www.googleapis.com/auth/trace.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ListTracesResponse 

type ListTracesResponse struct {
	// NextPageToken: If defined, indicates that there are more traces that match
	// the request and that this value should be passed to the next request to
	// continue retrieving additional traces.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Traces: List of trace records as specified by the view parameter.
	Traces []*Trace `json:"traces,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListTracesResponse: The response message for the `ListTraces` method.

func (ListTracesResponse) MarshalJSON 

func (s ListTracesResponse) MarshalJSON() ([]byte, error)

type ProjectsPatchTracesCall 

type ProjectsPatchTracesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchTracesCall) Context 

func (c *ProjectsPatchTracesCall) Context(ctx context.Context) *ProjectsPatchTracesCall

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchTracesCall) Do 

func (c *ProjectsPatchTracesCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudtrace.projects.patchTraces" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchTracesCall) Fields 

func (c *ProjectsPatchTracesCall) Fields(s ...googleapi.Field) *ProjectsPatchTracesCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchTracesCall) Header 

func (c *ProjectsPatchTracesCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsService 

type ProjectsService struct {
	Traces *ProjectsTracesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) PatchTraces 

func (r *ProjectsService) PatchTraces(projectId string, traces *Traces) *ProjectsPatchTracesCall

PatchTraces: Sends new traces to Cloud 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.

- projectId: ID of the Cloud project where the trace data is stored.

type ProjectsTracesGetCall 

type ProjectsTracesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsTracesGetCall) Context 

func (c *ProjectsTracesGetCall) Context(ctx context.Context) *ProjectsTracesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsTracesGetCall) Do 

func (c *ProjectsTracesGetCall) Do(opts ...googleapi.CallOption) (*Trace, error)

Do executes the "cloudtrace.projects.traces.get" call. Any non-2xx status code is an error. Response headers are in either *Trace.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsTracesGetCall) Fields 

func (c *ProjectsTracesGetCall) Fields(s ...googleapi.Field) *ProjectsTracesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsTracesGetCall) Header 

func (c *ProjectsTracesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsTracesGetCall) IfNoneMatch 

func (c *ProjectsTracesGetCall) IfNoneMatch(entityTag string) *ProjectsTracesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsTracesListCall 

type ProjectsTracesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsTracesListCall) Context 

func (c *ProjectsTracesListCall) Context(ctx context.Context) *ProjectsTracesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsTracesListCall) Do 

func (c *ProjectsTracesListCall) Do(opts ...googleapi.CallOption) (*ListTracesResponse, error)

Do executes the "cloudtrace.projects.traces.list" call. Any non-2xx status code is an error. Response headers are in either *ListTracesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsTracesListCall) EndTime 

func (c *ProjectsTracesListCall) EndTime(endTime string) *ProjectsTracesListCall

EndTime sets the optional parameter "endTime": End of the time interval (inclusive) during which the trace data was collected from the application.

func (*ProjectsTracesListCall) Fields 

func (c *ProjectsTracesListCall) Fields(s ...googleapi.Field) *ProjectsTracesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsTracesListCall) Filter 

func (c *ProjectsTracesListCall) Filter(filter string) *ProjectsTracesListCall

Filter sets the optional parameter "filter": A filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`.

func (*ProjectsTracesListCall) Header 

func (c *ProjectsTracesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsTracesListCall) IfNoneMatch 

func (c *ProjectsTracesListCall) IfNoneMatch(entityTag string) *ProjectsTracesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsTracesListCall) OrderBy 

func (c *ProjectsTracesListCall) OrderBy(orderBy string) *ProjectsTracesListCall

OrderBy sets the optional parameter "orderBy": Field used to sort the returned traces. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted.

func (*ProjectsTracesListCall) PageSize 

func (c *ProjectsTracesListCall) PageSize(pageSize int64) *ProjectsTracesListCall

PageSize sets the optional parameter "pageSize": Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size.

func (*ProjectsTracesListCall) PageToken 

func (c *ProjectsTracesListCall) PageToken(pageToken string) *ProjectsTracesListCall

PageToken sets the optional parameter "pageToken": Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request.

func (*ProjectsTracesListCall) Pages 

func (c *ProjectsTracesListCall) Pages(ctx context.Context, f func(*ListTracesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsTracesListCall) StartTime 

func (c *ProjectsTracesListCall) StartTime(startTime string) *ProjectsTracesListCall

StartTime sets the optional parameter "startTime": Start of the time interval (inclusive) during which the trace data was collected from the application.

func (*ProjectsTracesListCall) View 

func (c *ProjectsTracesListCall) View(view string) *ProjectsTracesListCall

View sets the optional parameter "view": Type of data returned for traces in the list. Default is `MINIMAL`.

Possible values: 

"VIEW_TYPE_UNSPECIFIED" - Default is `MINIMAL` if unspecified.
"MINIMAL" - Minimal view of the trace record that contains only the

project and trace IDs. 

"ROOTSPAN" - Root span view of the trace record that returns the root

spans along with the minimal trace data. 

"COMPLETE" - Complete view of the trace record that contains the actual

trace data. This is equivalent to calling the REST `get` or RPC `GetTrace` method using the ID of each listed trace.

type ProjectsTracesService 

type ProjectsTracesService struct {
	// contains filtered or unexported fields
}

func NewProjectsTracesService 

func NewProjectsTracesService(s *Service) *ProjectsTracesService

func (*ProjectsTracesService) Get 

func (r *ProjectsTracesService) Get(projectId string, traceId string) *ProjectsTracesGetCall

Get: Gets a single trace by its ID.

- projectId: ID of the Cloud project where the trace data is stored. - traceId: ID of the trace to return.

func (*ProjectsTracesService) List 

func (r *ProjectsTracesService) List(projectId string) *ProjectsTracesListCall

List: Returns a list of traces that match the specified filter conditions.

- projectId: ID of the Cloud project where the trace data is stored.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Trace 

type Trace struct {
	// ProjectId: Project ID of the Cloud project where the trace data is stored.
	ProjectId string `json:"projectId,omitempty"`
	// Spans: Collection of spans in the trace.
	Spans []*TraceSpan `json:"spans,omitempty"`
	// TraceId: Globally unique identifier for the trace. This identifier is a
	// 128-bit numeric value formatted as a 32-byte hex string. For example,
	// `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.
	TraceId string `json:"traceId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ProjectId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ProjectId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Trace: A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.

func (Trace) MarshalJSON 

func (s Trace) MarshalJSON() ([]byte, error)

type TraceSpan 

type TraceSpan struct {
	// EndTime: End time of the span in seconds and nanoseconds from the UNIX
	// epoch.
	EndTime string `json:"endTime,omitempty"`
	// Kind: Distinguishes between spans generated in a particular context. For
	// example, two spans with the same name may be distinguished using
	// `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with
	// the span.
	//
	// Possible values:
	//   "SPAN_KIND_UNSPECIFIED" - Unspecified.
	//   "RPC_SERVER" - Indicates that the span covers server-side handling of an
	// RPC or other remote network request.
	//   "RPC_CLIENT" - Indicates that the span covers the client-side wrapper
	// around an RPC or other remote request.
	Kind string `json:"kind,omitempty"`
	// Labels: Collection of labels associated with the span. Label keys must be
	// less than 128 bytes. Label values must be less than 16 KiB. Some keys might
	// have predefined meaning, and you can also create your own. For more
	// information, see Cloud Trace labels
	// (https://cloud.google.com/trace/docs/trace-labels).
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Name of the span. Must be less than 128 bytes. The span name is
	// sanitized and displayed in the Trace tool in the Google Cloud Platform
	// Console. The name may be a method name or some other per-call site name. For
	// the same executable and the same call point, a best practice is to use a
	// consistent name, which makes it easier to correlate cross-trace spans.
	Name string `json:"name,omitempty"`
	// ParentSpanId: Optional. ID of the parent span, if any.
	ParentSpanId uint64 `json:"parentSpanId,omitempty,string"`
	// SpanId: Identifier for the span. Must be a 64-bit integer other than 0 and
	// unique within a trace. For example, `2205310701640571284`.
	SpanId uint64 `json:"spanId,omitempty,string"`
	// StartTime: Start time of the span in seconds and nanoseconds from the UNIX
	// epoch.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TraceSpan: A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.

func (TraceSpan) MarshalJSON 

func (s TraceSpan) MarshalJSON() ([]byte, error)

type Traces 

type Traces struct {
	// Traces: List of traces.
	Traces []*Trace `json:"traces,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Traces") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Traces") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Traces: List of new or updated traces.

func (Traces) MarshalJSON 

func (s Traces) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.