api: google.golang.org/api/tracing/v2 Index | Files

package tracing

import "google.golang.org/api/tracing/v2"

Package tracing provides access to the Google Tracing API.

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

Creating a client

Usage example:

import "google.golang.org/api/tracing/v2"
...
ctx := context.Background()
tracingService, err := tracing.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:

tracingService, err := tracing.NewService(ctx, option.WithScopes(tracing.TraceReadonlyScope))

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

tracingService, err := tracing.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, ...)
tracingService, err := tracing.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Package Files

tracing-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 Annotation Uses

type Annotation struct {
    // Attributes: A set of attributes on the annotation. A maximum of 4
    // attributes are
    // allowed per Annotation.
    Attributes *Attributes `json:"attributes,omitempty"`

    // Description: A user-supplied message describing the event. The
    // maximum length for
    // the description is 256 bytes.
    Description *TruncatableString `json:"description,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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:"-"`
}

Annotation: Text annotation with a set of attributes. A maximum of 32 annotations are allowed per Span.

func (*Annotation) MarshalJSON Uses

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

type AttributeValue Uses

type AttributeValue struct {
    // BoolValue: A boolean value.
    BoolValue bool `json:"boolValue,omitempty"`

    // IntValue: An integer value.
    IntValue int64 `json:"intValue,omitempty,string"`

    // StringValue: A string value (up to 256 bytes).
    StringValue *TruncatableString `json:"stringValue,omitempty"`

    // ForceSendFields is a list of field names (e.g. "BoolValue") 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. "BoolValue") 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:"-"`
}

AttributeValue: The allowed types for the value side of an attribute key:value pair.

func (*AttributeValue) MarshalJSON Uses

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

type Attributes Uses

type Attributes struct {
    // AttributeMap: The maximum key length is 128 bytes (attributes are
    // dropped if the
    // key size is larger than the maximum allowed). The value can be a
    // string
    // (up to 256 bytes), integer, or boolean (true/false). Some common
    // pair
    // examples:
    //
    //     "/instance_id": "my-instance"
    //     "/zone": "us-central1-a"
    //     "/grpc/peer_address": "ip:port" (dns, etc.)
    //     "/grpc/deadline": "Duration"
    //     "/http/user_agent"
    //     "/http/request_bytes": 300
    //     "/http/response_bytes": 1200
    //     "/http/url": google.com/apis
    //     "abc.com/myattribute": true
    AttributeMap map[string]AttributeValue `json:"attributeMap,omitempty"`

    // DroppedAttributesCount: The number of dropped attributes after the
    // maximum size was enforced. If
    // 0 then no attributes were dropped.
    DroppedAttributesCount int64 `json:"droppedAttributesCount,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AttributeMap") 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. "AttributeMap") 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:"-"`
}

Attributes: Attributes of a span with a key:value format.

func (*Attributes) MarshalJSON Uses

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

type BatchWriteSpansRequest Uses

type BatchWriteSpansRequest struct {
    // Spans: A collection of spans.
    Spans []*Span `json:"spans,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Spans") 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. "Spans") 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:"-"`
}

BatchWriteSpansRequest: The request message for the `BatchWriteSpans` method.

func (*BatchWriteSpansRequest) MarshalJSON Uses

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

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 Link struct {
    // SpanId: `SPAN_ID` is a unique identifier for a span within a trace.
    // It is a
    // base16-encoded, case-insensitive string of a 8-bytes array and
    // is
    // required to be 16 char long.
    SpanId string `json:"spanId,omitempty"`

    // TraceId: `TRACE_ID` is a unique identifier for a trace within a
    // project. It is
    // a base16-encoded, case-insensitive string of a 16-bytes array and
    // is
    // required to be 32 char long.
    TraceId string `json:"traceId,omitempty"`

    // Type: The relationship of the current span relative to the linked
    // span.
    //
    // Possible values:
    //   "TYPE_UNSPECIFIED" - The relationship of the two spans is unknown.
    //   "CHILD" - The current span is a child of the linked span.
    //   "PARENT" - The current span is the parent of the linked span.
    Type string `json:"type,omitempty"`

    // ForceSendFields is a list of field names (e.g. "SpanId") 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. "SpanId") 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:"-"`
}

