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, a Cloud Pub/Sub topic or a Cloud Logging Bucket. 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, "description": string, "disabled": boolean, "exclusions": [ { object ( |
Fields | |
---|---|
name |
Required. The client-assigned sink identifier, unique within the project. Example: |
destination |
Required. The export destination:
The sink's |
filter |
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:
|
description |
Optional. A description of this sink. The maximum length of the description is 8000 characters. |
disabled |
Optional. If set to True, then this sink is disabled and it does not export any log entries. |
exclusions[] |
Optional. Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both |
outputVersionFormat |
Deprecated. This field is unused. |
writerIdentity |
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 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 |
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
|
createTime |
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: |
updateTime |
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: |
bigqueryOptions |
Optional. Options that affect sinks exporting data to BigQuery. |
VersionFormat
Deprecated. This is unused.
Enums | |
---|---|
VERSION_FORMAT_UNSPECIFIED |
An unspecified format version that will default to V2. |
V2 |
LogEntry version 2 format. |
V1 |
LogEntry version 1 format. |
BigQueryOptions
Options that change functionality of a sink exporting data to BigQuery.
JSON representation | |
---|---|
{ "usePartitionedTables": boolean, "usesTimestampColumnPartitioning": boolean } |
Fields | |
---|---|
usePartitionedTables |
Optional. Whether to use BigQuery's partition tables. By default, 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 has to be used instead. In both cases, tables are sharded based on UTC timezone. |
usesTimestampColumnPartitioning |
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 usePartitionedTables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false. |
Methods |
|
---|---|
|
Creates a sink that exports specified log entries to a destination. |
|
Deletes a sink. |
|
Gets a sink. |
|
Lists sinks. |
|
Updates a sink. |
|
Updates a sink. |