Class: Karafka::Instrumentation::Vendors::Kubernetes::BaseListener

Inherits:

Object

• Object
• Karafka::Instrumentation::Vendors::Kubernetes::BaseListener

Includes:

Core::Helpers::Time

Defined in:

lib/karafka_ext/k8s.rb

Overview

Base Kubernetes Listener providing basic HTTP server capabilities to respond with health

Direct Known Subclasses

LivenessListener

Instance Method Summary

• #healthy? ⇒ Boolean

  True if all good, false if we should tell k8s to kill this process.

• #initialize(hostname: nil, port: 4000, logger: ActiveSupport::Logger.new(STDOUT)) ⇒ BaseListener constructor

  A new instance of BaseListener.

Constructor Details

#initialize(hostname: nil, port: 4000, logger: ActiveSupport::Logger.new(STDOUT)) ⇒ BaseListener

Returns a new instance of BaseListener.

Parameters:

• hostname (String, nil) (defaults to: nil) —

  hostname or nil to bind on all

• port (Integer) (defaults to: 4000) —

  TCP port on which we want to run our HTTP status server

# File 'lib/karafka_ext/k8s.rb', line 22

def initialize(
  hostname: nil,
  port: 4000,
  logger: ActiveSupport::Logger.new(STDOUT)
)
  @hostname = hostname
  @port = port
  @logger  = logger
end

Instance Method Details

#healthy? ⇒ Boolean

Returns true if all good, false if we should tell k8s to kill this process.

Returns:

• (Boolean) —

  true if all good, false if we should tell k8s to kill this process

Raises:

• (NotImplementedError)

# File 'lib/karafka_ext/k8s.rb', line 33

def healthy?
  raise NotImplementedError, 'Implement in a subclass'
end