Link: A pointer from this span to another span in a different `Trace` within the same service project or within a different service project. Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces or when receives a request from a different service project.

func (*Link) MarshalJSON Uses

func (s *Link) MarshalJSON() ([]byte, error)
type Links struct {
    // DroppedLinksCount: The number of dropped links after the maximum size
    // was enforced. If
    // 0 then no links were dropped.
    DroppedLinksCount int64 `json:"droppedLinksCount,omitempty"`

    // Link: A collection of links.
    Link []*Link `json:"link,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DroppedLinksCount")
    // 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. "DroppedLinksCount") 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:"-"`
}

Links: A collection of links, which are references from this span to a span in the same or different trace.

func (*Links) MarshalJSON Uses

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

type ListSpansResponse Uses

type ListSpansResponse struct {
    // NextPageToken: If defined, indicates that there are more spans that
    // match the request.
    // Pass this as the value of `pageToken` in a subsequent request to
    // retrieve
    // additional spans.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Spans: The requested spans if there are any in the specified trace.
    Spans []*Span `json:"spans,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:"-"`
}

ListSpansResponse: The response message for the `ListSpans` method.

func (*ListSpansResponse) MarshalJSON Uses

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

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 returned.
    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 Module Uses

type Module struct {
    // BuildId: Build_id is a unique identifier for the module, usually a
    // hash of its
    // contents (up to 128 characters).
    BuildId *TruncatableString `json:"buildId,omitempty"`

    // Module: E.g. main binary, kernel modules, and dynamic libraries
    // such as libc.so, sharedlib.so (up to 256 characters).
    Module *TruncatableString `json:"module,omitempty"`

    // ForceSendFields is a list of field names (e.g. "BuildId") 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. "BuildId") 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:"-"`
}

Module: Binary module.

func (*Module) MarshalJSON Uses

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

type NetworkEvent Uses

type NetworkEvent struct {
    // MessageId: An identifier for the message, which must be unique in
    // this span.
    MessageId uint64 `json:"messageId,omitempty,string"`

    // MessageSize: The number of bytes sent or received.
    MessageSize uint64 `json:"messageSize,omitempty,string"`

    // Time: If available, this is the kernel time:
    //
    // *  For sent messages, this is the time at which the first bit was
    // sent.
    // *  For received messages, this is the time at which the last bit was
    //    received.
    Time string `json:"time,omitempty"`

    // Type: Type of NetworkEvent. Indicates whether the RPC message was
    // sent or
    // received.
    //
    // Possible values:
    //   "TYPE_UNSPECIFIED" - Unknown event type.
    //   "SENT" - Indicates a sent RPC message.
    //   "RECV" - Indicates a received RPC message.
    Type string `json:"type,omitempty"`

    // ForceSendFields is a list of field names (e.g. "MessageId") 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. "MessageId") 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:"-"`
}

NetworkEvent: An event describing an RPC message sent/received on the network. A maximum of 128 network events are allowed per Span.

func (*NetworkEvent) MarshalJSON Uses

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

type ProjectsService Uses

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

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

type ProjectsTracesBatchWriteCall Uses

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

func (*ProjectsTracesBatchWriteCall) Context Uses

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

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 (*ProjectsTracesBatchWriteCall) Do Uses

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

Do executes the "tracing.projects.traces.batchWrite" 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 (*ProjectsTracesBatchWriteCall) Fields Uses

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

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

func (*ProjectsTracesBatchWriteCall) Header Uses

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

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

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 "tracing.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 for the request. Example: `version_label_key:a some_label:some_label_key` returns traces from version `a` and has `some_label` with `some_label_key`.

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.

type ProjectsTracesListSpansCall Uses

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

func (*ProjectsTracesListSpansCall) Context Uses

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

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 (*ProjectsTracesListSpansCall) Do Uses

