Module: AWS::S3::Logging::Management::ClassMethods

Defined in:
lib/aws/s3/logging.rb

Instance Method Summary collapse

Instance Method Details

#disable_logging_for(name = nil) ⇒ Object Also known as: disable_logging

Disables logging for the bucket named name.



243
244
245
 
# File 'lib/aws/s3/logging.rb', line 243

def disable_logging_for(name = nil)
  logging_status(bucket_name(name), Status.new)
end

#enable_logging_for(name = nil, options = {}) ⇒ Object Also known as: enable_logging

Enables logging for the bucket named name. You can specify what bucket to log to with the 'target_bucket' option as well as what prefix to add to the log files with the 'target_prefix' option. Unless you specify otherwise, logs will be delivered to the same bucket that is being logged and will be prefixed with log-.



233
234
235
236
237
238
239
 
# File 'lib/aws/s3/logging.rb', line 233

def enable_logging_for(name = nil, options = {})
  name            = bucket_name(name)
  default_options = {'target_bucket' => name, 'target_prefix' => 'log-'}
  options         = default_options.merge(options)
  grant_logging_access_to_target_bucket(options['target_bucket'])
  logging_status(name, Status.new(options))
end

#logging_enabled_for?(name = nil) ⇒ Boolean Also known as: logging_enabled?

Returns true if logging has been enabled for the bucket named name.

Returns:

  • (Boolean) 


249
250
251
 
# File 'lib/aws/s3/logging.rb', line 249

def logging_enabled_for?(name = nil)
  logging_status(bucket_name(name)).logging_enabled?
end

#logging_status_for(name = nil, status = nil) ⇒ Object Also known as: logging_status

Returns the logging status for the bucket named name. From the logging status you can determine the bucket logs are delivered to and what the bucket object’s keys are prefixed with. For more information see the Logging::Status class.

Bucket.logging_status_for 'marcel'



219
220
221
222
223
224
225
226
227
 
# File 'lib/aws/s3/logging.rb', line 219

def logging_status_for(name = nil, status = nil)
  if name.is_a?(Status)
    status = name
    name   = nil
  end

  path = path(name) << '?logging'
  status ? put(path, {}, status.to_xml) : Status.new(get(path).parsed)
end

#logs_for(name = nil, options = {}) ⇒ Object Also known as: logs

Returns the collection of logs for the bucket named name.

Bucket.logs_for 'marcel'

Accepts the same options as Bucket.find, such as :max_keys and :marker.



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/aws/s3/logging.rb', line 259

def logs_for(name = nil, options = {})
  if name.is_a?(Hash)
    options = name
    name    = nil
  end
  
  name           = bucket_name(name)
  logging_status = logging_status_for(name)
  return [] unless logging_status.logging_enabled?
  objects(logging_status.target_bucket, options.merge(:prefix => logging_status.target_prefix)).map do |log_object|
    Log.new(log_object)
  end
end