Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/Log/Formatter.html below:

Formatter — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Inherits:

Object

• Object
• Aws::Log::Formatter

show all

Defined in:

aws-sdk-core/lib/aws-sdk-core/log/formatter.rb

A log formatter generates a string for logging from a response. This accomplished with a log pattern string:

pattern = ':operation :http_response_status_code :time'
formatter = Aws::Log::Formatter.new(pattern)
formatter.format(response)

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

• Formatter.default
• Formatter.colored
• Formatter.short

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

• #pattern ⇒ String readonly

• .colored(options = {}) ⇒ Formatter

  The default log format with ANSI colors.

• .default(options = {}) ⇒ Formatter

  The default log format.

• .short(options = {}) ⇒ Formatter

  The short log format.

• #format(response) ⇒ String

  Given a resopnse, this will format a log message and return it as a string according to #pattern.

• #initialize(pattern, options = {}) ⇒ Formatter constructor

  A new instance of Formatter.

Returns a new instance of Formatter.

86
87
88
89
90

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 86

def initialize(pattern, options = {})
  @pattern = pattern
  @param_formatter = ParamFormatter.new(options)
  @param_filter = ParamFilter.new(options)
end

This class handles dynamic methods through the method_missing method

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

104
105
106
107
108
109
110

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 104

def method_missing(method_name, *args)
  if method_name.to_s.chars.first == '_'
    ":#{method_name.to_s[1..-1]}"
  else
    super
  end
end

93
94
95

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 93

def pattern
  @pattern
end

The default log format with ANSI colors.

231
232
233
234
235
236
237
238
239
240
241
242
243
244

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 231

def colored(options = {})
  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", options)
end

194
195
196
197
198
199
200
201
202
203
204

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 194

def default(options = {})
  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", options)
end

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

214
215
216
217
218
219
220
221
222

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 214

def short(options = {})
  pattern = []
  pattern << "[:client_class"
  pattern << ":http_response_status_code"
  pattern << ":time]"
  pattern << ":operation"
  pattern << ":error_class"
  Formatter.new(pattern.join(' ') + "\n", options)
end

Given a resopnse, this will format a log message and return it as a string according to #pattern.

99
100
101

# File 'aws-sdk-core/lib/aws-sdk-core/log/formatter.rb', line 99

def format(response)
  pattern.gsub(/:(\w+)/) {|sym| send("_#{sym[1..-1]}", response) }
end

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4