logdna 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d025f71abf5afb886b942d4092c6e902dbf88ee8
+  data.tar.gz: 4748c857fec602e2b4e56217e6f6d908bc99c84a
+SHA512:
+  metadata.gz: fe6bba13754c9a64124a2a56401b76a08bcdd97d48fa5e8f62c6808f558fc1c99bc46d821ad78c2506b7482d7b744256c36036420802cf87cac424891fe8e38b
+  data.tar.gz: 486b11af0975e3a5543b1792b06d169fc4938f2005f6ec28071b42fcdfb7aa69e48235379a31ab8f91007d9e4283ff550c2dffed0f7e3cb4302018215f35d277

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 edwin-lai
+
+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,81 @@
+<p align="center">
+  <a href="https://app.logdna.com">
+    <img height="95" width="201" src="https://raw.githubusercontent.com/logdna/artwork/master/logo%2Bruby.png">
+  </a>
+  <p align="center">Ruby gem for logging to <a href="https://app.logdna.com">LogDNA</a></p>
+</p>
+
+---
+
+* **[Overview](#overview)**
+* **[Installation](#installation)**
+* **[API](#api)**
+* **[Development](#development)**
+* **[Contributing](#contributing)**
+* **[License](#license)**
+
+# Overview
+
+This gem contains LogDNA::RubyLogger, an extension to the logger from Ruby's standard library, as well as LogDNA::RailsLogger, which inherits from ActiveSupport::Logger from Rails. LogDNA::RailsLogger is only loaded if ActiveSupport is present.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logdna'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logdna
+
+# API
+
+## Shared by LogDNA::RubyLogger and LogDNA::RailsLogger
+
+### ::new(api_key, hostname, options = {})
+
+Instantiates a new instance of the class it is called on. api_key and hostname are required.
+
+Options:
+* logdev: The log device. This is a filename (String) or IO object (e.g. STDOUT, STDERR, an open file). Default: STDOUT.
+* shift_age: Number of old log files to keep, or frequency of rotation (daily, weekly, or monthly). Default: 7.
+* shift_size: Maximum logfile size (only applies when shift_age is a number). Default: 1,048,576
+* mac: MAC address. Default: nil.
+* ip: IP address. Default: nil.
+
+### \#add
+
+Log a message if the given severity is high enough and post it to the LogDNA ingester. This is the generic logging method. Users will be more inclined to use debug, info, warn, error, and fatal (which all call \#add), as [described in the Ruby Logger documentation](https://ruby-doc.org/stdlib-2.3.0/libdoc/logger/rdoc/Logger.html). Note that these methods take a source as the argument and a block which returns a message. It returns the http response.
+
+### \#close_http
+
+Close the HTTP connection to LogDNA's ingester.
+
+### \#reopen_http
+
+Open another HTTP connection to LogDNA's ingester if the connection is alread closed.
+
+## Only in LogDNA::RubyLogger
+
+### \#<<(message)
+
+Dump given message to the log device without any formatting, then posts it to the LogDNA ingester. If no log device exists, return nil.
+
+# 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.
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logdna/logdna_ruby.
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logdna"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/logdna.rb

@@ -0,0 +1,73 @@
+require 'json'
+require_relative './logdna/version.rb'
+require_relative './logdna/ruby_logger.rb'
+begin
+  require_relative './logdna/rails_logger.rb'
+rescue
+end
+
+module LogDNA
+  INGESTER_DOMAIN = 'https://logs.logdna.com'.freeze
+
+  LEVELS = {
+    0 => 'DEBUG',
+    1 => 'INFO',
+    2 => 'WARN',
+    3 => 'ERROR',
+    4 => 'FATAL',
+    5 => 'UNKNOWN'
+  }.freeze
+
+  def add(severity, message = nil, progname = nil)
+    super
+    return true if severity < @level
+    message ||= yield
+    post_to_logdna(message, severity, progname) if @open
+  end
+
+  def close_http
+    return false unless @open
+    @conn.close
+    @open = false
+    true
+  end
+
+  def reopen_http
+    return false if @open
+    @conn = HTTP.persistent LogDNA::INGESTER_DOMAIN
+    @open = true
+  end
+
+  private
+
+  def fill_opts_with_defaults(opts)
+    # defaults from ruby standard library logger documentation
+    opts[:logdev] ||= STDOUT
+    opts[:shift_age] ||= 7
+    opts[:shift_size] ||= 1_048_576
+    opts
+  end
+
+  def set_ivars(api_key, hostname, opts)
+    raise ArgumentError 'api_key must be a string' unless api_key.is_a?(String)
+    @api_key = api_key
+    @host = hostname.to_s
+    @mac = opts[:mac].to_s
+    @ip = opts[:ip].to_s
+    @open = true
+  end
+
+  def post_to_logdna(message, level = nil, source = 'none')
+    res = @conn.headers(apikey: @api_key, 'Content-Type' => 'application/json')
+               .post("/logs/ingest?hostname=#{@host}&mac=#{@mac}&ip=#{@ip}",
+                     json: request_body(message, level, source))
+    res.flush
+  end
+
+  def request_body(message, level, source)
+    body = { e: 'line', line: message, timestamp: Time.now.to_i }
+    body[:level] = LEVELS[level] if level
+    body[:app] = source if source
+    body
+  end
+end

data/lib/logdna/rails_logger.rb

@@ -0,0 +1,15 @@
+require 'active_support/logger'
+require 'http'
+
+module LogDNA
+  class RailsLogger < ActiveSupport::Logger
+    include LogDNA
+
+    def initialize(api_key, hostname, options = {})
+      @conn = HTTP.persistent LogDNA::INGESTER_DOMAIN
+      opts = fill_opts_with_defaults(options)
+      super(opts[:logdev], opts[:shift_age], opts[:shift_size])
+      set_ivars(api_key, hostname, options)
+    end
+  end
+end

data/lib/logdna/ruby_logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+require 'http'
+
+module LogDNA
+  class RubyLogger < ::Logger
+    include LogDNA
+
+    def initialize(api_key, hostname, options = {})
+      @conn = HTTP.persistent LogDNA::INGESTER_DOMAIN
+      opts = fill_opts_with_defaults(options)
+      super(opts[:logdev], opts[:shift_age], opts[:shift_size])
+      set_ivars(api_key, hostname, options)
+    end
+
+    def <<(msg)
+      super
+      post_to_logdna(msg)
+    end
+  end
+end

data/lib/logdna/version.rb

@@ -0,0 +1,3 @@
+module LogDNA
+  VERSION = "0.0.1"
+end

data/logdna.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logdna/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logdna'
+  spec.version       = LogDNA::VERSION
+  spec.authors       = ['edwin-lai']
+  spec.email         = ['edwinlai@ucla.edu']
+
+  spec.summary       = 'LogDNA extension to ruby logger'
+  spec.homepage      = 'https://github.com/logdna/logdna_ruby'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'http', '~> 2.0', '>= 2.0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: logdna
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- edwin-lai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- edwinlai@ucla.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logdna.rb
+- lib/logdna/rails_logger.rb
+- lib/logdna/ruby_logger.rb
+- lib/logdna/version.rb
+- logdna.gemspec
+homepage: https://github.com/logdna/logdna_ruby
+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: LogDNA extension to ruby logger
+test_files: []