class Seahorse::Client::Logging::Formatter

A log formatter receives a {Response} object and return a log message as a string. When you construct a {Formatter}, you provide a pattern string with substitutions.

pattern = ':operation :http_response_status_code :time'
formatter = Seahorse::Logging::Formatter.new(pattern)
formatter.format(response)
#=> 'get_bucket 200 0.0352'

# Canned Formatters

Instead of providing your own pattern, you can choose a canned log formatter.

# Pattern Substitutions

You can put any of these placeholders into you pattern.

* `:client_class` - The name of the client class.

* `:operation` - The name of the client request method.

* `:request_params` - The user provided request parameters. Long
  strings are truncated/summarized if they exceed the
  {#max_string_size}.  Other objects are inspected.

* `:time` - The total time in seconds spent on the
  request.  This includes client side time spent building
  the request and parsing the response.

* `:retries` - The number of times a client request was retried.

* `:http_request_method` - The http request verb, e.g., `POST`,
  `PUT`, `GET`, etc.

* `:http_request_endpoint` - The request endpoint.  This includes
   the scheme, host and port, but not the path.

* `:http_request_scheme` - This is replaced by `http` or `https`.

* `:http_request_host` - The host name of the http request
  endpoint (e.g. 's3.amazon.com').

* `:http_request_port` - The port number (e.g. '443' or '80').

* `:http_request_headers` - The http request headers, inspected.

* `:http_request_body` - The http request payload.

* `:http_response_status_code` - The http response status
  code, e.g., `200`, `404`, `500`, etc.

* `:http_response_headers` - The http response headers, inspected.

* `:http_response_body` - The http response body contents.

* `:error_class`

* `:error_message`

Attributes

max_string_size[R]

@return [Integer]

pattern[R]

@return [String]

Public Class Methods

new(pattern, options = {}) click to toggle source

@param [String] pattern The log format pattern should be a string

and may contain substitutions.

@option options [Integer] :max_string_size (1000) When summarizing

request parameters, strings longer than this value will be
truncated.
# File lib/seahorse/client/logging/formatter.rb, line 80
def initialize(pattern, options = {})
  @pattern = pattern
  @max_string_size = options[:max_string_size] || 1000
end

Private Class Methods

colored() click to toggle source

The default log format with ANSI colors.

@example A sample of the colored format (sans the ansi colors).

[ClientClass 200 0.580066 0 retries] list_objects(:bucket_name => 'bucket')

@return [Formatter]

# File lib/seahorse/client/logging/formatter.rb, line 292
def colored
  bold = "\x1b[1m"
  color = "\x1b[34m"
  reset = "\x1b[0m"
  pattern = []
  pattern << "#{bold}#{color}[:client_class"
  pattern << ":http_response_status_code"
  pattern << ":time"
  pattern << ":retries retries]#{reset}#{bold}"
  pattern << ":operation(:request_params)"
  pattern << ":error_class"
  pattern << ":error_message#{reset}"
  Formatter.new(pattern.join(' ') + "\n")
end
default() click to toggle source

The default log format.

@example A sample of the default format.

[ClientClass 200 0.580066 0 retries] list_objects(:bucket_name => 'bucket')

@return [Formatter]

# File lib/seahorse/client/logging/formatter.rb, line 253
def default
  pattern = []
  pattern << "[:client_class"
  pattern << ":http_response_status_code"
  pattern << ":time"
  pattern << ":retries retries]"
  pattern << ":operation(:request_params)"
  pattern << ":error_class"
  pattern << ":error_message"
  Formatter.new(pattern.join(' ') + "\n")
end
short() click to toggle source

The short log format. Similar to default, but it does not inspect the request params or report on retries.

@example A sample of the short format

[ClientClass 200 0.494532] list_buckets

@return [Formatter]

# File lib/seahorse/client/logging/formatter.rb, line 274
def short
  pattern = []
  pattern << "[:client_class"
  pattern << ":http_response_status_code"
  pattern << ":time]"
  pattern << ":operation"
  pattern << ":error_class"
  Formatter.new(pattern.join(' ') + "\n")
end

Public Instance Methods

==(other)
Alias for: eql?
eql?(other) click to toggle source

@api private

# File lib/seahorse/client/logging/formatter.rb, line 100
def eql?(other)
  other.is_a?(self.class) and other.pattern == self.pattern
end
Also aliased as: ==
format(response) click to toggle source

Given a {Response}, this will format a log message and return it

as a string.

@param [Response] response @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 95
def format(response)
  pattern.gsub(/:(\w+)/) {|sym| send("_#{sym[1..-1]}", response) }
end

Private Instance Methods

_client_class(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 115
def _client_class(response)
  response.context.client.class.name
end
_error_class(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 177
def _error_class(response)
  response.error ? response.error.class.name : ''
end
_error_message(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 181
def _error_message(response)
  response.error ? response.error.message : ''
end
_http_request_body(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 161
def _http_request_body(response)
  summarize_value(response.context.http_request.body_contents)
end
_http_request_endpoint(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 137
def _http_request_endpoint(response)
  response.context.http_request.endpoint.to_s
end
_http_request_headers(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 157
def _http_request_headers(response)
  response.context.http_request.headers.inspect
end
_http_request_host(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 145
def _http_request_host(response)
  response.context.http_request.endpoint.host
end
_http_request_method(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 153
def _http_request_method(response)
  response.context.http_request.http_method
end
_http_request_port(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 149
def _http_request_port(response)
  response.context.http_request.endpoint.port.to_s
end
_http_request_scheme(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 141
def _http_request_scheme(response)
  response.context.http_request.endpoint.scheme
end
_http_response_body(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 173
def _http_response_body(response)
  summarize_value(response.context.http_response.body_contents)
end
_http_response_headers(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 169
def _http_response_headers(response)
  response.context.http_response.headers.inspect
end
_http_response_status_code(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 165
def _http_response_status_code(response)
  response.context.http_response.status_code.to_s
end
_operation(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 119
def _operation(response)
  response.context.operation_name
end
_request_params(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 123
def _request_params(response)
  summarize_hash(response.context.params)
end
_retries(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 133
def _retries(response)
  response.context.retries
end
_time(response) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 127
def _time(response)
  duration = response.context[:logging_completed_at] -
    response.context[:logging_started_at]
  ("%.06f" % duration).sub(/0+$/, '')
end
method_missing(method_name, *args) click to toggle source
Calls superclass method
# File lib/seahorse/client/logging/formatter.rb, line 107
def method_missing(method_name, *args)
  if method_name.to_s.chars.first == '_'
    ":#{method_name.to_s[1..-1]}"
  else
    super
  end
end
summarize_array(array) click to toggle source

@param [Array] array @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 239
def summarize_array array
  "[" + array.map{|v| summarize_value(v) }.join(",") + "]"
end
summarize_file(path) click to toggle source

Given the path to a file on disk, this method returns a summarized inspecton string that includes the file size. @param [String] path @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 233
def summarize_file path
  "#<File:#{path} (#{File.size(path)} bytes)>"
end
summarize_hash(hash) click to toggle source

@param [Hash] hash @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 187
def summarize_hash(hash)
  hash.keys.first.is_a?(String) ?
    summarize_string_hash(hash) :
    summarize_symbol_hash(hash)
end
summarize_string(str) click to toggle source

@param [String] str @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 220
def summarize_string str
  max = max_string_size
  if str.size > max
    "#<String #{str[0...max].inspect} ... (#{str.size} bytes)>"
  else
    str.inspect
  end
end
summarize_string_hash(hash) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 199
def summarize_string_hash(hash)
  hash.map do |key,v|
    "#{key.inspect}=>#{summarize_value(v)}"
  end.join(",")
end
summarize_symbol_hash(hash) click to toggle source
# File lib/seahorse/client/logging/formatter.rb, line 193
def summarize_symbol_hash(hash)
  hash.map do |key,v|
    "#{key}:#{summarize_value(v)}"
  end.join(",")
end
summarize_value(value) click to toggle source

@param [Object] value @return [String]

# File lib/seahorse/client/logging/formatter.rb, line 207
def summarize_value value
  case value
  when String   then summarize_string(value)
  when Hash     then '{' + summarize_hash(value) + '}'
  when Array    then summarize_array(value)
  when File     then summarize_file(value.path)
  when Pathname then summarize_file(value)
  else value.inspect
  end
end