Package google.devtools.cloudtrace.v2beta1

Index

TracingConfigService

Service for configuring sinks used to export Trace data out of Trace. This API may be extended in the future to cover a greater range of Trace related configuration.

CreateTraceSink

rpc CreateTraceSink(CreateTraceSinkRequest) returns (TraceSink)

Creates a sink that exports trace spans to a destination. The export of newly-ingested traces begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the 'parent').

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.append
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteTraceSink

rpc DeleteTraceSink(DeleteTraceSinkRequest) returns (Empty)

Deletes a sink.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.append
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetTraceSink

rpc GetTraceSink(GetTraceSinkRequest) returns (TraceSink)

Get a trace sink by name under the parent resource (GCP project).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.readonly
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListTraceSinks

rpc ListTraceSinks(ListTraceSinksRequest) returns (ListTraceSinksResponse)

List all sinks for the parent resource (GCP project).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.readonly
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateTraceSink

rpc UpdateTraceSink(UpdateTraceSinkRequest) returns (TraceSink)

Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output-only fields (e.g. the writer_identity).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.append
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateTraceSinkRequest

The parameters to CreateTraceSink. With a parent "projects/my-trace-project" and TraceSink with a name "my-sink" this request will create the sink "projects/my-trace-project/sinks/my-sink"

Fields
parent

string

Required. The resource in which to create the sink (currently only project sinks are supported):

"projects/[PROJECT_ID]"

Examples: "projects/my-trace-project", "projects/123456789".

Authorization requires the following IAM permission on the specified resource parent:

  • cloudtrace.tracesinks.create
trace_sink

TraceSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

DeleteTraceSinkRequest

The parameters to DeleteTraceSink.

Fields
name

string

Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:

"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"

Example: "projects/12345/traceSinks/my-sink-id".

Authorization requires the following IAM permission on the specified resource name:

  • cloudtrace.tracesinks.delete

GetTraceSinkRequest

The parameters to GetTraceSink.

Fields
name

string

Required. The resource name of the sink:

"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"

Example: "projects/12345/traceSinks/my-sink-id".

Authorization requires the following IAM permission on the specified resource name:

  • cloudtrace.tracesinks.get

ListTraceSinksRequest

The parameters to ListTraceSinks.

Fields
parent

string

Required. The parent resource whose sinks are to be listed (currently only project parent resources are supported):

"projects/[PROJECT_ID]"

Authorization requires the following IAM permission on the specified resource parent:

  • cloudtrace.tracesinks.list
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

ListTraceSinksResponse

Result returned from ListTraceSinks.

Fields
sinks[]

TraceSink

A list of sinks.

next_page_token

string

If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.

OutputConfig

OutputConfig contains a destination for writing trace data.

Fields
destination

string

The destination for writing trace data. Currently only BigQuery is supported. E.g.:

"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"

TraceSink

Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.

Fields
name

string

Required. The canonical sink resource name, unique within the project. Must be of the form:

project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].

E.g.:

"projects/12345/traceSinks/my-project-trace-sink".

Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.

output_config

OutputConfig

Required. The export destination.

writer_identity

string

Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see Granting access for a resource. To create tables and write data this account will need the dataEditor role. Read more about roles in the BigQuery documentation. E.g.:

"service-00000001@00000002.iam.gserviceaccount.com"

UpdateTraceSinkRequest

The parameters to UpdateTraceSink.

Fields
name

string

Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"

Example: "projects/12345/traceSinks/my-sink-id".

Authorization requires the following IAM permission on the specified resource name:

  • cloudtrace.tracesinks.update
trace_sink

TraceSink

Required. The updated trace sink, whose name is the same identifier (SINK_ID) that appears as part of name.

update_mask

FieldMask

Required. Field mask that specifies the fields in trace_sink that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. name and writer_identity fields cannot be updated.

An empty updateMask is considered an error.

For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Example: updateMask=output_config.