autocronitor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d7879ba85bc3cbb42dfb0535bac49e5335fec6a
+  data.tar.gz: 9e72991e8ee4a2de7a364a5ac170fab01e50d4ab
+SHA512:
+  metadata.gz: b144187d9fd5324925930fdb0f5c81735e6cfd9ebcdca7f0249737253feea7c7cd7d8d0449deb928d41f88eb1ca40045467ade33248ec264ef44452f2aa293e2
+  data.tar.gz: 0b541146a3e5996425ed4599ef21987bcdbfae5d6ec4470d2fe1b9f57ec293f04a377e030734264c8212a2ba0ce1bde8dc39724e404c2eec425f98c209499e13

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.project
+*.gem

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Cowie
+
+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,62 @@
+# autocronitor
+
+A CLI tool to parse a standard format crontab file, create monitors in cronitor.io for each job, and automatically add the necessary curl commands to the original crontab.
+
+It assumes that you are using cronitor's "template" feature to configure notifications for your monitors, and that you have created templates which will then be passed to autocronitor.
+
+Please note, cronitor.io (and therefore autocronitor) do not support "informal" cron expressions such as ```@hourly``` or ```@daily```.
+## GEM INSTALL
+autocronitor is available on rubygems.org - if you have that source in your gemrc, you can simply use:
+
+````
+gem install autocronitor
+````
+
+Autocronitor Usage
+-----------
+You can run autocronitor by running the ```autocronitor``` command.
+
+#### Usage
+```bash
+Usage: autocronitor [-aft]
+
+Specific options:
+    -a, --api-key APIKEY             Your cronitor.io API key
+    -f, --filename FILENAME          The cron files to read
+
+Email Options: 
+    -t, --templace *TEMPLATES        The Cronitor.io templates to send alerts for this monitor to
+
+Text to exclude: 
+    -c, --common-text *COMMONTEXT    A space separated list of common text to exclude from cron names
+    -i, --common-include-text *COMMONINCLUDETEXT
+                                     A space separated list of common text to exclude from cron names (includes strings which contain each phrase)
+```
+
+* Mandatory Parameters (you must specify one or the other)
+  * -a, --api-key APIKEY             Your cronitor.io API key
+  * -f, --filename FILENAME          The crontab files to read
+  * -t, --templace *TEMPLATES        The Cronitor.io template(s) to use for notifications
+
+* Optional Parameters
+  * -c,  --common-text *COMMONTEXT   A space separated list of common text to exclude from cron names
+  * -i, --common-include-text *COMMONINCLUDETEXT    A space separated list of common text to exclude from cron names (includes strings which contain each phrase)
+
+
+#### Example)
+
+```text
+$> autocronitor -a abcdef123456 -f test.conf -t mydefault-template
+
+Processing file test.conf
+
+Cron expression: 10 * * * *
+Cron name: testcron
+Suggested rules:
+[{"rule_type"=>"ran_longer_than", "duration"=>1, "human_readable"=>"Ran for longer than 1 hour", "time_unit"=>"hours", "hours_to_followup_alert"=>24}, {"rule_type"=>"not_completed_in", "duration"=>61, "human_readable"=>"Has not received a complete ping in over 61 minutes", "time_unit"=>"minutes", "hours_to_followup_alert"=>24}]
+Creating monitor testcron...
+Monitor 'testcron' created with ID abc123
+
+Writing new test.conf with added Cronitor URLs...
+```
+

data/autocronitor.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'autocronitor'
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jon Cowie"]
+  gem.email         = 'jonlives@gmail.com'
+  gem.homepage      = 'https://github.com/jonlives/autocronitor'
+  gem.licenses      = ['MIT']
+  gem.summary       = "A tool to automatically pass a standard-format crontab file and add jobs to cronitor.io for monitoring"
+  gem.description   = "A CLI tool to parse a standard format crontab file, create monitors in cronitor.io for each job, and automatically add the necessary curl commands to the original crontab. It assumes that you are using cronitor's 'template' feature to configure notifications for your monitors, and that you have created templates which will then be passed to autocronitor. Please note, cronitor.io (and therefore autocronitor) do not support 'informal' cron expressions such as @hourly or @daily."
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'unirest', '~> 1.1', '>= 1.1.2'
+  gem.add_runtime_dependency 'choice', '~> 0.2', '>= 0.2.0'
+end

data/bin/autocronitor

