lita-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4dd851e5cdba74c0ed101f678eb7e047bc51c6f
+  data.tar.gz: 719ed64a1e3a628884b9a66e73b968bbfe5d7463
+SHA512:
+  metadata.gz: 36d77bf75181b61bbf202136c4b75628ce66827b258a16b615b15161ec620d1302741af174b38cf97d6f1ec596c5c41ca17727872496bc5c5543c8043bf85e52
+  data.tar.gz: e5799ba8e53eff76198b1c8f4cae47dc7bee400a2859f9204dc384304900de36eb087cc956353449045881e7e1cd04c574d0065d6d1cd8fb6fcad58e76921eee

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.2
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "lita", github: "jimmycuadra/lita", ref: "d15f6f0ca95be03a4c76802af19b1a532c61eabc"

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Tristan Chong
+
+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,67 @@
+# lita-metrics
+
+[![Build Status](https://travis-ci.org/PagerDuty/lita-metrics.png?branch=master)](https://travis-ci.org/PagerDuty/lita-metrics)
+[![Coverage Status](https://coveralls.io/repos/PagerDuty/lita-metrics/badge.png)](https://coveralls.io/r/PagerDuty/lita-metrics)
+
+**lita-metrics** is a handler for [Lita](https://github.com/jimmycuadra/lita) that keeps track of Lita usage metrics (e.g. users, rooms, handlers and methods triggered) using [Datadog](http://www.datadoghq.com/). It also logs messages that match valid chat routes, as well as attempted commands that failed to trigger any handlers.
+
+## Installation
+
+Add lita-metrics to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-metrics"
+```
+
+## Configuration
+
+### Optional attributes
+* `statsd_host` - Your Statsd server's address. Default: `'localhost'`
+* `statsd_port`- Your Statsd server's port. Default: `8125`
+* `valid_command_logger` - [Logger options](http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html#label-How+to+create+a+logger) for recording messages that match routes. Default: `STDOUT`
+* `invalid_command_logger` - Logger options for recording failed commands. Default: `STDOUT`
+* `valid_command_metric` - The name of the valid message counter to be incremented in Datadog. Default: `'lita.commands.valid'`
+* `invalid_command_metric` - The name of the invalid command counter to be incremented in Datadog. Default: `'lita.commands.invalid'`
+* `log_fields` - Fields to include in the logs; possible options are listed below. Default: `[:user, :room, :message]`
+  * `:user` - ID of the user who sent the message
+  * `:room` - ID of the room in which the message was sent
+  * `:message` - The message text
+  * `:command` - A boolean indicating whether the message was a command
+  * `:handler` - The name of the handler invoked. Not available for invalid commands
+  * `:method` - The name of the handler method invoked. Not available for invalid commands
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.metrics.statsd_host = 'localhost'
+  config.handlers.metrics.statsd_port = 8125
+  config.handlers.metrics.valid_command_logger = '/var/log/lita/messages.log', 'daily'
+  config.handlers.metrics.invalid_command_logger = '/var/log/lita/attempted_commands.log', 10, 1024000
+  config.handlers.metrics.valid_command_metric = 'lita.messages.all'
+  config.handlers.metrics.invalid_command_metric = 'lita.messages.failed'
+  config.handlers.metrics.log_fields = [:user, :handler, :message]
+end
+```
+
+## Usage
+
+Once the handler is configured, it will record metrics and logs without needing to be invoked explicitly by any commands. For example, if I send the command `/r/chatops` and [lita-snoo](https://github.com/tristaneuan/lita-snoo) is installed, the StatsD server will receive this:
+```
+lita.commands.valid:1|c|#user:1,private_message:false,command:true,room:shell,handler:Lita::Handlers::Snoo,method:subreddit
+```
+...and the log might look like this:
+```
+I, [2015-08-21T17:45:33.761986 #81678]  INFO -- : 1,shell,/r/chatops
+```
+
+If I send the command `foo` and there is no handler installed that recognizes it, the StatsD server will receive this:
+```
+lita.commands.invalid:1|c|#user:1,private_message:false,command:true,room:shell
+```
+...and the log might look like this:
+```
+I, [2015-08-24T16:40:25.726132 #45705]  INFO -- : 1,shell,foo
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

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

data/lib/lita-metrics.rb

@@ -0,0 +1,16 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'csv'
+require 'logger'
+require 'statsd'
+
+require 'lita/handlers/metrics'
+
+Lita::Handlers::Metrics.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+ __FILE__
+)

data/lib/lita/handlers/metrics.rb

@@ -0,0 +1,88 @@
+module Lita
+  module Handlers
+    class Metrics < Handler
+      class << self
+        attr_accessor :statsd
+        attr_accessor :valid_command_log
+        attr_accessor :invalid_command_log
+      end
+
+      config :statsd_host, type: String, default: 'localhost'
+      config :statsd_port, type: Integer, default: 8125
+      config :valid_command_logger, default: STDOUT
+      config :invalid_command_logger, default: STDOUT
+      config :valid_command_metric, type: String, default: 'lita.commands.valid'
+      config :invalid_command_metric, type: String, default: 'lita.commands.invalid'
+      config :log_fields, default: [:user, :room, :message]
+
+      on :loaded, :setup
+      on :message_dispatched, :valid_command
+      on :unhandled_message, :invalid_command
+
+      def setup(_payload)
+        self.class.statsd = Statsd.new(config.statsd_host, config.statsd_port)
+        self.class.valid_command_log = ::Logger.new(*arrayize(config.valid_command_logger))
+        self.class.invalid_command_log = ::Logger.new(*arrayize(config.invalid_command_logger))
+      end
+
+      def valid_command(payload)
+        fields = extract_fields(payload)
+
+        self.class.statsd.increment(
+          config.valid_command_metric,
+          tags: fields.each.select { |k, v| k != :message }.map { |k, v| "#{k}:#{v}" }
+        )
+
+        self.class.valid_command_log.info(format_log(fields)) unless fields[:private_message]
+      end
+
+      def invalid_command(payload)
+        fields = extract_fields(payload)
+
+        return unless fields[:command]
+
+        self.class.statsd.increment(
+          config.invalid_command_metric,
+          tags: fields.each.select { |k, v| k != :message }.map { |k, v| "#{k}:#{v}" }
+        )
+
+        self.class.invalid_command_log.info(format_log(fields)) unless fields[:private_message]
+      end
+
+      private
+
+      def arrayize(arg)
+        arg.is_a?(Array) ? arg : [arg]
+      end
+
+      def extract_fields(payload)
+        m = payload[:message]
+
+        fields = {
+          message: m.body,
+          user: m.user.id,
+          private_message: m.source.private_message?,
+          command: m.command?
+        }
+
+        fields[:room] = m.source.room_object.id unless fields[:private_message]
+
+        h = payload[:handler]
+        r = payload[:route]
+
+        return fields if h.nil? && r.nil?
+
+        fields[:handler] = h.name
+        fields[:method] = r.callback.method_name || '(block)'
+
+        fields
+      end
+
+      def format_log(fields)
+        CSV.generate_line(arrayize(config.log_fields).each.map { |x| fields[x] }).chomp
+      end
+    end
+
+    Lita.register_handler(Metrics)
+  end
+end

data/lita-metrics.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-metrics"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tristan Chong"]
+  spec.email         = ["tristan@pagerduty.com"]
+  spec.description   = "A Lita handler that tracks Lita usage metrics."
+  spec.summary       = "A Lita handler that tracks Lita usage metrics."
+  spec.homepage      = "https://github.com/PagerDuty/lita-metrics"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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_runtime_dependency "lita", ">= 4.5"
+  spec.add_runtime_dependency "dogstatsd-ruby", "~> 1.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      metrics:

data/spec/lita/handlers/metrics_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Metrics, lita_handler: true do
+  let(:test_handler) do
+    Class.new do
+      extend Lita::Handler::ChatRouter
+
+      def self.name
+        'Lita::Handlers::Test'
+      end
+
+      route(/message/, :test_message)
+      route(/command/, :test_command, command: true)
+
+      def test_message(response)
+        response.reply('message')
+      end
+
+      def test_command(response)
+        response.reply('command')
+      end
+
+      route(/block/) do |response|
+        response.reply('block')
+      end
+    end
+  end
+
+  let(:john) do
+    Lita::User.create('U1234ABCD', name: 'John', mention_name: 'john')
+  end
+
+  let(:general) do
+    Lita::Room.create_or_update('C1234567890', name: 'general')
+  end
+
+  before do
+    robot.trigger(:loaded)
+    registry.register_handler(test_handler)
+  end
+
+  it { is_expected.to route_event(:message_dispatched).to(:valid_command) }
+  it { is_expected.to route_event(:unhandled_message).to(:invalid_command) }
+
+  describe '#valid_command' do
+    describe 'statsd' do
+      it 'increments the valid command counter for messages that match a route' do
+        expect(described_class.statsd).to receive(:increment).with(
+          'lita.commands.valid',
+          tags: [
+            'user:U1234ABCD',
+            'private_message:false',
+            'command:false',
+            'room:C1234567890',
+            'handler:Lita::Handlers::Test',
+            'method:test_message'
+          ]
+        )
+        send_message('message', as: john, from: general)
+      end
+
+      it 'counts blocks correctly' do
+        expect(described_class.statsd).to receive(:increment).with(
+          'lita.commands.valid',
+          tags: [
+            'user:U1234ABCD',
+            'private_message:false',
+            'command:false',
+            'room:C1234567890',
+            'handler:Lita::Handlers::Test',
+            'method:(block)'
+          ]
+        )
+        send_message('block', as: john, from: general)
+      end
+
+      it 'allows the valid command metric name to be configured' do
+        registry.config.handlers.metrics.valid_command_metric = 'lita.messages.all'
+        expect(described_class.statsd).to receive(:increment).with(
+          'lita.messages.all',
+          tags: anything
+        )
+        send_command('command', as: john, from: general)
+      end
+    end
+
+    describe 'logger' do
+      it 'logs messages that match a route' do
+        expect(described_class.valid_command_log).to receive(:info).with('U1234ABCD,C1234567890,message')
+        send_message('message', as: john, from: general)
+      end
+
+      it 'does not log messages that do not match a route' do
+        expect(described_class.valid_command_log).not_to receive(:info)
+        send_message('foo', as: john, from: general)
+      end
+
+      it 'does not log commands that do not match a route' do
+        expect(described_class.valid_command_log).not_to receive(:info)
+        send_command('foo', as: john, from: general)
+      end
+
+      it 'does not log private messages' do
+        expect(described_class.valid_command_log).not_to receive(:info)
+        send_message('message', as: john, privately: true)
+      end
+    end
+  end
+
+  describe '#invalid_command' do
+    describe 'statsd' do
+      it 'increments the invalid command counter for commands that do not match a route' do
+        expect(described_class.statsd).to receive(:increment).with(
+          'lita.commands.invalid',
+          tags: [
+            'user:U1234ABCD',
+            'private_message:false',
+            'command:true',
+            'room:C1234567890'
+          ]
+        )
+        send_command('foo', as: john, from: general)
+      end
+
+      it 'does not increment the invalid command counter for messages that do not match a route' do
+        expect(described_class.statsd).not_to receive(:increment).with(
+          'lita.commands.invalid',
+          tags: anything
+        )
+        send_message('foo', as: john, from: general)
+      end
+
+      it 'allows the invalid command metric name to be configured' do
+        registry.config.handlers.metrics.invalid_command_metric = 'lita.messages.failed'
+        expect(described_class.statsd).to receive(:increment).with(
+          'lita.messages.failed',
+          tags: anything
+        )
+        send_command('foo', as: john, from: general)
+      end
+    end
+
+    describe 'logger' do
+      it 'logs unhandled commands' do
+        expect(described_class.invalid_command_log).to receive(:info).with('U1234ABCD,C1234567890,foo')
+        send_command('foo', as: john, from: general)
+      end
+
+      it 'does not log unhandled messages that are not commands' do
+        expect(described_class.invalid_command_log).not_to receive(:info)
+        send_message('foo', as: john, from: general)
+      end
+
+      it 'does not log unhandled commands sent as private messages' do
+        expect(described_class.invalid_command_log).not_to receive(:info)
+        send_command('foo', as: john, privately: true)
+      end
+
+      it 'allows the log fields to be configured' do
+        registry.config.handlers.metrics.log_fields = :message
+        expect(described_class.invalid_command_log).to receive(:info).with('foo')
+        send_command('foo', as: john, from: general)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-metrics"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lita-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tristan Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.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: pry-byebug
+  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: 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: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: A Lita handler that tracks Lita usage metrics.
+email:
+- tristan@pagerduty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-metrics.rb
+- lib/lita/handlers/metrics.rb
+- lita-metrics.gemspec
+- locales/en.yml
+- spec/lita/handlers/metrics_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/PagerDuty/lita-metrics
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.5
+signing_key: 
+specification_version: 4
+summary: A Lita handler that tracks Lita usage metrics.
+test_files:
+- spec/lita/handlers/metrics_spec.rb
+- spec/spec_helper.rb