REST Resource: folders.sinks

Resource: LogSink

Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.

JSON representation
{
  "name": string,
  "destination": string,
  "filter": string,
  "outputVersionFormat": enum(VersionFormat),
  "writerIdentity": string,
  "includeChildren": boolean
}
Fields
name

string

Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.

destination

string

Required. The export destination:

"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"

The sink's writerIdentity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.

filter

string

Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:

logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR

outputVersionFormat
(deprecated)

enum(VersionFormat)

Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.

writerIdentity

string

Output only. An IAM identity—a service account or group—under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of uniqueWriterIdentity in those methods.

Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.

includeChildren

boolean

Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:

logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance

Methods

create

Creates a sink that exports specified log entries to a destination.

delete

Deletes a sink.

get

Gets a sink.

list

Lists sinks.

patch

Updates a sink.

update

Updates a sink.
Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Logging