ffwd 0.1.0

data/lib/ffwd/debug/connection.rb

@@ -0,0 +1,48 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module FFWD::Debug
+  class Connection < EM::Connection
+    include FFWD::Logging
+
+    def initialize handler
+      @handler = handler
+      @peer = nil
+      @ip = nil
+      @port = nil
+    end
+
+    def get_peer
+      peer = get_peername
+      port, ip = Socket.unpack_sockaddr_in(peer)
+      return peer, ip, port
+    end
+
+    def post_init
+      @peer, @ip, @port = get_peer
+      @handler.register_client @peer, self
+      log.info "#{@ip}:#{@port}: Connect"
+    end
+
+    def unbind
+      @handler.unregister_client @peer, self
+      log.info "#{@ip}:#{@port}: Disconnect"
+    end
+
+    def send_line line
+      send_data "#{line}\n"
+    end
+  end
+end

data/lib/ffwd/debug/monitor_session.rb

@@ -0,0 +1,71 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require_relative '../lifecycle'
+
+module FFWD::Debug
+  class MonitorSession
+    attr_reader :id
+
+    def initialize id, channel, type
+      @type = type
+      @clients = {}
+
+      subs = []
+
+      channel.starting do
+        subs << channel.event_subscribe do |event|
+          data = @type.serialize_event event
+
+          begin
+            send JSON.dump(:id => @id, :type => :event, :data => data)
+          rescue => e
+            log.error "Failed to serialize event", e
+            return
+          end
+        end
+
+        subs << channel.metric_subscribe do |metric|
+          data = @type.serialize_metric metric
+
+          begin
+            send JSON.dump(:id => @id, :type => :metric, :data => data)
+          rescue => e
+            log.error "Failed to serialize metric", e
+            return
+          end
+        end
+      end
+
+      channel.stopping do
+        subs.each(&:unsubscribe).clear
+      end
+    end
+
+    def register peer, client
+      @clients[peer] = client
+    end
+
+    def unregister peer, client
+      @clients.delete peer
+    end
+
+    def send line
+      @clients.each do |peer, client|
+        client.send_line line
+      end
+    end
+  end
+end

data/lib/ffwd/debug/tcp.rb

@@ -0,0 +1,82 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require_relative '../lifecycle'
+require_relative '../logging'
+require_relative '../retrier'
+
+require_relative 'connection'
+require_relative 'monitor_session'
+
+module FFWD::Debug
+  class TCP
+    include FFWD::Logging
+    include FFWD::Lifecycle
+
+    def initialize host, port, rebind_timeout
+      @clients = {}
+      @sessions = {}
+      @host = host
+      @port = port
+      @peer = "#{@host}:#{@port}"
+
+      r = FFWD.retry :timeout => rebind_timeout do |attempt|
+        EM.start_server @host, @port, Connection, self
+        log.info "Bind on tcp://#{@peer} (attempt #{attempt})"
+      end
+
+      r.error do |a, t, e|
+        log.error "Failed to bind tcp://#{@peer} (attempt #{a}), retry in #{t}s", e
+      end
+
+      r.depend_on self
+    end
+
+    def register_client peer, client
+      @sessions.each do |id, session|
+        session.register peer, client
+      end
+
+      @clients[peer] = client
+    end
+
+    def unregister_client peer, client
+      @sessions.each do |id, session|
+        session.unregister peer, client
+      end
+
+      @clients.delete peer
+    end
+
+    # Setup monitor hooks for the specified input and output channel.
+    def monitor id, channel, type
+      if session = @sessions[id]
+        log.error "Session already monitored: #{id}"
+        return
+      end
+
+      session = @sessions[id] = MonitorSession.new id, channel, type
+
+      # provide the session to the already connected clients.
+      @clients.each do |peer, client|
+        session.register peer, client
+      end
+
+      channel.stopping do
+        @sessions.delete id
+      end
+    end
+  end
+end

data/lib/ffwd/event.rb

