REST Resource: projects.traceSinks

Resource: TraceSink

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

JSON representation
{
  "name": string,
  "outputConfig": {
    object (OutputConfig)
  },
  "writerIdentity": string
}
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.

outputConfig

object (OutputConfig)

Required. The export destination.

writerIdentity

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"

OutputConfig

OutputConfig contains a destination for writing trace data.

JSON representation
{
  "destination": string
}
Fields
destination

string

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

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

Methods

create

Creates a sink that exports trace spans to a destination.

delete

Deletes a sink.

get

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

list

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

patch

Updates a sink.