func (c *ProjectsTracesListSpansCall) Do(opts ...googleapi.CallOption) (*ListSpansResponse, error)

Do executes the "tracing.projects.traces.listSpans" call. Exactly one of *ListSpansResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSpansResponse.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 (*ProjectsTracesListSpansCall) Fields Uses

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

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

func (*ProjectsTracesListSpansCall) Header Uses

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

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

func (*ProjectsTracesListSpansCall) IfNoneMatch Uses

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

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 (*ProjectsTracesListSpansCall) PageToken Uses

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

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

func (*ProjectsTracesListSpansCall) Pages Uses

func (c *ProjectsTracesListSpansCall) Pages(ctx context.Context, f func(*ListSpansResponse) 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.

type ProjectsTracesService Uses

type ProjectsTracesService struct {
    Spans *ProjectsTracesSpansService
    // contains filtered or unexported fields
}

func NewProjectsTracesService Uses

func NewProjectsTracesService(s *Service) *ProjectsTracesService

func (*ProjectsTracesService) BatchWrite Uses

func (r *ProjectsTracesService) BatchWrite(name string, batchwritespansrequest *BatchWriteSpansRequest) *ProjectsTracesBatchWriteCall

BatchWrite: Sends new spans to Stackdriver Trace or updates existing traces. If the name of a trace that you send matches that of an existing trace, new spans are added to the existing trace. Attempt to update existing spans results undefined behavior. If the name does not match, a new trace is created with given set of spans.

func (*ProjectsTracesService) List Uses

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

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

func (*ProjectsTracesService) ListSpans Uses

func (r *ProjectsTracesService) ListSpans(parent string) *ProjectsTracesListSpansCall

ListSpans: Returns a list of spans within a trace.

type ProjectsTracesSpansCreateCall Uses

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

func (*ProjectsTracesSpansCreateCall) Context Uses

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

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 (*ProjectsTracesSpansCreateCall) Do Uses

func (c *ProjectsTracesSpansCreateCall) Do(opts ...googleapi.CallOption) (*Span, error)

Do executes the "tracing.projects.traces.spans.create" call. Exactly one of *Span or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Span.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 (*ProjectsTracesSpansCreateCall) Fields Uses

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

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

func (*ProjectsTracesSpansCreateCall) Header Uses

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

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

type ProjectsTracesSpansService Uses

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

func NewProjectsTracesSpansService Uses

func NewProjectsTracesSpansService(s *Service) *ProjectsTracesSpansService

func (*ProjectsTracesSpansService) Create Uses

func (r *ProjectsTracesSpansService) Create(nameid string, span *Span) *ProjectsTracesSpansCreateCall

Create: Creates a new Span.

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 Span Uses

type Span struct {
    // Attributes: A set of attributes on the span. A maximum of 32
    // attributes are allowed per
    // Span.
    Attributes *Attributes `json:"attributes,omitempty"`

    // DisplayName: Description of the operation in the span. It is
    // sanitized and displayed in
    // the Stackdriver Trace tool in the
    // {% dynamic print site_values.console_name %}.
    // The display_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 operation name, which makes it easier to
    // correlate
    // cross-trace spans.
    // The maximum length for the display_name is 128 bytes.
    DisplayName *TruncatableString `json:"displayName,omitempty"`

    // EndTime: End time of the span.
    // On the client side, this is the local machine clock time at which the
    // span
    // execution was ended; on the server
    // side, this is the time at which the server application handler
    // stopped
    // running.
    EndTime string `json:"endTime,omitempty"`

    // Links: A maximum of 128 links are allowed per Span.
    Links *Links `json:"links,omitempty"`

    // Name: The resource name of Span in the
    // format
    // `projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.
    // `TRACE_ID`
    //  is a unique identifier for a trace within a project and is
    // a
    // base16-encoded, case-insensitive string and is required to be 32 char
    // long.
    // `SPAN_ID` is a unique identifier for a span within a trace. It is
    // a
    // base 16-encoded, case-insensitive string of a 8-bytes array and is
    // required
    // to be 16 char long.
    Name string `json:"name,omitempty"`

    // ParentSpanId: ID of parent span which is a base 16-encoded,
    // case-insensitive string of
    // a 8-bytes array and is required to be 16 char long. If this is a root
    // span,
    // the value must be empty.
    ParentSpanId string `json:"parentSpanId,omitempty"`

    // SpanId: Unique identifier for a span within a trace. It is a base
    // 16-encoded,
    // case-insensitive string of a 8-bytes array and is required.
    SpanId string `json:"spanId,omitempty"`

    // StackTrace: Stack trace captured at the start of the span.
    StackTrace *StackTrace `json:"stackTrace,omitempty"`

    // StartTime: Start time of the span.
    // On the client side, this is the local machine clock time at which the
    // span
    // execution was started; on the server
    // side, this is the time at which the server application handler
    // started
    // running.
    StartTime string `json:"startTime,omitempty"`

    // Status: An optional final status for this span.
    Status *Status `json:"status,omitempty"`

    // TimeEvents: A maximum of 32 annotations and 128 network events are
    // allowed per Span.
    TimeEvents *TimeEvents `json:"timeEvents,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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:"-"`
}

Span: A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency and, optionally, one or more subspans for its sub-operations. (A trace could alternatively contain multiple root spans, or none at all.) Spans do not need to be contiguous. There may be gaps and/or overlaps between spans in a trace.

func (*Span) MarshalJSON Uses

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

type StackFrame Uses

type StackFrame struct {
    // ColumnNumber: Column number is important in JavaScript (anonymous
    // functions).
    // May not be available in some languages.
    ColumnNumber int64 `json:"columnNumber,omitempty,string"`

    // FileName: The filename of the file containing this frame (up to 256
    // characters).
    FileName *TruncatableString `json:"fileName,omitempty"`

    // FunctionName: The fully-qualified name that uniquely identifies this
    // function or
    // method (up to 1024 characters).
    FunctionName *TruncatableString `json:"functionName,omitempty"`

    // LineNumber: Line number of the frame.
    LineNumber int64 `json:"lineNumber,omitempty,string"`

    // LoadModule: Binary module the code is loaded from.
    LoadModule *Module `json:"loadModule,omitempty"`

    // OriginalFunctionName: Used when the function name
    // is
    // [mangled](http://www.avabodh.com/cxxin/namemangling.html). May
    // be
    // fully-qualified (up to 1024 characters).
    OriginalFunctionName *TruncatableString `json:"originalFunctionName,omitempty"`

    // SourceVersion: The version of the deployed source code (up to 128
    // characters).
    SourceVersion *TruncatableString `json:"sourceVersion,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ColumnNumber") 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. "ColumnNumber") 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:"-"`
}

StackFrame: Represents a single stack frame in a stack trace.

func (*StackFrame) MarshalJSON Uses

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

type StackFrames Uses

type StackFrames struct {
    // DroppedFramesCount: The number of dropped stack frames after the
    // maximum size was enforced.
    // If 0 then no frames were dropped.
    DroppedFramesCount int64 `json:"droppedFramesCount,omitempty"`

    // Frame: Stack frames in this stack trace.
    Frame []*StackFrame `json:"frame,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DroppedFramesCount")
    // 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. "DroppedFramesCount") 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:"-"`
}

StackFrames: Represents collection of StackFrames that can be truncated.

func (*StackFrames) MarshalJSON Uses

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

type StackTrace Uses

type StackTrace struct {
    // StackFrames: Stack frames in this stack trace. A maximum of 128
    // frames are allowed.
    StackFrames *StackFrames `json:"stackFrames,omitempty"`

    // StackTraceHashId: The hash ID is used to conserve network bandwidth
    // for duplicate
    // stack traces within a single trace.
    //
    // Often multiple spans will have identical stack traces.
    // The first occurrence of a stack trace should contain both
    // the
    // `stackFrame` content and a value in `stackTraceHashId`.
    //
    // Subsequent spans within the same request can refer
    // to that stack trace by only setting `stackTraceHashId`.
    StackTraceHashId uint64 `json:"stackTraceHashId,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "StackFrames") 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. "StackFrames") 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:"-"`
}

StackTrace: StackTrace collected in a trace.

func (*StackTrace) MarshalJSON Uses

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

type Status Uses

type Status struct {
    // Code: The status code, which should be an enum value of
    // google.rpc.Code.
    Code int64 `json:"code,omitempty"`

    // Details: A list of messages that carry the error details.  There will
    // be a
    // common set of message types for APIs to use.
    Details []googleapi.RawMessage `json:"details,omitempty"`

    // Message: A developer-facing error message, which should be in
    // English. Any
    // user-facing error message should be localized and sent in
    // the
    // google.rpc.Status.details field, or localized by the client.
    Message string `json:"message,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

# Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.

# Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

# Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client,

it may embed the `Status` in the normal response to indicate the

partial

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may

have a `Status` message for error reporting.

- Batch operations. If a client uses batch request and batch response, the

`Status` message should be used directly inside batch response,

one for

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation

results in its response, the status of those operations should

be

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could

be used directly after any stripping needed for security/privacy

reasons.

func (*Status) MarshalJSON Uses

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

type TimeEvent Uses

type TimeEvent struct {
    // Annotation: One or more key:value pairs.
    Annotation *Annotation `json:"annotation,omitempty"`

    // NetworkEvent: An event describing an RPC message sent/received on the
    // network.
    NetworkEvent *NetworkEvent `json:"networkEvent,omitempty"`

    // Time: The timestamp indicating the time the event occurred.
    Time string `json:"time,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Annotation") 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. "Annotation") 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:"-"`
}

TimeEvent: A time-stamped annotation in the Span.

func (*TimeEvent) MarshalJSON Uses

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

type TimeEvents Uses

type TimeEvents struct {
    // DroppedAnnotationsCount: The number of dropped annotations after the
    // maximum size was enforced. If
    // 0 then no annotations were dropped.
    DroppedAnnotationsCount int64 `json:"droppedAnnotationsCount,omitempty"`

    // DroppedNetworkEventsCount: The number of dropped network events after
    // the maximum size was enforced.
    // If 0 then no annotations were dropped.
    DroppedNetworkEventsCount int64 `json:"droppedNetworkEventsCount,omitempty"`

    // TimeEvent: A collection of `TimeEvent`s.
    TimeEvent []*TimeEvent `json:"timeEvent,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "DroppedAnnotationsCount") 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. "DroppedAnnotationsCount")
    // 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:"-"`
}

