logdna 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30672876bb2c1d6341c64309d863e3b597ffe046
-  data.tar.gz: 6562f55f16a6ade2ee3b656827f777d1c16a14aa
+  metadata.gz: 24d909c4d53e174a268e19648d08d0b801890dbd
+  data.tar.gz: 35f91c6fb570116ade6040bb87ff5181ca18c1e7
 SHA512:
-  metadata.gz: f28c90884cc0d128858da01b784b428a86c7982fe1dc66059491bf6758dc17ad7b015101283b22af606f6b92b34f94864751d27f4991f527156cef946767ec33
-  data.tar.gz: 16fe8e45a234b4f94a120c972b18ec247d25160de90f65e569b85d9e4d5afa266033f537616df013793e5e3f82a344e675e4eb8e4b4630f92f954debff00da65
+  metadata.gz: d833865aae127d9456c015f766240bfb016d15ca475089d3bec02b939c681a19ee7970b089429f24e06e8434aaf177e29290662823b0f8029782cbaa34b2857e
+  data.tar.gz: b5177cee5a3515c8862f8c065706f6d8889e5794b084212b107bcff7834de4336a11f5a265bbbd1974098db5311b4b9cd881555e7c71663d7995df60ef27c57d

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
+*.gem
+.DS_Store

data/README.md

@@ -34,6 +34,38 @@ Or install it yourself as:
 
     $ gem install logdna
 
+# Quick Setup
+
+After installation, call
+
+    logger = LogDNA::RubyLogger.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::RubyLogger.new(your_api_key, hostname)
+    logger.level = Logger::WARN
+
+    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 = {})
@@ -42,14 +74,19 @@ Instantiates a new instance of the class it is called on. api_key and hostname a
 
 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
-* buffer_max_size: Maximum number of lines in buffer.
-* buffer_timeout: Frequency of posting requests to LogDNA.
 * 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
+## \#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.
 
@@ -59,7 +96,7 @@ Close the HTTP connection to LogDNA's ingester.
 
 ## \#reopen_http
 
-Open another HTTP connection to LogDNA's ingester if the connection is alread closed.
+Open another HTTP connection to LogDNA's ingester if the connection is already closed.
 
 ## \#<<(message)
 

data/lib/logdna.rb

@@ -35,6 +35,14 @@ module LogDNA
     @open = true
   end
 
+  def environment
+    @default_app
+  end
+
+  def environment=(env)
+    @default_app = env
+  end
+
   private
 
   def fill_opts_with_defaults(opts)
@@ -42,6 +50,10 @@ module LogDNA
     opts[:logdev] ||= STDOUT
     opts[:shift_age] ||= 7
     opts[:shift_size] ||= 1_048_576
+    opts[:environment] ||= nil # alias for :default_app
+    opts[:default_app] ||= opts[:environment]
+    opts[:buffer_max_size] ||= 10
+    opts[:buffer_timeout] ||= 10
     opts
   end
 
@@ -51,9 +63,10 @@ module LogDNA
     @host = hostname.to_s
     @mac = opts[:mac].to_s
     @ip = opts[:ip].to_s
+    @default_app = opts[:default_app] || 'none'
     @buffer = []
-    @buffer_max = opts[:buffer_max_size] || 10
-    @freq = opts[:buffer_timeout] || 10
+    @buffer_max = opts[:buffer_max_size]
+    @freq = opts[:buffer_timeout]
     @open = true
   end
 
@@ -65,8 +78,9 @@ module LogDNA
     res.flush
   end
 
-  def push_to_buffer(message, level = nil, source = 'none')
-    line = { line: message, app: source, timestamp: Time.now.to_i }
+  def push_to_buffer(message, level = nil, source = nil)
+    app = source || @default_app
+    line = { line: message, app: app, timestamp: Time.now.to_i }
     line[:level] = LEVELS[level] if level
     start_timer if @buffer.empty?
     @buffer << line

data/lib/logdna/ruby_logger.rb

@@ -5,6 +5,9 @@ module LogDNA
   class RubyLogger < ::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)

data/lib/logdna/version.rb

@@ -1,3 +1,3 @@
 module LogDNA
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'.freeze
 end

data/logdna.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'http', '~> 2.0'
 
   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'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logdna
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Edwin Lai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
 description: 
 email: edwin@logdna.com
 executables: []
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: LogDNA extension to ruby logger