Module: LogStash::PluginMixins::DeprecationLoggerSupport

Defined in:
lib/logstash/plugin_mixins/deprecation_logger_support.rb,
lib/logstash/plugin_mixins/deprecation_logger_support/legacy_init_adapter.rb,
lib/logstash/plugin_mixins/deprecation_logger_support/legacy_loggable_warn_adapter.rb

Overview

This DeprecationLoggerSupport can be mixed into any LogStash::Util::Loggable, and will ensure that the result provides an API-compatible implementation of the deprecation logger introduced in Logstash 7.6.0

This allows plugins to use the new deprecation logging API without imposing new version constraints on those plugins.

When used in an older Logstash, the implementation provided by this mixin falls through to send a WARN-level message to the Logger provided by Loggable#logger.

Defined Under Namespace

Modules: LegacyInitAdapter, LegacyLoggableWarnAdapter

Constant Summary collapse

NATIVE_SUPPORT_PROVIDED = 
LogStash::Util::Loggable.method_defined?(:deprecation_logger)

Class Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

Extending the DeprecationLoggerSupport into anyLogStash::Util::Loggable will ensure that it provides a Loggable#deprecation_logger that is API-compatible with the one introduced in Loggable in Logstash 7.6

Parameters:

  • base (LogStash::Util::Loggable) —

    : an object whose class already includes the Logstash Loggable utility



53
54
55
56
57
 
# File 'lib/logstash/plugin_mixins/deprecation_logger_support.rb', line 53

def self.extended(base)
  fail(ArgumentError, "`#{base}` must be LogStash::Util::Loggable") unless base.kind_of?(LogStash::Util::Loggable)

  base.extend(LegacyLoggableWarnAdapter) unless NATIVE_SUPPORT_PROVIDED
end

.included(base) ⇒ Object

Including the DeprecationLoggerSupport into any module or class that is already a LogStash::Util::Loggable ensures that the result provides a Loggable#deprecation_logger that is API-compatible with the one introduced to Loggable in Logstash 7.6.

Parameters:

  • base (Module) —

    : a module or class that already includes the Logstash Loggable utility



36
37
38
39
40
41
42
43
 
# File 'lib/logstash/plugin_mixins/deprecation_logger_support.rb', line 36

def self.included(base)
  fail(ArgumentError, "`#{base}` must be LogStash::Util::Loggable") unless base < LogStash::Util::Loggable

  unless NATIVE_SUPPORT_PROVIDED
    base.send(:include, LegacyLoggableWarnAdapter)
    base.send(:include, LegacyInitAdapter) if base <= LogStash::Plugin
  end
end