REST Resource: projects.sinks

Resource: LogSink

Describes a sink used to export log entries to one of the following destinations:

  • a Cloud Logging log bucket,
  • a Cloud Storage bucket,
  • a BigQuery dataset,
  • a Pub/Sub topic,
  • a Cloud project.

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,
  "resourceName": string,
  "destination": string,
  "filter": string,
  "description": string,
  "disabled": boolean,
  "exclusions": [
    {
      object (LogExclusion)
    }
  ],
  "outputVersionFormat": enum (VersionFormat),
  "writerIdentity": string,
  "includeChildren": boolean,
  "interceptChildren": boolean,
  "createTime": string,
  "updateTime": string,

  // Union field options can be only one of the following:
  "bigqueryOptions": {
    object (BigQueryOptions)
  }
  // End of list of possible types for union field options.
}
Fields
name

string

Output only. The client-assigned sink identifier, unique within the project.

For 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,
  • periods.

First character has to be alphanumeric.
resourceName

string

Output only. The resource name of the sink.

"projects/[PROJECT_ID]/sinks/[SINK_NAME]
"organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME]
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME]
"folders/[FOLDER_ID]/sinks/[SINK_NAME]

For example: projects/my_project/sinks/SINK_NAME
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]"
"logging.googleapis.com/projects/[PROJECT_ID]"
"logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_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
description

string

Optional. A description of this sink.

The maximum length of the description is 8000 characters.
disabled

boolean

Optional. If set to true, then this sink is disabled and it does not export any log entries.
exclusions[]

object (LogExclusion)

Optional. Log entries that match any of these exclusion filters will not be exported.

If a log entry is matched by both filter and one of exclusion_filters it will not be exported.
outputVersionFormat
(deprecated)

enum (VersionFormat)

Deprecated. This field is unused.
writerIdentity

string

Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying customWriterIdentity or set automatically by sinks.create and sinks.update based on the value 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.

Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writerIdentity and no additional permissions are required.
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 log entries 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
interceptChildren

boolean

Optional. This field applies only to sinks owned by organizations and folders.

When the value of 'interceptChildren' is true, the following restrictions apply:

  • The sink must have the includeChildren flag set to true.
  • The sink destination must be a Cloud project.

Also, the following behaviors apply:

  • Any logs matched by the sink won't be included by non-_Required sinks owned by child resources.
  • The sink appears in the results of a sinks.list call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
createTime

string (Timestamp format)

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
Union field options. Destination dependent options. options can be only one of the following:
bigqueryOptions

object (BigQueryOptions)

Optional. Options that affect sinks exporting data to BigQuery.

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.