logdna-rails 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da04adfa6e0cff4618bb5684cc6a3b18d469d857
-  data.tar.gz: dc22c1f34e1c6073b53fcad298cb607e93120957
+  metadata.gz: aeb07c40058b90bc566f20dc7d6eb1944e52d566
+  data.tar.gz: f4752c49655056d4c5b16de1b538a5c11f8a77d4
 SHA512:
-  metadata.gz: e0e26fcfb802a60e06fad3f7ec1a27d8f73f281b31b26fe8a0f53f3e4cfebbe467dd4d1c5899a6009396dd90beb201679851ddf88b4a75fe42215ad9fa6bf8ee
-  data.tar.gz: 5f0828054d9d6351f85380c37b14b6e61d4d5d97d8d55d74282ad4c330fd87de77ef2454228ee8f1fb636c70ec859a96cb309c26e330193152b544f2ee8791b5
+  metadata.gz: 779768d3a5af39dd7165c328f2d6ac766a506c469911689f4786d53f46d340b87c4c9c463577ecf48a1f131c4940c61ec578611af6727fdeada1c31ac51ff5f8
+  data.tar.gz: a65ddbf17b4d230dd84407440993f09d18197fac9d7cb33ce335778b6003919eae99570bc9131059470a358f8ba179849fa4a1636eeba9f485fcfe7c99da82a0

data/.gitignore

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

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-rails.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,113 @@
+<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">Rails logger plugin 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::RailsLogger, a plugin for ActiveSupport::Logger from Rails.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logdna-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logdna-rails
+
+# Quick Setup
+
+After installation, call
+
+    logger = LogDNA::RailsLogger.new(your_api_key, hostname)
+
+to set up the logger.
+
+To send logs, use exactly like the logger from the Ruby standard library. For example:
+
+    require 'logdna'
+
+    logger = LogDNA::RailsLogger.new(your_api_key, hostname)
+
+    logger.debug("Created logger")
+    logger.info("Program started")
+    logger.warn("Nothing to do!")
+
+    path = "a_non_existent_file"
+
+    begin
+      File.foreach(path) do |line|
+        unless line =~ /^(\w+) = (.*)$/
+          logger.error("Line in wrong format: #{line.chomp}")
+        end
+      end
+    rescue => err
+      logger.fatal("Caught exception; exiting")
+      logger.fatal(err)
+    end
+
+# API
+
+## ::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.
+* mac: MAC address. Default: nil.
+* ip: IP address. Default: nil.
+* default_app: Set a default app for this instance of the logger. Note that this can be overwritten by the progname below on the line level, as the app is a line attribute.
+* environment: Alias for default_app.
+
+__Make sure that the following options are numbers if you supply them. We are not responsible for any type errors if you enter non-numerical values for these options.__
+
+* 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
+* buffer_max_size: Maximum number of lines in buffer. Default: 10
+* buffer_timeout: Frequency of posting requests to LogDNA. Default: 10 (seconds)
+
+## \#add(severity, message=nil, progname=nil) {...}
+
+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.
+
+Note that the Rails logger documentation is located [here](http://api.rubyonrails.org/classes/ActiveSupport/Logger.html), but it's not very helpful.
+
+## \#close_http
+
+Close the HTTP connection to LogDNA's ingester.
+
+## \#reopen_http
+
+Open another HTTP connection to LogDNA's ingester if the connection is already closed.
+
+# 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/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/lib/logdna/rails.rb

@@ -0,0 +1,19 @@
+require 'http'
+require 'active_support/logger'
+require 'logdna'
+
+module LogDNA
+  class RailsLogger < ActiveSupport::Logger
+    include LogDNA
+
+    attr_reader :open
+    attr_accessor :api_key, :host, :default_app, :ip, :mac
+
+    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/logdna-rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logdna-rails'
+  spec.version       = '0.0.5'
+  spec.author        = 'Edwin Lai'
+  spec.email         = 'edwin@logdna.com'
+
+  spec.summary       = 'ActiveSupport::Logger plugin for LogDNA'
+  spec.homepage      = 'http://github.com/logdna/rails'
+  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'
+  spec.add_runtime_dependency 'activesupport', '>= 4.0', '< 6.0'
+  spec.add_runtime_dependency 'logdna', '~> 0.0.8'
+
+  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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logdna-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Edwin Lai
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - bin/console
 - bin/setup
+- lib/logdna/rails.rb
+- logdna-rails.gemspec
 homepage: http://github.com/logdna/rails
 licenses:
 - MIT