@@ -0,0 +1,65 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module FFWD
+  # Struct used to define all fields related to an event.
+  EventStruct = Struct.new(
+    # The time at which the event was collected.
+    :time,
+    # The unique key of the event.
+    :key,
+    # A numeric value associated with the event.
+    :value,
+    # The host from which the event originated.
+    :host,
+    # The source event this event was derived from (if any).
+    :source,
+    # A state associated to the event.
+    :state,
+    # A description associated to the event.
+    :description,
+    # A time to live associated with the event.
+    :ttl,
+    # Tags associated with the event.
+    :tags,
+    # Attributes (extra fields) associated with the event.
+    :attributes
+  )
+
+  # A convenience class for each individual event.
+  class Event < EventStruct
+    def self.make opts = {}
+      new(opts[:time], opts[:key], opts[:value], opts[:host], opts[:source],
+          opts[:state], opts[:description], opts[:ttl], opts[:tags],
+          opts[:attributes])
+    end
+
+    # Convert event to a sparse hash.
+    def to_h
+      d = {}
+      d[:time] = time.to_i if time
+      d[:key] = key if key
+      d[:value] = value if value
+      d[:host] = host if host
+      d[:source] = source if source
+      d[:state] = state if state
+      d[:description] = description if description
+      d[:ttl] = ttl if ttl
+      d[:tags] = tags.to_a if tags
+      d[:attributes] = attributes if attributes
+      d
+    end
+  end
+end

data/lib/ffwd/event_emitter.rb

@@ -0,0 +1,57 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require_relative 'utils'
+require_relative 'event'
+require_relative 'logging'
+
+module FFWD
+  # Used to emit events to an 'output' channel
+  #
+  # Can take two parts of a configuration 'base' and 'opts' to decide which
+  # metadata emitted events should be decorated with.
+  class EventEmitter
+    include FFWD::Logging
+
+    def self.build output, base, opts
+      output = output
+      host = opts[:host] || base[:host] || FFWD.current_host
+      ttl = opts[:ttl] || base[:ttl]
+      tags = FFWD.merge_sets base[:tags], opts[:tags]
+      attributes = FFWD.merge_hashes base[:attributes], opts[:attributes]
+      new output, host, ttl, tags, attributes
+    end
+
+    def initialize output, host, ttl, tags, attributes
+      @output = output
+      @host = host
+      @ttl = ttl
+      @tags = tags
+      @attributes = attributes
+    end
+
+    def emit e
+      e[:time] ||= Time.now
+      e[:host] ||= @host if @host
+      e[:ttl] ||= @ttl if @ttl
+      e[:tags] = FFWD.merge_sets @tags, e[:tags]
+      e[:attributes] = FFWD.merge_hashes @attributes, e[:attributes]
+
+      @output.event Event.make(e)
+    rescue => e
+      log.error "Failed to emit event", e
+    end
+  end
+end

data/lib/ffwd/handler.rb

@@ -0,0 +1,43 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require_relative 'connection'
+
+module FFWD
+  # Handlers are used by output plugins based of the protocol stack.
+  class Handler < FFWD::Connection
+    def self.new signature, parent, *args
+      instance = super(signature, *args)
+
+      instance.instance_eval do
+        @parent = parent
+      end
+
+      instance
+    end
+
+    def unbind
+      @parent.unbind
+    end
+
+    def connection_completed
+      @parent.connection_completed
+    end
+
+    def send_all events, metrics; end
+    def send_event event; end
+    def send_metric metric; end
+  end
+end

data/lib/ffwd/lifecycle.rb

@@ -0,0 +1,92 @@
+# $LICENSE
+# Copyright 2013-2014 Spotify AB. All rights reserved.
+#
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+# Lifecycle management module.
+#
+# Any class and module including this will allow other components to subscribe
+# to their state changes (starting, stopping).
+module FFWD
+  module Lifecycle
+    def stopping_hooks
+      @stopping_hooks ||= []
+    end
+
+    def starting_hooks
+      @starting_hooks ||= []
+    end
+
+    # Register a callback to be executed when the Stoppable is to be stopped.
+    # 
+    # This will only be called once.
+    def stopping &block
+      if stopped?
+        block.call
+      else
+        stopping_hooks << block
+      end
+    end
+
+    def starting &block
+      if started?
+        block.call
+      else
+        starting_hooks << block
+      end
+    end
+
+    def start
+      return if started?
+      starting_hooks.each(&:call)
+      starting_hooks.clear
+      @state = :started
+    end
+
+    def stop
+      return if stopped?
+      stopping_hooks.each(&:call)
+      stopping_hooks.clear
+      @state = :stopped
+    end
+
+    def started?
+      (@state ||= :none) == :started
+    end
+
+    def stopped?
+      (@state ||= :none) == :stopped
+    end
+
+    def depend_on other_lifecycle
+      if other_lifecycle.nil?
+        raise "Other lifecycle must not be nil"
+      end
+
+      if (@depends ||= nil)
+        raise "This component already depends on #{@depends}"
+      end
+
+      @depends = other_lifecycle
+
+      other_lifecycle.starting do
+        start
+      end
+
+      other_lifecycle.stopping do
+        stop
+        @depends = nil
+      end
+    end
+  end
+end