mozart-logger 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7c63bb92a60380465f491c0d7d2208ed5145464
+  data.tar.gz: ffcf8f0062eb557e4b55457d062557d7236091ed
+SHA512:
+  metadata.gz: 21425e38edf06ee63c3eeabf009179e7d7c566ef3f15fd8e404dac86a16f0ef609c3905e063d539be87ac16d298790210a3b8d5e1b08244f35a9686c2cd44662
+  data.tar.gz: dcb680da53ab6e82da137c7756ed1d0e527a29e4568983955d56b26b303da752daf7cb8a290ad79c98240bc32cfc2d8f3c2c9bd2e156b9e8b077e18d1933a171

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+app.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+# Mozart::Logger
+
+Private gem for setting up structured logging and metrics for use within our Mozart service applications.
+
+It is an abstraction wrapping around our open-source software [Alephant Logger](https://github.com/BBC-News/alephant-logger).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :production do
+  gem "mozart-logger", "1.0.0", :git => "git@github.com:bbc/mozart-logger.git"
+end
+```
+
+> Note: this is a private gem published to  
+> https://gemstore.news.tools.bbc.co.uk/nexus  
+
+And then execute:
+
+    $ bundle install
+
+## Setup
+
+```rb
+require "mozart/logger"
+
+opts = {
+  :statsd => {
+    :host      => ENV["STATSD_HOST"],
+    :port      => 8125,
+    :namespace => "mozart-routing"
+  },
+  :cloudwatch => {
+    :namespace => ENV["CLOUDWATCH_NAMESPACE"]
+  }
+}
+
+Mozart::Logger.setup opts, ENV["APP_LOG_LOCATION"] # configures Alephant Logger
+
+use Rack::CommonLogger, Alephant::Logger.get_logger # optional
+```
+
+> Note: you should only provide one key  
+> either `:statsd` or `:cloudwatch`  
+> the latter will be ignored if both provided
+
+## Usage
+
+```rb
+require "alephant/logger"
+
+class Foo
+  include include Alephant::Logger
+
+  def initialize
+    logger.info(
+      "event"   => "ClassInitialized",
+      "method"  => "#{self.class.name}##{__method__}",
+      "someKey" => 123
+    )
+  end
+end
+```
+
+> Note: for more details, refer to the following gems  
+> [Alephant-Logger-CloudWatch](https://github.com/BBC-News/alephant-logger-cloudwatch), [Alephant-Logger-Statsd](https://github.com/BBC-News/alephant-logger-statsd/) and [Alephant-Logger-JSON](https://github.com/BBC-News/alephant-logger-json)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,8 @@
+# rubocop:disable InlineComment
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mozart/logger"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mozart/logger.rb

@@ -0,0 +1,48 @@
+require "mozart/logger/version"
+require "alephant/logger"
+require "alephant/logger/json"
+require "alephant/logger/statsd"
+require "alephant/logger/cloudwatch"
+require "bbc/cosmos/config"
+
+module Mozart
+  module Logger
+    def self.setup(opts, log_path)
+      Alephant::Logger.setup drivers(opts, log_path)
+    end
+
+    def self.drivers(opts, log_path)
+      [].tap do |drivers|
+        drivers << json_driver(log_path)
+        drivers << metric_driver(opts)
+      end
+    end
+
+    def self.metric_driver(opts)
+      return statsd_driver(opts[:statsd])  if opts[:statsd]
+      cloudwatch_driver(opts[:cloudwatch]) if opts[:cloudwatch] && production?
+    end
+
+    def self.json_driver(log_path)
+      Alephant::Logger::JSON.new log_path
+    end
+
+    def self.statsd_driver(opts)
+      Alephant::Logger::Statsd.new opts
+    end
+
+    def self.cloudwatch_driver(opts)
+      Alephant::Logger::CloudWatch.new cloudwatch_namespace(opts)
+    end
+
+    def self.cloudwatch_namespace(opts)
+      opts.tap do |h|
+        h[:namespace] = h[:namespace] % BBC::Cosmos::Config.cosmos.environment
+      end
+    end
+
+    def self.production?
+      BBC::Cosmos::Config.cosmos.environment == "live"
+    end
+  end
+end

data/lib/mozart/logger/version.rb

@@ -0,0 +1,5 @@
+module Mozart
+  module Logger
+    VERSION = "1.2.0"
+  end
+end

data/mozart-logger.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mozart/logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mozart-logger"
+  spec.version       = Mozart::Logger::VERSION
+  spec.authors       = ["BBC News"]
+  spec.email         = ["FutureMediaNewsRubyGems@bbc.co.uk"]
+
+  spec.summary       = "Mozart Logging and Metrics"
+  spec.description   = "Private gem setting up logging/metrics for Mozart"
+  spec.homepage      = "https://github.com/bbc/mozart-logger"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|spec|features)/})
+                        end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "alephant-logger", "~> 3"
+  spec.add_runtime_dependency "alephant-logger-json", "~> 0"
+  spec.add_runtime_dependency "alephant-logger-statsd", "~> 0"
+  spec.add_runtime_dependency "alephant-logger-cloudwatch", "~> 2"
+  spec.add_runtime_dependency "bbc-cosmos-config"
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: mozart-logger
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- BBC News
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: pry
+  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: alephant-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: alephant-logger-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: alephant-logger-statsd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: alephant-logger-cloudwatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bbc-cosmos-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Private gem setting up logging/metrics for Mozart
+email:
+- FutureMediaNewsRubyGems@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mozart/logger.rb
+- lib/mozart/logger/version.rb
+- mozart-logger.gemspec
+homepage: https://github.com/bbc/mozart-logger
+licenses: []
+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: Mozart Logging and Metrics
+test_files: []