Class: Google::Logging::V2::LogSink

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb

Overview

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 or organization.

Defined Under Namespace

Modules: VersionFormat

Instance Attribute Summary collapse

Instance Attribute Details

#destination ⇒ String

Returns 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 Logs With Sinks[https://cloud.google.com/logging/docs/api/tasks/exporting-logs].

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 Logs With Sinks[https://cloud.google.com/logging/docs/api/tasks/exporting-logs].



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#end_time ⇒ Google::Protobuf::Timestamp

Returns Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.

Returns:

  • (Google::Protobuf::Timestamp) —

    Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#filter ⇒ String

Returns Optional. An logs filter[https://cloud.google.com/logging/docs/view/advanced_filters]. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the +output_version_format+ parameter. For example, in the v2 format:

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

Returns:

  • (String) —

    Optional. An logs filter[https://cloud.google.com/logging/docs/view/advanced_filters]. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the +output_version_format+ parameter. For example, in the v2 format:

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#name ⇒ String

Returns 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.

Returns:

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#output_version_format ⇒ Google::Logging::V2::LogSink::VersionFormat

Returns Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See to the v2 API[https://cloud.google.com/logging/docs/api/v2/migration-to-v2].

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#start_time ⇒ Google::Protobuf::Timestamp

Returns Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.

Returns:

  • (Google::Protobuf::Timestamp) —

    Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end

#writer_identity ⇒ String

Returns Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by Google::Logging::V2::LogSink.sinkssinks.create[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create] and Google::Logging::V2::LogSink.sinkssinks.update[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/update], based on the setting 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 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.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb', line 86

class LogSink
  # Available log entry formats. Log entries can be written to Stackdriver
  # Logging in either format and can be exported in either format.
  # Version 2 is the preferred format.
  module VersionFormat
    # An unspecified format version that will default to V2.
    VERSION_FORMAT_UNSPECIFIED = 0

    # +LogEntry+ version 2 format.
    V2 = 1

    # +LogEntry+ version 1 format.
    V1 = 2
  end
end