logging-rtail 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc4e9e5dfdd6a40e40713d3084a09fa303f0fb27
+  data.tar.gz: 3dc9d2c14d07668cf3912f528f1197c4599a9827
+SHA512:
+  metadata.gz: d016b3fe9ab2c153a73c8a49da6aaafa61c381c659086f70eee6354d732b6390cf57c59a77ee95e90f793d05080a02c076408243aa116d76c3061c3cb57f2430
+  data.tar.gz: 9541536876b1b754f40552fd1f6e5abc07cdceed4674165a3a22d77f10a8efff7f7d2cb5c9d55cf1537ac11d5bf06ea7d2932627bf1608de6b4e9dcf4ea93e38

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,38 @@
+# Most of these are disabling existing cops, primarily
+# due to a smattering of different styles and loose
+# guidlines for contributions.
+#
+# Any of these may be changed.
+
+# I personally believe double-quotes is more-idiomatic Ruby
+# StringLiterals:
+#   EnforcedStyle: double_quotes
+#  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+    '%i': '{}'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '{}'
+    '%w': '{}'
+    '%W': '{}'
+    '%x': '{}'
+
+SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+LineLength:
+  Max: 120
+
+# Style/ClassAndModuleChildren:
+#   EnforcedStyle: compact
+
+Style/FileName:
+  Enabled: false
+
+# TODO: Disable before release
+# Documentation:
+#   Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logging-rtail.gemspec
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# Logging::Plugins::Rtail
+
+This is an "Appender" for the [Logging](https://rubygems.org/gems/logging) gem, to allow you to forward Logs directly to an
+[Rtail](https://github.com/kilianc/rtail) Service.
+
+Normally, you'd use the Rtail client to read logs from another process (e.g. `tail -F process.log | rtail --name WildTest`) but
+this Gem allows you to send the logs directly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logging'
+gem 'logging-rtail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logging-rtail
+
+## Usage
+
+The Logging gem uses [little-plugger](https://rubygems.org/gems/little-plugger) gem to manage
+[extending Logger](https://github.com/TwP/logging#extending).
+This means it will automatically load and initialise the `logging-rtail` code as soon as it loads the Logging code.
+
+To configure Logging to use Rtail, you simply have to add the appender to your configuring of Logging.
+
+e.g. The following will send the "Wootles" log-output to STDERR and the Rtail service running on the localhost:
+
+```ruby
+l = Logging.logger["The Wild Wild Test"]
+l.add_appenders(
+  Logging.appenders.stderr,
+  Logging.appenders.rtail("Wild Test stream")
+)
+
+l.info "Wootles"
+```
+
+The default host is `localhost` and port is `9999`, as per [Rtail's defaults](https://github.com/kilianc/rtail#params-1).
+
+If you want to connect to an Rtail service on a different host or port, pass the `host` or `port` options to the `rtail` appender factory:
+
+```ruby
+l.add_appenders(
+  Logging.appenders.rtail("Wild Test stream", host: "other.host.nowhere", port: 10010)
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in
+`lib/logging/plugins/rtail.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### To Do's
+
+I track major "To Do's" in a [TODO.org](TODO.org) file.
+
+I track context-sensitive and minor ones with `TODO` and `FIXME` comments in the source code.
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fairfaxmedia/logging-rtail.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/TODO.org

@@ -0,0 +1,4 @@
+* Tasks
+** TODO Tests! [0/2]
+*** TODO UDP server fake
+*** TODO DTLS...  whenever Ruby and node.js support it...

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'logging'
+
+# NB: `little-plugger` handles loading the code, so the below is unneccessary:
+# require 'logging/plugins/rtail'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logging/appenders/rtail.rb

@@ -0,0 +1,73 @@
+require 'socket'
+require 'json'
+
+module Logging
+  module Appenders
+    # Factory for the Rtail appender.
+    def self.rtail(*args)
+      fail ArgumentError, '::Logging::Appenders::Rtail needs a name as first argument.' if args.empty?
+      ::Logging::Appenders::Rtail.new(*args)
+    end
+
+    # This class provides an Appender that can write to a Rtail service over UDP.
+    class Rtail < ::Logging::Appenders::IO
+      # Creates a new Rtail Appender that will use the given host and port
+      # as the Rtail server destination.
+      #
+      # @param name [String] Stream ID to differentiate in the Rtail server
+      # @param host [String] Host / IP of the Rtail server's UDP receiver (defaults to "localhost")
+      # @param port [Integer] Port of the Rtail server's UDP receiver (defaults to 9999)
+      def initialize(name, opts = {})
+        @host = opts.fetch(:host, 'localhost')
+        @port = opts.fetch(:port, 9999)
+
+        fail ArgumentError, 'Empty host and port is not appropriate' unless host && !host.empty? && port
+
+        # Because it's UDP, we want it flushed to the server, immediately:
+        super(name, connect(@host, @port), opts.merge(auto_flushing: true))
+      end
+
+      def host
+        @host.dup
+      end
+
+      attr_reader :port
+
+      # Reopen the connection to the underlying logging destination. If the
+      # connection is currently closed then it will be opened. If the connection
+      # is currently open then it will be closed and immediately opened.
+      def reopen
+        @mutex.synchronize do
+          if defined? @io && @io
+            flush
+            close rescue nil
+          end
+          @io = connect(@host, @port)
+        end
+
+        super
+        self
+      end
+
+      private
+
+      def connect(host, port)
+        UDPSocket.new.tap {|s| s.connect(host, port) }
+      end
+
+      def canonical_write(str)
+        return self if @io.nil?
+
+        str = str.force_encoding(encoding) if encoding && str.encoding != encoding
+        @io.syswrite JSON.generate(id: name, timestamp: Time.now, content: str)
+
+        self
+
+      rescue StandardError => err
+        self.level = :off
+        ::Logging.log_internal { "appender #{name.inspect} has been disabled" }
+        ::Logging.log_internal_error(err)
+      end
+    end
+  end
+end

data/lib/logging/plugins/rtail.rb

@@ -0,0 +1,15 @@
+module Logging
+  module Plugins
+    # This is plugin-intialisation module used by `little-plugger` to find the code:
+    module Rtail
+      extend self
+
+      VERSION = '0.1.2'.freeze unless defined? VERSION
+
+      # Initialiser for `little-plugger`:
+      def initialize_rtail
+        require File.expand_path('../../appenders/rtail', __FILE__)
+      end
+    end
+  end
+end

data/logging-rtail.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logging/plugins/rtail'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logging-rtail'
+  spec.version       = Logging::Plugins::Rtail::VERSION
+  spec.authors       = ['Will']
+  spec.email         = ['wildjim+dev@kiwinet.org']
+
+  spec.summary       = 'An appender for the Logging gem that sends messages to an Rtail server'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/fairfaxmedia/logging-rtail'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.2'
+
+  spec.add_runtime_dependency 'little-plugger', '~> 1.1'
+  spec.add_runtime_dependency 'logging', '~> 2.0'
+  spec.add_runtime_dependency 'json', '~> 1.8'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: logging-rtail
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Will
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: little-plugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- wildjim+dev@kiwinet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- TODO.org
+- bin/console
+- bin/setup
+- lib/logging/appenders/rtail.rb
+- lib/logging/plugins/rtail.rb
+- logging-rtail.gemspec
+homepage: https://github.com/fairfaxmedia/logging-rtail
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: An appender for the Logging gem that sends messages to an Rtail server
+test_files: []
+has_rdoc: