api: google.golang.org/api/cloudtrace/v1 Index | Files

package cloudtrace

import "google.golang.org/api/cloudtrace/v1"

Package cloudtrace provides access to the Stackdriver Trace API.

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

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 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 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 option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

cloudtrace-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    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.

type Empty Uses

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);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ListTracesResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*ListTracesResponse) MarshalJSON Uses

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

type ProjectsPatchTracesCall Uses

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

func (*ProjectsPatchTracesCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPatchTracesCall) Do Uses

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

Do executes the "cloudtrace.projects.patchTraces" call. Exactly one of *Empty or error will be non-nil. 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 Uses

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

func (*ProjectsPatchTracesCall) Header Uses

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

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

type ProjectsService Uses

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

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) PatchTraces Uses

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

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

type ProjectsTracesGetCall Uses

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

func (*ProjectsTracesGetCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsTracesGetCall) Do Uses

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

Do executes the "cloudtrace.projects.traces.get" call. Exactly one of *Trace or error will be non-nil. 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 Uses

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

func (*ProjectsTracesGetCall) Header Uses

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

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

func (*ProjectsTracesGetCall) IfNoneMatch Uses

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsTracesListCall Uses

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

func (*ProjectsTracesListCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsTracesListCall) Do Uses

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

Do executes the "cloudtrace.projects.traces.list" call. Exactly one of *ListTracesResponse or error will be non-nil. 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 Uses

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 Uses

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

func (*ProjectsTracesListCall) Filter Uses

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

Filter sets the optional parameter "filter": An optional 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 Uses

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

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

func (*ProjectsTracesListCall) IfNoneMatch Uses

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsTracesListCall) OrderBy Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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"
"MINIMAL"
"ROOTSPAN"
"COMPLETE"

type ProjectsTracesService Uses

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

func NewProjectsTracesService Uses

func NewProjectsTracesService(s *Service) *ProjectsTracesService

func (*ProjectsTracesService) Get Uses

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

Get: Gets a single trace by its ID.

func (*ProjectsTracesService) List Uses

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

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

type Service Uses

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 Uses

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 Uses

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

NewService creates a new Service.

type Trace Uses

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`.
    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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    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 Uses

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

type TraceSpan Uses

type TraceSpan struct {
    // EndTime: End time of the span in 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 kilobytes (10MB
    // for
    // `/stacktrace` values).
    //
    // Some predefined label keys exist, or you may create your own. When
    // creating
    // your own, we recommend the following formats:
    //
    // * `/category/product/key` for agents of well-known products (e.g.
    //   `/db/mongodb/read_size`).
    // * `short_host/path/key` for domain-specific keys (e.g.
    //   `foo.com/myproduct/bar`)
    //
    // Predefined labels include:
    //
    // *   `/agent`
    // *   `/component`
    // *   `/error/message`
    // *   `/error/name`
    // *   `/http/client_city`
    // *   `/http/client_country`
    // *   `/http/client_protocol`
    // *   `/http/client_region`
    // *   `/http/host`
    // *   `/http/method`
    // *   `/http/path`
    // *   `/http/redirected_url`
    // *   `/http/request/size`
    // *   `/http/response/size`
    // *   `/http/route`
    // *   `/http/status_code`
    // *   `/http/url`
    // *   `/http/user_agent`
    // *   `/pid`
    // *   `/stacktrace`
    // *   `/tid`
    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 Stackdriver 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: ID of the parent span, if any. Optional.
    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 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    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 Uses

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

type Traces Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Traces: List of new or updated traces.

func (*Traces) MarshalJSON Uses

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

Package cloudtrace imports 14 packages (graph) and is imported by 9 packages. Updated 2019-07-14. Refresh now. Tools for package owners.