stackify-ruby-logging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef27d23139a5d77ae5748f4e2767e909eb16acc1
+  data.tar.gz: a96afa19dda182aa2142005a819147176a62281b
+SHA512:
+  metadata.gz: 432abc2a6b37ccbd643050c3798c5cb67c21666a1c846fcf64d9d0f42a8b1dd4ff3334c93893593ba8e2a7ae5b546a95eb4ced7715e2670d8114e6a980bfdd61
+  data.tar.gz: 6da9de5bdd93afee4dd41b8d33dd73081fd0bd02b9c8b98912e6da0ac5ee9685cfd634cf7eda4eb4d255b253bfa02d93a0af5df45e5a7800aaa59ac080ea15bc

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# ide
+.idea
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.17.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    stackify-ruby-logging (1.0.0)
+      stackify-api-ruby (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    stackify-api-ruby (1.0.12)
+      faraday (~> 0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  stackify-ruby-logging!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.md

@@ -0,0 +1,62 @@
+Stackify Ruby Logging LICENSE
+---
+
+Certain inventions disclosed in this file may be claimed within patents owned or patent applications filed by 
+Stackify, LLC (“Stackify”) or third parties.
+
+Stackify grants you a revocable, non-exclusive, non-transferable, limited license to download, install and use this 
+Stackify Ruby Logging package (“Application”) strictly in accordance with the terms of this Agreement and the terms found 
+at https://stackify.com/terms-conditions.
+
+You agree not to, and you will not permit others to: license, sell, rent, lease, assign, distribute, transmit, host, 
+outsource, disclose or otherwise commercially exploit the Application or make the Application available to any third 
+party; modify, make derivative works of, disassemble, decrypt, reverse compile or reverse engineer any part of the 
+Application; or remove, alter or obscure any proprietary notice (including any notice of copyright or trademark) of 
+Stackify or its affiliates, partners, suppliers or the licensors of the Application.
+
+You may install, execute, and distribute these files and their contents only in conjunction with your direct use of 
+Stackify’s services. These files and their contents shall not be used in conjunction with any other product or 
+software, including but not limited to those that may compete with any Stackify product, feature, or software. As a 
+condition to the foregoing grant, you must provide this notice along with each copy you distribute and you must not 
+remove, alter, or obscure this notice.
+
+The Application, including without limitation all copyrights, patents, trademarks, trade secrets and other intellectual 
+property rights are, and shall remain, the sole and exclusive property of Stackify. Any feedback, comments, ideas, 
+code, pull requests, improvements or suggestions (collectively, "Suggestions") provided by you to Stackify with respect 
+to the Application shall remain the sole and exclusive property of Stackify. Stackify shall be free to use, copy, 
+modify, publish, or redistribute the Suggestions for any purpose and in any way without any credit or any compensation 
+to you.
+
+Stackify reserves the right to modify, suspend or discontinue, temporarily or permanently, the Application or any 
+service to which it connects, with or without notice and without liability to you.
+
+Stackify may from time to time provide enhancements or improvements to the features/functionality of the Application, 
+which may include patches, bug fixes, updates, upgrades and other modifications ("Updates"). Updates may modify or 
+delete certain features and/or functionalities of the Application. You agree that Stackify has no obligation to (i) 
+provide any Updates, or (ii) continue to provide or enable any particular features and/or functionalities of the 
+Application to you. You further agree that all Updates will be (i) deemed to constitute an integral part of the 
+Application, and (ii) subject to the terms and conditions of this Agreement.
+
+All other use, reproduction, modification, distribution, or other exploitation of these files is strictly prohibited, 
+except as may be set forth in a separate written license agreement between you and Stackify.  The terms of any such 
+license agreement will control over this notice.  The license stated above will be automatically terminated and 
+revoked if you exceed its scope or violate any of the terms of this notice.
+
+Upon termination of this Agreement, you shall cease all use of the Application and delete all copies of the 
+Application from your mobile device or from your computer.
+ 
+Termination of this Agreement will not limit any of Stackify LLC's rights or remedies at law or in equity in case of 
+breach by you (during the term of this Agreement) of any of your obligations under the present Agreement.
+
+You agree to indemnify and hold Stackify LLC and its parents, subsidiaries, affiliates, officers, employees, agents, 
+partners and licensors (if any) harmless from any claim or demand, including reasonable attorneys' fees, due to or 
+arising out of your: (a) use of the Application; (b) violation of this Agreement or any law or regulation; or (c) 
+violation of any right of a third party.
+
+Unless otherwise expressly agreed by Stackify in a separate written license agreement, these files are provided 
+AS IS, WITHOUT WARRANTY OF ANY KIND, including without any implied warranties of MERCHANTABILITY, FITNESS FOR A 
+PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a condition to your use of these files, you are solely responsible 
+for such use. Stackify will have no liability to you for direct, indirect, consequential, incidental, special, or 
+punitive damages or for lost profits or data.
+
+ 

data/README.md

@@ -0,0 +1,93 @@
+# stackify-ruby-logging
+
+Logging handler for sending log messages and exceptions to Stackify. Logging >=2.0.0 <2.2.2 is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'logging'
+gem 'stackify-ruby-logging'
+```
+
+And then execute:
+```
+$ bundle install
+```
+## Note
+This stackify-ruby-logging gem will work and tested for the following Ruby versions: 
+2.1.x, 2.3.x, 2.4.x, 2.5.x  
+However this gem won't work in ruby version such as 1.9.x/2.0.x.
+
+## Usage
+### Rails
+If your application is based on Rails you will add the script below in config/application.rb. For example:
+```
+module SampleRailsApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+    ...
+    Other code goes here...
+    ...
+    require 'logging'
+    Logging.init
+
+    logger = Logging.logger['sample_logger']
+    logger = Stackify::LoggerProxy.new(logger)
+    logger.add_appenders \
+      Logging.appenders.stdout,   # output log messages to stdout, you can remove this line if you don't want to display to stdout
+      Logging.appenders.file(File.join('log', 'development.log')), # output log messages to a log file
+      Logging.appenders.stackify(                                  # output log messages to Stackify
+        :api_key => '1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+        :app_name => 'rails-app',
+        :environment => :development,
+        :log_level => :info
+      )
+    config.logger = logger
+  end
+end
+```
+
+### Non-Rails
+For using stackify-ruby-logging gem within any Ruby application such as Sinatra add to top of your main file:
+```
+require 'logging'
+Logging.init
+
+logger = Logging.logger['sample_logger']
+logger = Stackify::LoggerProxy.new(logger)
+logger.add_appenders \
+  Logging.appenders.stdout,
+  Logging.appenders.file(File.join('log', 'development.log')),
+  Logging.appenders.stackify(
+    :api_key => '1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+    :app_name => 'sinatra-app',
+    :environment => :development,
+    :log_level => :info
+  )
+```
+
+### Log level
+You can use the following log levels: :info, :debug, :warn, :error & :fatal.
+
+## Troubleshooting
+If there are problems, you can enable internal logging of the stackify-ruby-logging. Add debug_log option see the example below:
+```
+require 'logging'
+Logging.init
+
+logger = Logging.logger['sample_logger']
+logger = Stackify::LoggerProxy.new(logger)
+logger.add_appenders \
+  Logging.appenders.stdout,
+  Logging.appenders.file(File.join('log', 'development.log')),
+  Logging.appenders.stackify(
+    :api_key => '1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+    :app_name => 'sinatra-app',
+    :environment => :development,
+    :log_level => :info,
+    :debug_log => File.join('log', 'stackify.log')
+  )
+```

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/logging/appenders/stackify.rb

@@ -0,0 +1,38 @@
+require 'stackify-api-ruby'
+
+module Logging
+  module Appenders
+    def self.stackify(*args)
+      return ::Logging::Appenders::StackifyRubyLogging if args.empty?
+      ::Logging::Appenders::StackifyRubyLogging.new(*args)
+    end
+
+    class StackifyRubyLogging < ::Logging::Appender
+      def initialize(opts = {})
+        super(opts[:app_name], opts)
+        logger = ::Logger.new(opts[:debug_log])
+        version_190 = '1.9.0'
+        version_200 = '2.0.0'
+        if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new(version_190) ||
+          Gem::Version.new(RUBY_VERSION) <= Gem::Version.new(version_200)
+          error_msg = 'Error: stackify-ruby-logging gem is currently not compatible in ruby version 1.9.x/2.0.x'
+          puts error_msg
+          logger.error error_msg
+        else
+          # Setup the configuration for stackify-api-ruby
+          if defined? Stackify
+            Stackify.setup do |config|
+              config.api_key = opts[:api_key]
+              config.env = opts[:environment] || :development
+              config.app_name = opts[:app_name] || 'default'
+              config.log_level = opts[:log_level] || :debug
+              config.mode = :logging
+              config.logger = logger
+            end
+            Stackify.run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logging/plugins/stackify.rb

@@ -0,0 +1,15 @@
+module Logging
+  module Plugins
+    module Stackify
+      extend self
+
+      VERSION = '1.0.0'.freeze
+
+      # This method will be called by the Logging framework when it first
+      # initializes. Here we require the stackify appender code.
+      def initialize_stackify
+        require File.expand_path('../../appenders/stackify', __FILE__)
+      end
+    end
+  end
+end

data/lib/logging/stackify-ruby-logging.rb

@@ -0,0 +1,8 @@
+require 'logging/stackify_ruby_logging/version'
+
+module Logging
+  module StackifyRubyLogging
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/logging/stackify_ruby_logging/version.rb

@@ -0,0 +1,5 @@
+module Logging
+  module StackifyRubyLogging
+    VERSION = "1.0.0"
+  end
+end

data/stackify-ruby-logging.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logging/stackify_ruby_logging/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stackify-ruby-logging"
+  spec.version       = Logging::StackifyRubyLogging::VERSION
+  spec.authors       = ['Stackify']
+  spec.email         = ['support@stackify.com']
+  spec.summary       = 'Stackify Ruby Logging'
+  spec.homepage      = 'http://www.stackify.com'
+  spec.license       = 'Stackify'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'stackify-api-ruby', '~> 1.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: stackify-ruby-logging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stackify
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: stackify-api-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- support@stackify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/logging/appenders/stackify.rb
+- lib/logging/plugins/stackify.rb
+- lib/logging/stackify-ruby-logging.rb
+- lib/logging/stackify_ruby_logging/version.rb
+- stackify-ruby-logging.gemspec
+homepage: http://www.stackify.com
+licenses:
+- Stackify
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Stackify Ruby Logging
+test_files: []