Class: Gruf::Interceptors::Instrumentation::RequestLogging::Formatters::Base

Inherits:

Object

• Object
• Gruf::Interceptors::Instrumentation::RequestLogging::Formatters::Base

Defined in:

lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb

Overview

Base class for request log formatting

Direct Known Subclasses

Logstash, Plain

Instance Method Summary

• #format(_payload, request:, result:) ⇒ String

  Format the parameters into a loggable string.

Instance Method Details

#format(_payload, request:, result:) ⇒ String

Format the parameters into a loggable string. Must be implemented in every derivative class

Parameters:

• _payload (Hash) —

  The incoming request payload

• request (Gruf::Controllers::Request) —

  The current controller request

• result (Gruf::Interceptors::Timer::Result) —

  The timed result of the response

Returns:

• (String) —

  The formatted string

Raises:

• (NotImplementedError)

# File 'lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb', line 35

def format(_payload, request:, result:)
  raise NotImplementedError
end