name_tagged_cee_syslogger 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 52792e2871337bffc914d4a999a0834b7220f121
4
+ data.tar.gz: e9426ad09abea9e5b7cfd3576c5cb3c4765ce684
5
+ SHA512:
6
+ metadata.gz: 1ac3316afb8b3c18812ad136d9559ab0db3c430c43fe37162e8115791d380deba49d58dc15f32639d67c7e8df7a6eaade66aa2cabb2c3bfdcfaec2f755a063ac
7
+ data.tar.gz: 711de9f290bdf19ba97836fbfc07b5b8f0f73a501dc6c8ee420c3a6e5ec783fe49c5ab77f07b19a74d3f25721844d4fa0e7cf184e3e93e5219e45dce7c595c07
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in name_tagged_cee_syslogger.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Donald Plummer
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,62 @@
1
+ # NameTaggedCeeSyslogger
2
+
3
+ Like using Syslogger, TaggedLogging, and Lograge with the CeeFormatter. But For
4
+ general purpose Rails use. Plus the tags get named so they are filterable in
5
+ Kibana.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'name_tagged_cee_syslogger'
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ Add do your rails configuration:
18
+
19
+ ```ruby
20
+ config.logger = NameTaggedCeeSyslogger::Logger.new("YourAppName", Syslog::LOG_PID, Syslog::LOG_LOCAL7)
21
+ ```
22
+
23
+ ```ruby
24
+ logger = NameTaggedCeeSyslogger::Logger.new("my_app", Syslog::LOG_PID | Syslog::LOG_CONS, Syslog::LOG_LOCAL0)
25
+ logger.level = ::Logger::INFO # use Logger levels
26
+ logger.warn "warning message"
27
+ logger.debug "debug message"
28
+
29
+ logger.info "my_subapp" { "Some lazily computed message" }
30
+ # => Nov 2 13:57:11 hostname my_subapp[21861]: @cee: {"msg":"Some lazily computed message","severity":"INFO"}
31
+
32
+ logger.tagged(tagname: "abc123") do
33
+ logger.info "this is a message"
34
+ end
35
+ # => Nov 2 13:57:11 hostname my_app[21860]: @cee: {"tagname":"abc123","msg":"this is a message","severity":"INFO"}
36
+
37
+ logger.warn(a: "hash", of: "data")
38
+ # => Nov 2 13:57:11 hostname my_app[21860]: @cee: {"a":"hash","of":"data","severity":"WARN"}
39
+ ```
40
+
41
+
42
+ ## Development
43
+
44
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run
45
+ `rake spec` to run the tests. You can also run `bin/console` for an interactive
46
+ prompt that will allow you to experiment.
47
+
48
+ To install this gem onto your local machine, run `bundle exec rake install`. To
49
+ release a new version, update the version number in `version.rb`, and then run
50
+ `bundle exec rake release`, which will create a git tag for the version, push
51
+ git commits and tags, and push the `.gem` file to
52
+ [rubygems.org](https://rubygems.org).
53
+
54
+ ## Contributing
55
+
56
+ Bug reports and pull requests are welcome on GitHub at
57
+ https://github.com/dplummer/name_tagged_cee_syslogger.
58
+
59
+ ## License
60
+
61
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
62
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "name_tagged_cee_syslogger"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ require "json"
2
+
3
+ module NameTaggedCeeSyslogger
4
+ class CeeFormatter
5
+ # This method is invoked when a log event occurs.
6
+ def call(severity, timestamp, progname, msg)
7
+ payload = {
8
+ severity: ::Logger::SEV_LABEL[severity.first]
9
+ }
10
+
11
+ if msg.is_a?(Hash)
12
+ payload.merge!(msg)
13
+ else
14
+ payload[:msg] = msg
15
+ end
16
+
17
+ "@cee: #{JSON.dump(payload)}"
18
+ end
19
+
20
+ # because ActiveJob looks here for tags
21
+ def current_tags
22
+ []
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,38 @@
1
+ require "syslogger"
2
+ module NameTaggedCeeSyslogger
3
+ class Logger < Syslogger
4
+ def initialize(*args)
5
+ super
6
+ @formatter = CeeFormatter.new
7
+ end
8
+
9
+ # wraps message with merge_tags
10
+ def add(severity, message = nil, progname = nil, &block)
11
+ if message.nil? && block.nil? && !progname.nil?
12
+ message, progname = progname, nil
13
+ end
14
+ message = merge_tags(message || block && block.call)
15
+
16
+ super(severity, message, progname)
17
+ end
18
+
19
+ # prevent default tag behavior
20
+ def tags_text
21
+ ""
22
+ end
23
+
24
+ def merge_tags(message)
25
+ unless message.is_a?(Hash)
26
+ message = { msg: message }
27
+ end
28
+
29
+ current_tags.each_with_index do |tag, index|
30
+ if tag.is_a?(Hash)
31
+ message.merge!(tag)
32
+ end
33
+ end
34
+
35
+ message
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,3 @@
1
+ module NameTaggedCeeSyslogger
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,6 @@
1
+ require "name_tagged_cee_syslogger/version"
2
+
3
+ module NameTaggedCeeSyslogger
4
+ autoload :Logger, "name_tagged_cee_syslogger/logger"
5
+ autoload :CeeFormatter, "name_tagged_cee_syslogger/cee_formatter"
6
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'name_tagged_cee_syslogger/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "name_tagged_cee_syslogger"
8
+ spec.version = NameTaggedCeeSyslogger::VERSION
9
+ spec.authors = ["Donald Plummer"]
10
+ spec.email = ["donald.plummer@gmail.com"]
11
+
12
+ spec.summary = %q{Tags with names, formatted for kibana, outputted to syslog}
13
+ spec.homepage = "https://github.com/dplummer/name_tagged_cee_syslogger"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency "syslogger", "~> 1.6"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.10"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec"
26
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: name_tagged_cee_syslogger
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Donald Plummer
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-11-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: syslogger
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.10'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.10'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description:
70
+ email:
71
+ - donald.plummer@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - lib/name_tagged_cee_syslogger.rb
86
+ - lib/name_tagged_cee_syslogger/cee_formatter.rb
87
+ - lib/name_tagged_cee_syslogger/logger.rb
88
+ - lib/name_tagged_cee_syslogger/version.rb
89
+ - name_tagged_cee_syslogger.gemspec
90
+ homepage: https://github.com/dplummer/name_tagged_cee_syslogger
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.4.5.1
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Tags with names, formatted for kibana, outputted to syslog
114
+ test_files: []