capistrano-logtail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 894f93446c26eef03d09bf56cbd0012dad214afd
+  data.tar.gz: 5566dbcac6ea81f991d86bca4a3376d4f5257c42
+SHA512:
+  metadata.gz: 9b515e8e72ddbc9531051b878e91b4f7b433322aa58c253b8b085f6c2e4012d963e7ceeb65856f491bb25962e19d9b203b2ac86c8392ee3351b08ced52e539bc
+  data.tar.gz: 7d73c1d1955812ded4179bfb32db5666e63109ded22ec037f09d5b1800b7ccce33a2c482b5346a7a9d1c2bfdd22c5d41bb3a8a0a06277057f6dcad793a5a3eac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Unreleased (initial release)
+### Features
+- Tailing of all logs, rails log and custom log file
+- Allow to specify default log files and number of existing lines to show

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Florian Schwab
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+[![Gem Version](https://img.shields.io/gem/v/capistrano-logtail.svg)](https://rubygems.org/gems/capistrano-logtail)
+[![Dependencies](https://img.shields.io/gemnasium/ydkn/capistrano-logtail.svg)](https://gemnasium.com/ydkn/capistrano-logtail)
+[![Code Climate](https://img.shields.io/codeclimate/github/ydkn/capistrano-logtail.svg)](https://codeclimate.com/github/ydkn/capistrano-logtail)
+
+# capistrano-logtail
+
+Log tailing for capistrano
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-logtail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-logtail
+
+## Configuration
+
+```ruby
+set :logtail_files, %w( /var/log/syslog )
+set :logtail_lines, 50
+```
+
+## Usage
+
+Require in `Capfile`:
+
+```ruby
+require 'capistrano/logtail'
+```
+
+This will add the following tasks:
+* logs:tail[]
+* logs:tail:all
+* logs:tail:rails
+
+Add tasks for other log files as required:
+
+```ruby
+# config/deploy.rb
+
+namespace :logs do
+  namespace :tail do
+    desc 'Tail sidekiq log'
+    task :sidekiq do
+      on roles(:app) do
+        logtail_utility.tail(release_path.join('log', 'sidekiq.log'))
+      end
+    end
+  end
+end
+
+# cap production logs:tail:sidekiq
+```
+
+### Examples:
+
+    $ cap production logs:tail:all
+    $ cap production logs:tail:rails
+    $ cap production logs:tail[production] # tails shared/log/production.log
+    $ cap production logs:tail[/var/log/nginx/access.log]
+    $ cap production logs:tail # uses value of logtail_files
+    $ cap production logs:tail n=100 # specify number of existing lines to show
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-logtail.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/logtail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-logtail'
+  spec.version       = Capistrano::Logtail::VERSION
+  spec.authors       = ['Florian Schwab']
+  spec.email         = ['me@ydkn.de']
+  spec.description   = %q{Log tailing for capistrano}
+  spec.summary       = %q{Log tailing for capistrano}
+  spec.homepage      = 'https://github.com/ydkn/capistrano-logtail'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '>= 3.0.0', '< 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
+end

data/lib/capistrano/logtail.rb

@@ -0,0 +1,3 @@
+require 'capistrano/logtail/utility'
+
+load File.expand_path('../logtail/tasks/logtail.cap', __FILE__)

data/lib/capistrano/logtail/tasks/logtail.cap

@@ -0,0 +1,36 @@
+def logtail_utility
+  @logtail_utility ||= Capistrano::Logtail::Utility.new(self)
+end
+
+namespace :logs do
+  desc 'Tail logs'
+  task :tail, :file do |t, args|
+    if args[:file]
+      files = args[:file][0] == '/' ? args[:file] : release_path.join('log', "#{args[:file]}.log")
+    else
+      files = fetch(:logtail_files)
+    end
+
+    fail('Nothing to tail') if files.nil?
+
+    on roles(:app) do
+      logtail_utility.tail(files)
+    end
+  end
+
+  namespace :tail do
+    desc 'Tail rails log'
+    task :rails do
+      on roles(:app) do
+        logtail_utility.tail(release_path.join('log', "#{logtail_utility.rails_env}.log"))
+      end
+    end
+
+    desc 'Tail all logs'
+    task :all do
+      on roles(:app) do
+        logtail_utility.tail(release_path.join('log', '*.log'))
+      end
+    end
+  end
+end

data/lib/capistrano/logtail/utility.rb

@@ -0,0 +1,48 @@
+module Capistrano
+  module Logtail
+    # Utility stuff to avoid cluttering of logtail.cap
+    class Utility
+      def initialize(context)
+        @context = context
+      end
+
+      # Tail log file(s)
+      def tail(*files)
+        @context.info("Tailing #{files.join(' ')}")
+
+        cmd = [
+            :tail,
+            '-f',
+            "-n#{lines}",
+            *files
+          ].join(' ')
+
+        @context.send(:with_ssh) do |ssh|
+          ssh.open_channel do |chan|
+            chan.exec(cmd) do |ch, success|
+              chan.on_data do |ch, data|
+                print data
+              end
+            end
+            chan.wait
+          end
+          ssh.loop
+        end
+      end
+
+      # Rails environment
+      #
+      # @return [String] the rails environment.
+      def rails_env
+        fetch(:rails_env, fetch(:stage, 'production')).to_s
+      end
+
+      # Number of log lines
+      #
+      # @return [Integer] number of existing log lines to show.
+      def lines
+        (ENV['n'] || fetch(:logtail_lines, 10)).to_i
+      end
+    end
+  end
+end

data/lib/capistrano/logtail/version.rb

@@ -0,0 +1,8 @@
+# Capistrano
+module Capistrano
+  # Logtail
+  module Logtail
+    # gem version
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-logtail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florian Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log tailing for capistrano
+email:
+- me@ydkn.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-logtail.gemspec
+- lib/capistrano-logtail.rb
+- lib/capistrano/logtail.rb
+- lib/capistrano/logtail/tasks/logtail.cap
+- lib/capistrano/logtail/utility.rb
+- lib/capistrano/logtail/version.rb
+homepage: https://github.com/ydkn/capistrano-logtail
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: Log tailing for capistrano
+test_files: []
+has_rdoc: