appsignal_report 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4d4507b1ca8ebdd01e7cb9f06ce189d3c93c7e8
-  data.tar.gz: bce40d5abece6bcb5be025ac195e12120112ee79
+  metadata.gz: c8508bab60307495cb9596feb78d732807fedbb6
+  data.tar.gz: e73a769860e794be7b8778f2e2bb22ef4bef657d
 SHA512:
-  metadata.gz: dca3d06438a1bd3678f0ff2aedad71abf4b6fed262231c772cb1c431f29260e84133ec4433aa0f86d8a05141143b54f440d585380e6a43505a5351907f0f733c
-  data.tar.gz: 5109060c35dd4d591a4ed1bb575305687b35f71bda09d1da40f03ab1284235f6f4a853460fedb6a8de5489e9ad3f44342d2bfa0a2551c6d30f3f02ade3b5bc2e
+  metadata.gz: 1043721a87de2856a24660357e9485acdda70cbf392a1ed2e2fb983695c980138679abcd634034d6ae09af57bbabb77e4536b707c0cf008d9489d72c4c5e2a36
+  data.tar.gz: 0bca2b97f7f11aac1b60d34d61ecf44e3ade22593a7ae6651aae47b5df6eabdc1470df95aef86d2a62f83d6e35066db96c2e092d72b3e765b1f5cda5abb4b5e5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 0.1.1
+_August 21st 2017_
+
+- refactored executables to share runner/options code
+- display throughput resolution provided by AppSignal
+
 ### 0.1.0
 _August 14th, 2017_
 

data/README.md

@@ -6,8 +6,51 @@ Elixir applications.
 
 ## Status
 
+[![Gem Version](https://badge.fury.io/rb/appsignal_report.svg)](https://badge.fury.io/rb/appsignal_report)
 [![Build Status](https://travis-ci.org/dsager/appsignal_report.svg?branch=master)](https://travis-ci.org/dsager/appsignal_report)
 
+## Usage
+
+Use `gem install appsignal_report` to get `appsignal_report` (or add 
+`gem 'appsignal_report'` to your Gemfile). That will provide two executables
+`appsignal_report_deploy` and `appsignal_report_weekly`, they both support
+the same set of options:
+
+```
+$ appsignal_report_deploy -h
+Usage: APPSIGNAL_API_TOKEN=XXX ./bin/appsignal_report_deploy [options]
+
+Specific options:
+    -i, --app-id ID                  Specify Appsignal App Id
+    -n, --app-name NAME              Specify a name for the Appsignal App
+    -s, --slack WEBHOOK_URL          Post the report to a Slack Webhook
+
+Common options:
+    -h, --help                       Show this message
+```
+
+The option `--app-id` is the only required one, by default the tool will
+output the report data in JSON format to STDOUT. 
+
+## Posting to Slack
+
+`appsignal_report` supports posting formatted messages about the report 
+to Slack, instead of printing the raw report data. To do so, you need to 
+provide the URL of a 
+[Slack webhook](https://api.slack.com/custom-integrations/incoming-webhooks) 
+using the CLI option `--slack`:
+
+```
+$ APPSIGNAL_API_TOKEN=XXX ./bin/appsignal_report_weekly \
+  -app-id XYZ123 \
+  -app-name 'back-end' \
+  -slack https://hooks.slack.com/services/X/Y/Z
+```
+
+This is an example of how the post looks on Slack:
+
+![Slack Post Example](img/slack-post.png?raw=true "Slack Post Example")
+
 ## Reports
 
 Currently the gem supports two kinds of reports, a deploy report and a weekly
@@ -25,25 +68,24 @@ This only works if you are using AppSignal's
 [deploy markers](https://docs.appsignal.com/push-api/deploy-marker.html) to
 record your deployments.
 
-### Usage
+### Example
 
 ```
-$ gem install appsignal_report
-$ APPSIGNAL_API_TOKEN=ABC123 appsignal_report_deploy -i XYZ456
 {
   "title": "AppSignal Deploy Report",
   "last_deploy_time": "2017-08-10 09:47:52 UTC",
+  "resolution": "minutely",
   "before": {
     "data_points": 62,
     "error_rate": 0.4675038958657989,
     "response_time": 94.9387856438841,
-    "hourly_throughput": 32727
+    "throughput": 32727
   },
   "after": {
     "data_points": 62,
     "error_rate": 0.0733371596199222,
     "response_time": 56.71109484008057,
-    "hourly_throughput": 31362
+    "throughput": 31362
   },
   "data_samples_from": "2017-08-10 08:47:00 UTC",
   "data_samples_to": "2017-08-10 10:48:00 UTC",
@@ -52,14 +94,14 @@ $ APPSIGNAL_API_TOKEN=ABC123 appsignal_report_deploy -i XYZ456
     "error_rate_pct": -0.8431303775894644,
     "response_time": -38.22769080380353,
     "response_time_pct": -0.40265620151489834,
-    "hourly_throughput": -1365,
-    "hourly_throughput_pct": -0.041708680905674214
+    "throughput": -1365,
+    "throughput_pct": -0.041708680905674214
   },
   "messages": {
     "info": "The deploy finished at 2017-08-10 09:47:52 UTC",
     "error_rate": "The error rate decreased by 0.39% (from 0.47% to 0.07%, that is a change of -84.31%).",
     "response_time": "The response time decreased by 38.23ms (from 94.94ms to 56.71ms, that is a change of -40.27%).",
-    "hourly_throughput": "The hourly throughput decreased by 1365.0 req/h (from 32727.0 req/h to 31362.0 req/h, that is a change of -4.17%)."
+    "throughput": "The hourly throughput decreased by 1365.0 req/m (from 32727.0 req/m to 31362.0 req/m, that is a change of -4.17%)."
   }
 }
 ```
@@ -70,27 +112,26 @@ The weekly report pulls metrics for the last two weeks. Based on these metrics
 it calculates changes in response time, error rate and throughput, comparing one 
 week to the other.
 
-### Usage
+### Example
 
 ```
-$ gem install appsignal_report
-$ APPSIGNAL_API_TOKEN=ABC123 appsignal_report_weekly -i XYZ456
 {
   "title": "AppSignal Weekly Report",
   "now": "2017-08-14 13:19:15 UTC",
   "one_week_ago": "2017-08-07 13:19:15 UTC",
   "two_weeks_ago": "2017-07-31 13:19:15 UTC",
+  "resolution": "hourly",
   "before": {
     "data_points": 168,
     "error_rate": 0.19637939102939866,
     "response_time": 74.6427894180237,
-    "hourly_throughput": 34611.166666666664
+    "throughput": 34611.166666666664
   },
   "after": {
     "data_points": 168,
     "error_rate": 0.06227341986188213,
     "response_time": 61.364840452820985,
-    "hourly_throughput": 30819.684523809523
+    "throughput": 30819.684523809523
   },
   "data_samples_from": "2017-07-31 14:00:00 UTC",
   "data_samples_to": "2017-08-14 13:00:00 UTC",
@@ -99,14 +140,14 @@ $ APPSIGNAL_API_TOKEN=ABC123 appsignal_report_weekly -i XYZ456
     "error_rate_pct": -0.6828922855119783,
     "response_time": -13.277948965202711,
     "response_time_pct": -0.17788655901967856,
-    "hourly_throughput": -3791.4821428571413,
-    "hourly_throughput_pct": -0.1095450546169726
+    "throughput": -3791.4821428571413,
+    "throughput_pct": -0.1095450546169726
   },
   "messages": {
     "info": "Comparing the weeks 2017-07-31-2017-08-07 and 2017-08-07-2017-08-14.",
     "error_rate": "The error rate decreased by 0.13% (from 0.2% to 0.06%, that is a change of -68.29%).",
     "response_time": "The response time decreased by 13.28ms (from 74.64ms to 61.36ms, that is a change of -17.79%).",
-    "hourly_throughput": "The hourly throughput decreased by 3791.48 req/h (from 34611.17 req/h to 30819.68 req/h, that is a change of -10.95%)."
+    "throughput": "The hourly throughput decreased by 3791.48 req/h (from 34611.17 req/h to 30819.68 req/h, that is a change of -10.95%)."
   }
 }
 ```
@@ -125,9 +166,17 @@ application. If you look at the example URL
 `appsignal.com/devex/sites/XYZ456/web/exceptions`, the application ID is 
 `XYZ456`.
 
+### How do I set up a Slack webhook?
+
+Go to this [page](https://my.slack.com/services/new/incoming-webhook) to set up
+a Slack webhook. You can specify some settings like user name or an avatar, and
+should be provided a webhook URL in the format of 
+`https://hooks.slack.com/services/ABC/123/XYZ`.
+
 ## Maintainer
 
-[Daniel Sager](https://github.com/dsager)
+- [Devex](https://github.com/orgs/Devex) 
+- [Daniel Sager](https://github.com/dsager)
 
 ## Contributing
 

data/bin/appsignal_report_deploy

@@ -18,55 +18,12 @@
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 require 'appsignal_report'
-require 'optparse'
 
-options = { slack_webhook: nil, app_id: nil, app_name: nil }
-parser = OptionParser.new do |parser|
-  parser.banner =
-    'Usage: APPSIGNAL_API_TOKEN=XXX ./bin/appsignal_report_deploy [options]'
-  parser.separator ''
-  parser.separator 'Specific options:'
-  parser.on('-i ID',
-            '--app-id ID',
-            String,
-            'Specify Appsignal App Id') do |id|
-    options[:app_id] = id
-  end
-  parser.on('-n NAME',
-            '--app-name NAME',
-            String,
-            'Specify a name for the Appsignal App') do |name|
-    options[:app_name] = name
-  end
-  parser.on('-s WEBHOOK_URL',
-            '--slack WEBHOOK_URL',
-            String,
-            'Post the report to a Slack Webhook') do |url|
-    options[:slack_webhook] = url
-  end
-  parser.separator ''
-  parser.separator 'Common options:'
-  parser.on_tail('-h', '--help', 'Show this message') do
-    puts parser
-    exit
-  end
-end
-parser.parse!
+option_parser = AppsignalReport::CLI::OptionParser
+  .new(type: :deploy, api_token: ENV['APPSIGNAL_API_TOKEN'])
 
-report = AppsignalReport::DeployReport.new(
-  api_token: ENV['APPSIGNAL_API_TOKEN'],
-  app_id: options[:app_id],
-  app_name: options[:app_name]
-)
+option_parser.parse
 
-report.generate
-
-unless options[:slack_webhook].nil?
-  message = AppsignalReport::SlackMessage.new(
-    report: report,
-    webhook_url: options[:slack_webhook]
-  )
-  puts message.post
-else
-  puts report.report.to_json
-end
+AppsignalReport::CLI::Runner
+  .new(option_parser.options)
+  .run

data/bin/appsignal_report_weekly

@@ -15,55 +15,12 @@
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 require 'appsignal_report'
-require 'optparse'
 
-options = { slack_webhook: nil, app_id: nil, app_name: nil }
-parser = OptionParser.new do |parser|
-  parser.banner =
-    'Usage: APPSIGNAL_API_TOKEN=XXX ./bin/appsignal_report_weekly [options]'
-  parser.separator ''
-  parser.separator 'Specific options:'
-  parser.on('-i ID',
-            '--app-id ID',
-            String,
-            'Specify Appsignal App Id') do |id|
-    options[:app_id] = id
-  end
-  parser.on('-n NAME',
-            '--app-name NAME',
-            String,
-            'Specify a name for the Appsignal App') do |name|
-    options[:app_name] = name
-  end
-  parser.on('-s WEBHOOK_URL',
-            '--slack WEBHOOK_URL',
-            String,
-            'Post the report to a Slack Webhook') do |url|
-    options[:slack_webhook] = url
-  end
-  parser.separator ''
-  parser.separator 'Common options:'
-  parser.on_tail('-h', '--help', 'Show this message') do
-    puts parser
-    exit
-  end
-end
-parser.parse!
+option_parser = AppsignalReport::CLI::OptionParser
+  .new(type: :weekly, api_token: ENV['APPSIGNAL_API_TOKEN'])
 
-report = AppsignalReport::WeeklyReport.new(
-  api_token: ENV['APPSIGNAL_API_TOKEN'],
-  app_id: options[:app_id],
-  app_name: options[:app_name]
-)
+option_parser.parse
 
-report.generate
-
-unless options[:slack_webhook].nil?
-  message = AppsignalReport::SlackMessage.new(
-    report: report,
-    webhook_url: options[:slack_webhook]
-  )
-  puts message.post
-else
-  puts report.report.to_json
-end
+AppsignalReport::CLI::Runner
+  .new(option_parser.options)
+  .run

data/lib/appsignal_report/base_report.rb

@@ -37,13 +37,14 @@ module AppsignalReport
 
     def process_metrics
       api_response = perform_api_request(metrics_uri)
+      @report[:resolution] = api_response[:resolution]
       data = balance_samples(gather_samples(api_response[:data]))
       %i(before after).each do |key|
         @report[key] = {
           data_points: data[key].size,
           error_rate: get_average(data[key], :ex_rate),
           response_time: get_average(data[key], :mean),
-          hourly_throughput: get_average(data[key], :count),
+          throughput: get_average(data[key], :count),
         }
       end
       @report.merge!(
@@ -60,7 +61,8 @@ module AppsignalReport
         info: info_message,
         error_rate: metric_message(:error_rate, '%'),
         response_time: metric_message(:response_time, 'ms'),
-        hourly_throughput: metric_message(:hourly_throughput, ' req/h'),
+        throughput: metric_message(:throughput,
+                                   " req/#{@report[:resolution][0]}"),
       }
     end
 
@@ -91,8 +93,8 @@ module AppsignalReport
         error_rate_pct: pct_diff(:error_rate),
         response_time: abs_diff(:response_time),
         response_time_pct: pct_diff(:response_time),
-        hourly_throughput: abs_diff(:hourly_throughput),
-        hourly_throughput_pct: pct_diff(:hourly_throughput),
+        throughput: abs_diff(:throughput),
+        throughput_pct: pct_diff(:throughput),
       }
     end
 

data/lib/appsignal_report/cli/option_parser.rb

@@ -0,0 +1,56 @@
+module AppsignalReport
+  module CLI
+    class OptionParser
+      def initialize(additional_options = {})
+        @additional_options = additional_options
+      end
+
+      def parse
+        option_parser.parse!
+      end
+
+      def options
+        @options ||= {
+          slack_webhook: nil,
+          app_id: nil,
+          app_name: nil,
+        }.merge(@additional_options)
+      end
+
+      private
+
+      def option_parser
+        ::OptionParser.new do |parser|
+          parser.banner =
+            'Usage: APPSIGNAL_API_TOKEN=XXX ./bin/appsignal_report_* [options]'
+          parser.separator ''
+          parser.separator 'Specific options:'
+          parser.on('-i ID',
+                    '--app-id ID',
+                    String,
+                    'Specify Appsignal App Id') do |id|
+            options[:app_id] = id
+          end
+          parser.on('-n NAME',
+                    '--app-name NAME',
+                    String,
+                    'Specify a name for the Appsignal App') do |name|
+            options[:app_name] = name
+          end
+          parser.on('-s WEBHOOK_URL',
+                    '--slack WEBHOOK_URL',
+                    String,
+                    'Post the report to a Slack Webhook') do |url|
+            options[:slack_webhook] = url
+          end
+          parser.separator ''
+          parser.separator 'Common options:'
+          parser.on_tail('-h', '--help', 'Show this message') do
+            puts parser
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal_report/cli/runner.rb

@@ -0,0 +1,50 @@
+module AppsignalReport
+  module CLI
+    class Runner
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def run
+        report.generate
+        options[:slack_webhook] ? post_to_slack : print_json
+      end
+
+      def report
+        @report ||= report_class.new(
+          api_token: options[:api_token],
+          app_id: options[:app_id],
+          app_name: options[:app_name]
+        )
+      end
+
+      private
+
+      def report_class
+        case options[:type]
+        when :deploy
+          AppsignalReport::DeployReport
+        when :weekly
+          AppsignalReport::WeeklyReport
+        else
+          raise ArgumentError, "invalid report type: '#{options[:type]}'"
+        end
+      end
+
+
+      def print_json
+        puts report.report.to_json
+      end
+
+      def post_to_slack
+        message = AppsignalReport::SlackMessage.new(
+          report: report,
+          webhook_url: options[:slack_webhook]
+        )
+        puts message.post
+      end
+    end
+  end
+end

data/lib/appsignal_report/slack_message.rb

@@ -36,7 +36,7 @@ module AppsignalReport
         ":information_source: #{report.report[:messages][:info]}",
         "#{error_rate_icon} #{report.report[:messages][:error_rate]}",
         "#{response_time_icon} #{report.report[:messages][:response_time]}",
-        "#{throughput_icon} #{report.report[:messages][:hourly_throughput]}",
+        "#{throughput_icon} #{report.report[:messages][:throughput]}",
       ]
     end
 
@@ -50,11 +50,7 @@ module AppsignalReport
 
     def throughput_icon
       up_down =
-        if report.report[:diff][:hourly_throughput].negative?
-          'downwards'
-        else
-          'upwards'
-        end
+        report.report[:diff][:throughput].negative? ? 'downwards' : 'upwards'
       ":chart_with_#{up_down}_trend:"
     end
   end

data/lib/appsignal_report/version.rb

@@ -1,3 +1,3 @@
 module AppsignalReport
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/appsignal_report.rb

@@ -2,9 +2,12 @@ require 'uri'
 require 'net/http'
 require 'json'
 require 'time'
+require 'optparse'
 
 require_relative 'appsignal_report/version'
 require_relative 'appsignal_report/base_report'
 require_relative 'appsignal_report/weekly_report'
 require_relative 'appsignal_report/deploy_report'
 require_relative 'appsignal_report/slack_message'
+require_relative 'appsignal_report/cli/option_parser'
+require_relative 'appsignal_report/cli/runner'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appsignal_report
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Sager
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,8 @@ files:
 - bin/appsignal_report_weekly
 - lib/appsignal_report.rb
 - lib/appsignal_report/base_report.rb
+- lib/appsignal_report/cli/option_parser.rb
+- lib/appsignal_report/cli/runner.rb
 - lib/appsignal_report/deploy_report.rb
 - lib/appsignal_report/slack_message.rb
 - lib/appsignal_report/version.rb
@@ -77,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Useful reports around your AppSignal metrics