@@ -0,0 +1,124 @@
+#! /usr/bin/env ruby
+require 'unirest'
+require 'choice'
+require 'autocronitor/helper'
+
+Unirest.default_header 'Accept', 'application/json'
+Unirest.default_header 'Content-Type', 'application/json'
+
+
+Choice.options do
+  header ''
+  header 'Specific options:'
+
+  option :api_key, :required => true do
+    short '-a'
+    long '--api-key APIKEY'
+    desc 'Your cronitor.io API key'
+  end
+
+  option :file_name, :required => true do
+    short '-f'
+    long '--filename FILENAME'
+    desc 'The cron files to read'
+  end
+
+  separator ''
+  separator 'Email Options: '
+
+  option :template_name, :required => true do
+    short '-t'
+    long '--templace *TEMPLATES'
+    desc 'The Cronitor.io templates to send alerts for this monitor to'
+  end
+
+  separator ''
+  separator 'Text to exclude: '
+
+  option :common_text do
+    short '-c'
+    long '--common-text *COMMONTEXT'
+    desc 'A space separated list of common text to exclude from cron names'
+  end
+
+  option :common_include_text do
+    short '-i'
+    long '--common-include-text *COMMONINCLUDETEXT'
+    desc 'A space separated list of common text to exclude from cron names (includes strings which contain each phrase)'
+  end
+end
+
+
+file_name = Choice[:file_name]
+api_key = Choice[:api_key]
+template_names = Choice[:template_name]
+
+# Filter common text out of cron_line so we don't produce an unreadable name
+common_text = Choice[:common_text]|| %w(SYMFONY_ENV=prod php 2>&1 && >> touch)
+common_text_include = Choice[:common_include_text]|| %w(/var/log /tmp)
+
+helper = Autocronitor::Helper.new(api_key)
+
+# This array will contain lines to be written back to the file
+new_file_lines = []
+
+# Check if the file name exists, and exit if not
+if !File.exists?(file_name)
+  puts "ERROR: File #{file_name} does not exist. Exiting."
+  exit 1
+else
+  puts "Processing file #{file_name}"
+  puts ""
+
+  # Read all lines from file
+  File.readlines(file_name).each do |line|
+
+    # Skip the current line if it's a comment
+    if line.include?("#") or line == "\n"
+      new_file_lines << line
+      next
+    end
+
+    # Split line by whitespace
+    split_line = line.split(/\s+/m)
+
+    # If we have an @ cron expression - eg @hourly, cronitor doesn't support those, so skip this line
+    if split_line.first.include?("@")
+      puts "Non standard '@' format cron expression detected, cannot create cronitor job. Skpping..."
+      next
+      # Otherwise, we have a standard cron expression, so extract it and the remainder of the line
+    else
+      cron_expression = split_line[0..4].join(" ")
+      remaining_line = split_line[5..-1]
+    end
+
+    # Filter out line segments which include text from the above arrays, then re-join the string
+    filtered_line = remaining_line.select{|segment| !common_text.include?(segment) and !common_text_include.any?{ |word| segment.include?(word) }}.map{|segment|segment.include?("/") ? segment.split("/").last : segment}.join(" ")
+
+    puts "Cron expression: #{cron_expression}"
+    puts "Cron name: #{filtered_line}"
+
+    # Talk to cronitor's suggest API to get auto-generated rules for our cron expression
+    rules = helper.monitor_suggest(cron_expression)
+    puts "Suggested rules:"
+    puts rules.inspect
+
+    # Create a new monitor via cronitor's API with the name and rules we've created
+    puts "Creating monitor #{filtered_line}..."
+    monitor_id = helper.monitor_create(filtered_line,rules,template_names)
+    monitor_url = "#{@monitor_url}/#{monitor_id}"
+
+    # Construct the replacement line to be written back to the file
+    cronitored_line = "#{cron_expression} curl #{monitor_url + '/run'} -m 10 && #{remaining_line.join(" ")} && curl #{monitor_url + '/complete'} -m 10"
+    new_file_lines << cronitored_line
+    puts ""
+  end
+
+  puts "Writing new #{file_name} with added Cronitor URLs..."
+  open(file_name, 'w') { |f|
+    new_file_lines.each do |line|
+      f.puts line
+    end
+  }
+
+end

data/lib/autocronitor/helper.rb

@@ -0,0 +1,61 @@
+require 'unirest'
+
+require 'ipecache/plugins'
+
+module Autocronitor
+  class Helper
+
+    def initialize(api_key)
+      @monitor_template = {
+          name: '',
+          notifications: {
+          emails: [],
+          slack: [],
+          pagerduty: [],
+          phones: [],
+          webhooks: [],
+          templates: [],
+      },
+          rules: [
+      ],
+          note: 'A human-friendly description of this monitor'
+      }
+
+      @api_url = 'https://cronitor.io/v1'
+      @monitor_url = 'https://cronitor.link'
+      @monitor_details = {}
+      @api_key = api_key
+    end
+
+    def monitor_create(monitor_name,rules,template_names)
+      @monitor_template[:name] = monitor_name
+      @monitor_template[:rules] = rules
+      @monitor_template[:notifications][:templates] = rules.kind_of?(Array) ? template_names : [template_names]
+
+      response = Unirest.post(
+          "#{@api_url}/monitors",
+          auth: { user: @api_key },
+          parameters: @monitor_template.to_json
+      )
+
+      monitor_id = response.body["code"]
+      if response.code == 201
+        puts "Monitor '#{monitor_name}' created with ID #{monitor_id}"
+      else
+        puts "Error code: #{response.code} returned, exiting"
+        exit 1
+      end
+      @monitor_details[monitor_name] = monitor_id
+      return "#{@monitor_url}/#{monitor_id}"
+    end
+
+    def monitor_suggest(cron_expression)
+      response = Unirest.get(
+          "#{@api_url}/rules/suggest",
+          auth: { user: @api_key },
+          parameters:{ 'cron-expression' => cron_expression }
+      )
+      return response.body
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: autocronitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Cowie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: A CLI tool to parse a standard format crontab file, create monitors in
+  cronitor.io for each job, and automatically add the necessary curl commands to the
+  original crontab. It assumes that you are using cronitor's 'template' feature to
+  configure notifications for your monitors, and that you have created templates which
+  will then be passed to autocronitor. Please note, cronitor.io (and therefore autocronitor)
+  do not support 'informal' cron expressions such as @hourly or @daily.
+email: jonlives@gmail.com
+executables:
+- autocronitor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- autocronitor.gemspec
+- bin/autocronitor
+- lib/autocronitor/helper.rb
+homepage: https://github.com/jonlives/autocronitor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A tool to automatically pass a standard-format crontab file and add jobs
+  to cronitor.io for monitoring
+test_files: []
+has_rdoc: