log_timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ffabb4e386351a7abcabbb69ad32f9dcffe1d1f
+  data.tar.gz: b171b77fc6be89ebeafcc6bfc20999211cfb6085
+SHA512:
+  metadata.gz: 8056db0d5e567d5c7f404e1ab2615abf65ece14dab953967e5414d0d6ec582da35ecf4eda5b232297121adbd35a2cb5dd11c96372c858ff06994595e49ad2893
+  data.tar.gz: a341d54fa15efa9e836f7a216152999bc8c55eb94a2b72134ded8b92a591d0c9e8eddc162be9040f51bb22d4c8e49bcd90c6bfb6d940f157d55a559aeb5db3d0

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at g.visscher@core4.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gerrit Visscher
+
+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,49 @@
+# LogTimer
+
+If a service crashed silently, chances are, it does not write to its logs for a while. This
+gem checks a list of log files if they changed recently and alerts you if a file is older
+than the given limit.
+
+## Installation
+
+    $ gem install log_timer
+
+## Usage
+
+When you run the gem for the first time, use the `--init` parameter to generate a basic example config.
+Then open ~/.log_timer.yml in your favorite editor (most likely vim) and add the (log) files you want to have checked.
+
+When you run log_timer, it will check all files listed in the "files:" section and check their modification times.
+If a file is older than the specified limit, it will warn you with a message. This is not yet as useful as I would want
+to have it. So if you run `log_timer --mail` it will send a mail to you with the same info plus the last lines from
+the file (either 10 or, if specified, the number given with "tail:").
+
+A cronjob might look like this:
+
+```crontab
+0 * * * * log_timer --mail --quiet
+```
+
+The limit works with [chronic_duration](https://github.com/hpoydar/chronic_duration). Most likely you will need
+something like "30d" for 30 days or 24 hours ("24h").
+
+## 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 `version.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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CORE4/log_timer. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/log_timer

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'log_timer'
+require 'optparse'
+require 'active_support/core_ext/hash/keys'
+require 'yaml'
+
+cmd_options = {
+  config: "#{ENV['HOME']}/.log_timer.yml",
+  quiet: false,
+  mail: false,
+  write_config: false
+}
+
+DEFAULT_CONFIG = {
+  hostname: `hostname`,
+  mail: {
+    smtp_server: 'example.com',
+    smtp_port: 25,
+    smtp_user: 'exmapleuser',
+    smtp_password: 'examplepassword',
+    from: 'logtimer@example.com',
+    to: 'youraddress@example.com'
+  },
+  files: {
+    old: {
+      path: '/path/to/some.log',
+      limit: '24h',
+      tail: 10
+    },
+    new: {
+      path: '/some/other.log',
+      limit: '60d'
+    }
+  }
+}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: log_timer [options]\nDefault config file: #{cmd_options[:config]}"
+
+  opts.on('-q', '--quiet', 'Do not output anything. (when using with cron, see --mail)') do
+    cmd_options[:quiet] = true
+  end
+
+  opts.on('-c [CONFIG]', '--config [CONFIG]', 'Path to the config file') do |config|
+    cmd_options[:config] = config
+  end
+
+  opts.on('-m', '--mail', 'Send mail when an old file is found') do
+    cmd_options[:mail] = true
+  end
+
+  opts.on('--init', 'Write a new config file with default values') do
+    cmd_options[:write_config] = true
+  end
+end
+optparse.parse!
+
+if cmd_options[:write_config]
+  File.rename cmd_options[:config], "#{cmd_options[:config]}.bkp" if File.exist? cmd_options[:config]
+
+  File.open(cmd_options[:config], 'w') do |file|
+    file.write(DEFAULT_CONFIG.deep_stringify_keys.to_yaml)
+  end
+  puts "Config written into '#{cmd_options[:config]}'." unless cmd_options[:quiet]
+  exit 0
+end
+
+unless File.exist? cmd_options[:config]
+  STDERR.puts "Cannot find config file (#{cmd_options[:config]})"
+  exit 1
+end
+
+config = YAML.load_file(cmd_options[:config]).deep_symbolize_keys
+
+config[:cmd_options] = cmd_options
+
+LogTimer::LogTimer.new(config).check

data/lib/log_timer.rb

@@ -0,0 +1,47 @@
+require 'log_timer/version'
+require 'log_timer/log'
+require 'log_timer/mailer'
+require 'yaml'
+require 'chronic_duration'
+
+require 'pp'
+
+module LogTimer
+  class LogTimer
+    attr_accessor :mailer, :config
+
+    def initialize(config)
+      @config = config
+      @mailer = Mailer.new(@config[:mail])
+    end
+
+    def check
+      @config[:files].each do |_key, file_info|
+        log = Log.new(file_info[:path])
+        if log.older?(Time.now - ChronicDuration.parse(file_info[:limit]))
+          mailer.send(mail_subject(log), mail_body(log, file_info)) if @config[:cmd_options][:mail]
+          puts "#{log.path} is older than the limit #{file_info[:limit]}" unless @config[:cmd_options][:quiet]
+        end
+      end
+    end
+
+    def mail_subject(log)
+      "#{File.basename(log.path)} on #{@config[:hostname] || `hostname`} is getting old"
+    end
+
+    def mail_body(log, file_info)
+      tail_limit = file_info[:tail_limit] || 10
+      body = <<EOD
+The log file #{log.path} is got older than the specified limit (#{file_info[:limit]}). Maybe a service stopped working.
+The file was last changed on #{log.modification_date}.
+
+The last #{tail_limit} lines are:
+#{log.tail(tail_limit)}
+
+Sincerely,
+The LogTimer gem
+EOD
+      body
+    end
+  end
+end

data/lib/log_timer/log.rb

@@ -0,0 +1,25 @@
+module LogTimer
+  # Represents a log file
+  class Log
+    attr_accessor :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def modification_date
+      File.mtime(@path)
+    end
+
+    # Checks if the log file is older than the given datetime
+    def older?(reference_time)
+      File.mtime(@path) < reference_time
+    end
+
+    # Returns the last n lines from the log file
+    # Implementing this directly in Ruby is annoyingly complicated (and/or slow) it seems
+    def tail(lines = 10)
+      `tail -n #{lines} #{@path}`.split("\n")
+    end
+  end
+end

data/lib/log_timer/mailer.rb

@@ -0,0 +1,61 @@
+require 'net/smtp'
+
+module LogTimer
+  # Handles sending of mails via smtp or local (mail-utils)
+  class Mailer
+    attr_accessor :smtp_server, :smtp_port, :smtp_user, :smtp_password, :from, :to
+
+    def initialize(options)
+      @options = options
+    end
+
+    def send(subject, body)
+      if @options[:smtp_server] && !@options[:smtp_server].empty?
+        send_mail_smtp(compose_message(subject, body))
+      else
+        send_mail_local(subject, body)
+      end
+    end
+
+    protected
+
+    def compose_message(subject, body)
+      to_addresses = [*@options[:to]].join(', ')
+      message = <<EOD
+From: Log Notifier <#{@options[:from]}>
+To: <#{to_addresses}>
+Subject: #{subject}
+
+#{body}
+EOD
+      message
+    end
+
+    def send_mail_smtp(message)
+      ::Net::SMTP.start(
+          @options[:smtp_server],
+          @options[:smtp_port],
+          from_domain,
+          @options[:smtp_user],
+          @options[:smtp_password]) do |smtp|
+        smtp.send_message message, @options[:from], @options[:to]
+      end
+    end
+
+    def send_mail_local(subject, body)
+      stdin, stdout, stderr, wait_thr = Open3.popen3("mail -s \"#{subject.gsub('"', '\"')}\" #{@options[:to].join(', ')}")
+      stdin.puts body
+
+      stdin.close  # stdin, stdout and stderr should be closed explicitly in this form.
+      stdout.close
+      stderr.close
+
+      wait_thr.value == 0
+    end
+
+    def from_domain
+      @options[:from].split('@')[1]
+    end
+
+  end
+end

data/lib/log_timer/version.rb

@@ -0,0 +1,3 @@
+module LogTimer
+  VERSION = '0.1.0'
+end

data/log_timer.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'log_timer'
+  spec.version       = LogTimer::VERSION
+  spec.authors       = ['Gerrit Visscher']
+  spec.email         = ['g.visscher@core4.de']
+
+  spec.summary       = 'Checks if log files have been changed recently'
+  spec.description   = 'If a service crashed silently, chances are, it does not write to its logs for a while. This '\
+                       'gem checks a list of log files if they changed recently and alerts you if a file is older '\
+                       'than the given limit.'
+  spec.homepage      = 'https://github.com/CORE4/log_timer'
+  spec.license       = 'MIT'
+
+  rejected_files = %w(bin/setup bin/console Rakefile .travis.yml .rspec)
+  git_files = `git ls-files -z`.split("\x0")
+
+  spec.files         = git_files.reject { |f| f.match(%r{^(test|spec|features)/}) || rejected_files.include?(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'chronic_duration', '~> 0.10', '>= 0.10.6'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0', '>= 5.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: log_timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerrit Visscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: If a service crashed silently, chances are, it does not write to its
+  logs for a while. This gem checks a list of log files if they changed recently and
+  alerts you if a file is older than the given limit.
+email:
+- g.visscher@core4.de
+executables:
+- log_timer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/log_timer
+- lib/log_timer.rb
+- lib/log_timer/log.rb
+- lib/log_timer/mailer.rb
+- lib/log_timer/version.rb
+- log_timer.gemspec
+homepage: https://github.com/CORE4/log_timer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Checks if log files have been changed recently
+test_files: []