Module: PactBroker::Logging

Included in:
DB, PactBroker, Api::Middleware::Configuration, Api::PactBrokerUrls, Api::Renderers::HtmlPactRenderer, Api::Resources::DefaultBaseResource, Api::Resources::ErrorHandler, Api::Resources::ErrorResponseBodyGenerator, App, Badges::Service, Certificates::Service, Certificates::Service, Config::Load, Config::Save, Contracts::Service, DB::Clean, DB::DataMigrations::SetPacticipantMainBranch, Deployments::DeployedVersionService, Diagnostic::Resources::Dependencies, Domain::OrderVersions, Domain::Webhook, Domain::WebhookRequest, Errors, Errors::ErrorLogger, Index::Service, Integrations::Service, Matrix::DeploymentStatusSummary, Matrix::Repository, Matrix::Service, Pacticipants::Service, Pacts::PactsForVerificationRepository, Pacts::Repository, Pacts::Service, Tags::Service, Verifications::Service, Versions::Repository, Versions::Service, Webhooks::EventListener, Webhooks::Job, Webhooks::Repository, Webhooks::Service, Webhooks::TriggerService, Webhooks::WebhookRequestLogger, Webhooks::WebhookRequestTemplate
Defined in:
lib/pact_broker/logging.rb,
lib/pact_broker/logging/default_formatter.rb

Defined Under Namespace

Classes: DefaultFormatter

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/pact_broker/logging.rb', line 8

def self.included(base)
  base.extend self
  base.extend SemanticLogger::Loggable::ClassMethods
  base.class_eval do
    # Returns [SemanticLogger::Logger] class level logger
    def self.logger
      require "pact_broker/configuration"
      @logger ||= PactBroker.configuration.custom_logger || SemanticLogger[self]
    end

    # Replace instance class level logger
    def self.logger=(logger)
      @logger = logger
    end

    # Returns [SemanticLogger::Logger] instance level logger
    def logger
      @logger ||= self.class.logger
    end

    # Replace instance level logger
    def logger=(logger)
      @logger = logger
    end
  end
end

Instance Method Details

#log_error(e, description = nil) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/pact_broker/logging.rb', line 45

def log_error e, description = nil
  if logger.instance_of?(SemanticLogger::Logger)
    if description
      logger.error(description, e)
    else
      logger.error(e)
    end
  else
    message = "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
    message = "#{description} - #{message}" if description
    logger.error message
  end
  unless PactBroker.configuration.hide_pactflow_messages
    logger.info "\n\n#{'*' * 80}\n\nPrefer it was someone else's job to deal with this error? Check out https://pactflow.io/oss for a hardened, fully supported SaaS version of the Pact Broker with an improved UI  + more.\n\n#{'*' * 80}\n"
  end
end

#log_with_tag(tag) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/pact_broker/logging.rb', line 35

def log_with_tag(tag)
  if logger.respond_to?(:tagged)
    logger.tagged(tag) do
      yield
    end
  else
    yield
  end
end