Class: Google::Cloud::Logging::Sink

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/sink.rb,
lib/google/cloud/logging/sink/list.rb

Overview

Sink

Used to export log entries outside Stackdriver Logging. When you create a sink, new log entries are exported. Stackdriver Logging does not send previously-ingested log entries to the sink's destination.

A logs filter controls which log entries are exported.

Before creating the sink, ensure that you have granted the sink's unique writer identity permission to write logs to the destination. See Destination permissions.

You can retrieve an existing sink with Project#sink.

Examples:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new
bucket = storage.create_bucket "my-logs-bucket"

# Grant owner permission to Stackdriver Logging service
email = "[email protected]"
bucket.acl.add_owner "group-#{email}"

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
sink = logging.create_sink "my-sink",
                           "storage.googleapis.com/#{bucket.id}"

See Also:

Defined Under Namespace

Classes: List

Instance Method Summary collapse

Instance Method Details

#delete ⇒ Boolean

Permanently deletes the logs-based sink.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
sink = logging.sink "severe_errors"
sink.delete

Returns:

  • (Boolean) —

    Returns true if the sink was deleted.



271
272
273
274
275
 
# File 'lib/google/cloud/logging/sink.rb', line 271

def delete
  ensure_service!
  service.delete_sink name
  true
end

#destination ⇒ Object

The export destination. See Properties of Sinks.



85
86
87
 
# File 'lib/google/cloud/logging/sink.rb', line 85

def destination
  @grpc.destination
end

#destination=(destination) ⇒ Object

Updates the export destination. See Properties of Sinks.



92
93
94
 
# File 'lib/google/cloud/logging/sink.rb', line 92

def destination= destination
  @grpc.destination = destination
end

#end_at ⇒ Object Also known as: end_time

Deprecated.

This field is ignored when creating or updating sinks.

Deprecated. Time at which this sink will stop exporting log entries. If this value is present, then log entries are exported only if the log entry's timestamp is less than end_at. Optional.



198
199
200
201
 
# File 'lib/google/cloud/logging/sink.rb', line 198

def end_at
  warn "[DEPRECATION] end_at is deprecated."
  nil
end

#end_at=(_new_end_at) ⇒ Object Also known as: end_time=

Deprecated.

This field is ignored when creating or updating sinks.

Deprecated. Sets the time at which this sink will stop exporting log entries. If this value is present, then log entries are exported only if the log entry's timestamp is less than end_at. Optional.



210
211
212
 
# File 'lib/google/cloud/logging/sink.rb', line 210

def end_at= _new_end_at
  warn "[DEPRECATION] end_at= is deprecated and will be ignored."
end

#filter ⇒ Object

An advanced logs filter that defines the log entries to be exported. The filter must be consistent with the log entry format designed by the version parameter, regardless of the format of the log entry that was originally written to Stackdriver Logging.



103
104
105
 
# File 'lib/google/cloud/logging/sink.rb', line 103

def filter
  @grpc.filter
end

#filter=(filter) ⇒ Object

Updates the advanced logs filter that defines the log entries to be exported. The filter must be consistent with the log entry format designed by the version parameter, regardless of the format of the log entry that was originally written to Stackdriver Logging.



114
115
116
 
# File 'lib/google/cloud/logging/sink.rb', line 114

def filter= filter
  @grpc.filter = filter
end

#name ⇒ Object

The client-assigned sink identifier. Sink identifiers are limited to 1000 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-..



78
79
80
 
# File 'lib/google/cloud/logging/sink.rb', line 78

def name
  @grpc.name
end

#reload! ⇒ Object Also known as: refresh!

Reloads the logs-based sink with current data from the Logging service.



253
254
255
256
 
# File 'lib/google/cloud/logging/sink.rb', line 253

def reload!
  ensure_service!
  @grpc = service.get_sink name
end

#save(unique_writer_identity: nil) ⇒ Object

Updates the logs-based sink.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
sink = logging.sink "severe_errors"
sink.filter = "logName:syslog AND severity>=ERROR"
sink.save

Parameters:

  • unique_writer_identity (Boolean) (defaults to: nil) —

    Whether the sink will have a dedicated service account returned in the sink's writer_identity. Set this field to be true to export logs from one project to a different project. This field is ignored for non-project sinks (e.g. organization sinks) because those sinks are required to have dedicated service accounts. Optional.



243
244
245
246
247
248
 
# File 'lib/google/cloud/logging/sink.rb', line 243

def save unique_writer_identity: nil
  ensure_service!
  @grpc = service.update_sink \
    name, destination, filter,
    unique_writer_identity: unique_writer_identity
end

#start_at ⇒ Object Also known as: start_time

Deprecated.

This field is ignored when creating or updating sinks.

Deprecated. The time at which this sink will begin exporting log entries. If this value is present, then log entries are exported only if start_at is less than the log entry's timestamp. Optional.



175
176
177
178
 
# File 'lib/google/cloud/logging/sink.rb', line 175

def start_at
  warn "[DEPRECATION] start_at is deprecated."
  nil
end

#start_at=(_new_start_at) ⇒ Object Also known as: start_time=

Deprecated.

This field is ignored when creating or updating sinks.

Deprecated. Sets the time at which this sink will begin exporting log entries. If this value is present, then log entries are exported only if start_at is less than the log entry's timestamp. Optional.



187
188
189
 
# File 'lib/google/cloud/logging/sink.rb', line 187

def start_at= _new_start_at
  warn "[DEPRECATION] start_at= is deprecated and will be ignored."
end

#unspecified? ⇒ Boolean

Deprecated.

The v2 format is used by default and cannot be changed.

Helper to determine if the sink's version is VERSION_FORMAT_UNSPECIFIED.

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'lib/google/cloud/logging/sink.rb', line 146

def unspecified?
  warn "[DEPRECATION] unspecified? is deprecated."
  false
end

#v1? ⇒ Boolean

Deprecated.

The v2 format is used by default and cannot be changed.

Helper to determine if the sink's version is V1.

Returns:

  • (Boolean) 


164
165
166
167
 
# File 'lib/google/cloud/logging/sink.rb', line 164

def v1?
  warn "[DEPRECATION] v1? is deprecated."
  false
end

#v2? ⇒ Boolean

Deprecated.

The v2 format is used by default and cannot be changed.

Helper to determine if the sink's version is V2.

Returns:

  • (Boolean) 


155
156
157
158
 
# File 'lib/google/cloud/logging/sink.rb', line 155

def v2?
  warn "[DEPRECATION] v2? is deprecated."
  true
end

#version ⇒ Object

Deprecated.

The v2 format is used by default and cannot be changed.

Deprecated. The log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Stackdriver Logging.



124
125
126
127
 
# File 'lib/google/cloud/logging/sink.rb', line 124

def version
  warn "[DEPRECATION] version is deprecated."
  :V2
end

#version=(_version) ⇒ Object

Deprecated.

The v2 format is used by default and cannot be changed.

Deprecated. Updates the log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Stackdriver Logging. Accepted values are :VERSION_FORMAT_UNSPECIFIED, :V2, and :V1.



137
138
139
 
# File 'lib/google/cloud/logging/sink.rb', line 137

def version= _version
  warn "[DEPRECATION] version= is deprecated and will be ignored."
end

#writer_identity ⇒ Object

An IAM identity (a service account or group) that will write exported log entries to the destination on behalf of Stackdriver Logging. You must grant this identity write-access to the destination. Consult the destination service's documentation to determine the exact role that must be granted.



221
222
223
 
# File 'lib/google/cloud/logging/sink.rb', line 221

def writer_identity
  @grpc.writer_identity
end