logdna-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11213205c83286528992bb3ff2fa03af78f179a4
-  data.tar.gz: 55e6835da1b56dcbd535e9b48a0ed9443608a7ba
+  metadata.gz: 0ba4c6225fa6411c486810667391805ee3a041a6
+  data.tar.gz: dcc2d050a26b5b9f77e78f31d82ffba719de7783
 SHA512:
-  metadata.gz: 1b853af8bdf17a1af599673c111f213e23cda65a11863e5bb644561b971febb0bd7e717a489b054f8d6657d6891943940efff361aee79403bf45a468e2342a75
-  data.tar.gz: 9773764115391c3b147834f141fa3609579a2eccc9fa0222bd102cc7fc787fb02e41c18850f3f8d9f1c7bfd08a4d9f8a1204b7fe12a71499cf18ee464aeb5056
+  metadata.gz: be43fd9a910e202a0b6c7567c717356df81aa1e88766f911b754a94bbd38e36c2f67e59ff681a08ab9ac8e01d63f93356ff853401b04b67ef9586c1de5d0c4a2
+  data.tar.gz: 9b40a4b55d885dc4c76acbd61ab66554b97d689c7d7f9ea7f1d73729c8daa5bf78533838e8a2700e4825e90933ad1e2329daba9044e1f5113beed8d9c597e7b4

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

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)
+
+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,130 @@
+
+<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 gem for logging to <a href="https://app.logdna.com">LogDNA</a></p>
+</p>
+
+---
+
+* **[Installation](#installation)**
+* **[Quick Setup](#quick-setup)**
+* **[API](#api)**
+* **[Contributing](#contributing)**
+* **[License](#license)**
+
+# 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, options)
+    => #<Logdna::Ruby:0x00000000000000>
+
+to set up the logger.
+
+Options are optional variables that may contain hostname, app name, mac address, ip address, log level specified.
+
+    options = {
+        :hostname => myHostName,
+        :ip =>  myIpAddress,
+        :mac => myMacAddress,
+        :app => myAppName,
+        :level => "INFO",    # LOG_LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'] or your customized log level
+        :env => "PRODUCTION",
+        :meta => {:once => {:first => "nested1", :another => "nested2"}}
+    }
+
+To send logs, use "log" method. Default log level is "INFO"
+
+    logger.log('This is my first log')
+    => "Saved"  # Saved to buffer. Ready to be flushed automatically
+
+Log a message with particular metadata, level, appname, environment (one-time)
+
+    logger.log('This is warn message', {:meta => {:meta => "data"}, :level => "WARN", :app => "awesome", :env => "DEVELOPMENT"})
+
+Log a message with lasting metadata, level, appname, environment (lasting)
+
+    logger.meta = {:once => {:first => "nested1", :another => "nested2"}}
+    logger.level = 'FATAL'  or  logger.level = Logger::FATAL
+    logger.app = 'NEW APP NAME'
+    logger.env = 'PRODUCTION'
+    logger.log('This messages and messages afterwards all have the above values')
+
+Clear current metadata, level, appname, environment
+
+    logger.clear
+
+Check current log level:
+    
+    logger.info? => true
+    logger.warn? => false
+
+Log a message with a particular level easily
+
+    logger.warn('This is a warning message')
+    logger.fatal('This is a fatal message')
+
+
+Hostname and app name cannot be more than 80 characters.
+
+
+# Important Notes
+
+1. This logger assumes that you pass in json formatted data
+2. This logger is a singleton (do not create mutiple instances of the logger) even though the singleton structure is not strongly enforced. 
+
+
+# API
+
+## Logdna::RailsLogger.new(ingestion_key, options = {})
+
+Instantiates a new instance of the class it is called on. ingestion_key is required.
+
+| Options | Default |
+|---------|---------|
+|{ :hostname => Host name } | Device's default hostname |
+|{ :mac => MAC address } | Nil |
+|{ :ip => IP address } | Nil |
+|{ :app => App name } | 'default' |
+|{ :level => Log level } | 'INFO' |
+|{ :env => STAGING, PRODUCTION .. etc} | Nil |
+|{ :meta => metadata} | Nil |
+|{ :flushtime => Log flush interval in seconds } | 0.25 seconds |
+|{ :flushbyte => Log flush upper limit in bytes } | 500000 bytes ~= 0.5 megabytes |
+
+Different log level displays log messages in different colors as well. 
+- ![TRACE DEBUG INFO Colors](https://placehold.it/15/515151/000000?text=+)   "Trace"  "Debug"  "Info"
+- ![WARN Color](https://placehold.it/15/ec9563/000000?text=+)   "Warn"
+- ![ERROR Fatal Colors](https://placehold.it/15/e37e7d/000000?text=+)   "Error"  "Fatal"
+
+
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logdna/rails.
+
+
+
+# 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/deb5d62d893e82d6b03f3d4c20b96e15

@@ -0,0 +1 @@
+# Logfile created on 2017-08-09 10:32:49 -0700 by logger.rb/56815

data/lib/logdna/rails.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'logdna'
+
+module Logdna
+    class RailsLogger < Logdna::Ruby
+        include Logdna
+        attr_accessor :api_key, :opts
+
+        def initialize(api_key, opts={})
+            super(api_key, opts)
+        end
+    end
+end
+

data/logdna-rails.gemspec

@@ -0,0 +1,28 @@
+# 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       = '1.0.1'
+  spec.authors       = 'Gun Woo Choi'
+  spec.email         = 'matt.choi@logdna.com'
+
+  spec.summary       = 'LogDNA Rails Logger'
+  spec.homepage      = 'https://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 'logdna', '~> 1.0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/test.rb

@@ -0,0 +1,40 @@
+require 'require_all'
+require_all 'lib'
+
+
+options = {hostname: "yondfsoikplghjniodhnfvreulwignfewfnrleuwinf"}
+
+
+logger1 = Logdna::RailsLogger.new('You API Key')
+
+logger1.level = Logger::TRACE
+logger1.log('is this trace')
+
+=begin
+logger1.level = Logger::WARN
+logger1.log('This should be warn')
+logger1.trace('This should be trace')
+logger1.log('Again warn level')
+
+logger1.log('Warn level log1')
+logger1.info('Info level log1')
+logger1.level = Logger::DEBUG
+logger1.log('DEBUG log1')
+
+logger1.app = 'NEW APP NAME'
+logger1.env = 'Staging'
+logger1.level = 'INFO'
+
+
+
+logger1.level = 'INFO'
+logger1.level == Logger::INFO
+
+
+logger1.log('are changes all updated')
+=end
+sleep 3
+
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logdna-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gun Woo Choi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logdna
@@ -85,7 +85,16 @@ email: matt.choi@logdna.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deb5d62d893e82d6b03f3d4c20b96e15
+- lib/logdna/rails.rb
+- logdna-rails.gemspec
+- test.rb
 homepage: https://github.com/logdna/rails
 licenses:
 - MIT