Cloud Logging V2 API - Class Google::Cloud::Logging::V2::LogSink (v1.1.0)

Reference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::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 Pub/Sub topic or a Cloud Logging log bucket. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bigquery_options

def bigquery_options() -> ::Google::Cloud::Logging::V2::BigQueryOptions

Returns

(::Google::Cloud::Logging::V2::BigQueryOptions) — Optional. Options that affect sinks exporting data to BigQuery.

#bigquery_options=

def bigquery_options=(value) -> ::Google::Cloud::Logging::V2::BigQueryOptions

Parameter

value (::Google::Cloud::Logging::V2::BigQueryOptions) — Optional. Options that affect sinks exporting data to BigQuery.

Returns

(::Google::Cloud::Logging::V2::BigQueryOptions) — Optional. Options that affect sinks exporting data to BigQuery.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

#description

def description() -> ::String

Returns

(::String) — Optional. A description of this sink.

The maximum length of the description is 8000 characters.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. A description of this sink.

The maximum length of the description is 8000 characters.

Returns

(::String) — Optional. A description of this sink.

The maximum length of the description is 8000 characters.

#destination

def destination() -> ::String

Returns

(::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 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.

#destination=

def destination=(value) -> ::String

Parameter

value (::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 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.

Returns

(::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 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.

#disabled

def disabled() -> ::Boolean

Returns

(::Boolean) — Optional. If set to true, then this sink is disabled and it does not export any log entries.

#disabled=

def disabled=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If set to true, then this sink is disabled and it does not export any log entries.

Returns

(::Boolean) — Optional. If set to true, then this sink is disabled and it does not export any log entries.

#exclusions

def exclusions() -> ::Array<::Google::Cloud::Logging::V2::LogExclusion>

Returns

(::Array<::Google::Cloud::Logging::V2::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.

#exclusions=

def exclusions=(value) -> ::Array<::Google::Cloud::Logging::V2::LogExclusion>

Parameter

value (::Array<::Google::Cloud::Logging::V2::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.

Returns

(::Array<::Google::Cloud::Logging::V2::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.

#filter

def filter() -> ::String

Returns

(::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

#filter=

def filter=(value) -> ::String

Parameter

value (::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

Returns

(::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

#include_children

def include_children() -> ::Boolean

Returns

(::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

#include_children=

def include_children=(value) -> ::Boolean

Parameter

value (::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

Returns

(::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

#name

def name() -> ::String

Returns

(::String) — 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.

#name=

def name=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#output_version_format

def output_version_format() -> ::Google::Cloud::Logging::V2::LogSink::VersionFormat

Returns

(::Google::Cloud::Logging::V2::LogSink::VersionFormat) — Deprecated. This field is unused.

#output_version_format=

def output_version_format=(value) -> ::Google::Cloud::Logging::V2::LogSink::VersionFormat

Parameter

value (::Google::Cloud::Logging::V2::LogSink::VersionFormat) — Deprecated. This field is unused.

Returns

(::Google::Cloud::Logging::V2::LogSink::VersionFormat) — Deprecated. This field is unused.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

#writer_identity

def writer_identity() -> ::String

Returns

(::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 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. 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.