TimeEvents: A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of an RPC message sent/received on the network.

func (*TimeEvents) MarshalJSON Uses

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

type Trace Uses

type Trace struct {
    // Name: The resource name of Trace in the
    // format
    // `projects/PROJECT_ID/traces/TRACE_ID`. `TRACE_ID` is a unique
    // identifier
    // for a trace within a project and is a base16-encoded,
    // case-insensitive
    // string and is required to be 32 char long.
    Name string `json:"name,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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 some operations. It consists of a set of spans, each representing an operation and including time information and operation details.

func (*Trace) MarshalJSON Uses

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

type TruncatableString Uses

type TruncatableString struct {
    // TruncatedCharacterCount: The number of characters truncated from the
    // original string value. If 0 it
    // means that the string value was not truncated.
    TruncatedCharacterCount int64 `json:"truncatedCharacterCount,omitempty"`

    // Value: The truncated string value. E.g. for a string attribute this
    // may have up to
    // 256 bytes.
    Value string `json:"value,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "TruncatedCharacterCount") 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. "TruncatedCharacterCount")
    // 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:"-"`
}

TruncatableString: Represents a string value that might be truncated.

func (*TruncatableString) MarshalJSON Uses

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

Package tracing imports 14 packages (graph). Updated 2019-07-18. Refresh now. Tools for package owners.