gcp_logging_log_sink

ancestors

Type: UNORDERED_LIST_STRING

bigquery_options

Type: STRUCT
Provider name: bigqueryOptions
Description: Optional. Options that affect sinks exporting data to BigQuery.

• use_partitioned_tables
  Type: BOOLEAN
  Provider name: usePartitionedTables
  Description: Optional. Whether to use BigQuery’s partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries’ timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.
  
• uses_timestamp_column_partitioning
  Type: BOOLEAN
  Provider name: usesTimestampColumnPartitioning
  Description: Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The creation timestamp of the sink.This field may not be present for older sinks.

description

Type: STRING
Provider name: description
Description: Optional. A description of this sink.The maximum length of the description is 8000 characters.

destination

Type: STRING
Provider name: destination
Description: 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]” The sink’s writer_identity, 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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

disabled

Type: BOOLEAN
Provider name: disabled
Description: Optional. If set to true, then this sink is disabled and it does not export any log entries.

exclusions

Type: UNORDERED_LIST_STRUCT
Provider name: exclusions
Description: 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.

• create_time
  Type: TIMESTAMP
  Provider name: createTime
  Description: Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
  
• description
  Type: STRING
  Provider name: description
  Description: Optional. A description of this exclusion.
  
• disabled
  Type: BOOLEAN
  Provider name: disabled
  Description: Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
  
• filter
  Type: STRING
  Provider name: filter
  Description: Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries.For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)
  
• name
  Type: STRING
  Provider name: name
  Description: Required. A client-assigned identifier, such as “load-balancer-exclusion”. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
  
• update_time
  Type: TIMESTAMP
  Provider name: updateTime
  Description: Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
  

filter

Type: STRING
Provider name: filter
Description: Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). 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

include_children

Type: BOOLEAN
Provider name: includeChildren
Description: 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

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Required. 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, and periods. First character has to be alphanumeric.

organization_id

Type: STRING

output_version_format

Type: STRING
Provider name: outputVersionFormat
Description: Deprecated. This field is unused.
Possible values:

• VERSION_FORMAT_UNSPECIFIED - An unspecified format version that will default to V2.
  
• V2 - LogEntry version 2 format.
  
• V1 - LogEntry version 1 format.
  

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The last update timestamp of the sink.This field may not be present for older sinks.

writer_identity

Type: STRING
Provider name: writerIdentity
Description: 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 custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity 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 (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_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 writer_identity and no additional permissions are required.