contextual_logger 0.10.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/contextual_logger/logger_with_context.rb +26 -1
- data/lib/contextual_logger/version.rb +1 -1
- data/lib/contextual_logger.rb +3 -3
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a4baf217bb735acc0a7c3b0ca8631762d82350d5c694b2af55ef04f59b838ed1
|
4
|
+
data.tar.gz: 0b3a3af427439d0e03aab2eef021836e88de6b811157005403592d30ea7016dc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a6fdc0ec5b5fdf600cbc7be5cda513445b32854bfd6fe39bdb008a6e37f0bda984c04802688bbbb144872b59f0505e495488e298cd83db781cef7fbee0741e00
|
7
|
+
data.tar.gz: 0a45ff4a201df1df0403789076e5bc55fe4c38af96898827fb8e023309f1215e1a5ef1736a7b9cb2e9f019d35f53fdf2d057edb630f3f5f9358dc06ed939ef25
|
@@ -1,5 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require 'active_support/core_ext/hash/keys'
|
4
|
+
|
3
5
|
module ContextualLogger
|
4
6
|
# A logger that deep_merges additional context and then delegates to the given logger.
|
5
7
|
# Keeps it own log level (called override_level) that may be set independently of the logger it delegates to.
|
@@ -13,7 +15,7 @@ module ContextualLogger
|
|
13
15
|
logger.is_a?(LoggerMixin) or raise ArgumentError, "logger must include ContextualLogger::LoggerMixin (got #{logger.inspect})"
|
14
16
|
@logger = logger
|
15
17
|
self.level = level
|
16
|
-
@context = context
|
18
|
+
@context = normalize_context(context)
|
17
19
|
@merged_context_cache = {} # so we don't have to merge every time
|
18
20
|
end
|
19
21
|
|
@@ -36,6 +38,29 @@ module ContextualLogger
|
|
36
38
|
@logger.write_entry_to_log(severity, timestamp, progname, message, context: merged_context)
|
37
39
|
end
|
38
40
|
|
41
|
+
private
|
42
|
+
|
43
|
+
def normalize_context(context)
|
44
|
+
if warn_on_string_keys(context)
|
45
|
+
context.deep_symbolize_keys
|
46
|
+
else
|
47
|
+
context
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def warn_on_string_keys(context)
|
52
|
+
if deep_key_has_string?(context)
|
53
|
+
ActiveSupport::Deprecation.warn('Context keys must use symbols not strings. This will be asserted as of contextual_logger v1.0.0')
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def deep_key_has_string?(hash)
|
58
|
+
hash.any? do |key, value|
|
59
|
+
key.is_a?(String) ||
|
60
|
+
(value.is_a?(Hash) && deep_key_has_string?(value))
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
39
64
|
class << self
|
40
65
|
def for_log_source(logger, log_source, level: nil)
|
41
66
|
new(logger, { log_source: log_source }, level: level)
|
data/lib/contextual_logger.rb
CHANGED
@@ -85,11 +85,11 @@ module ContextualLogger
|
|
85
85
|
add(#{log_level}, nil, arg, &block)
|
86
86
|
else
|
87
87
|
if arg.nil?
|
88
|
-
add(#{log_level}, nil, context, &block)
|
88
|
+
add(#{log_level}, nil, **context, &block)
|
89
89
|
elsif block
|
90
|
-
add(#{log_level}, nil, context.merge(progname: arg), &block)
|
90
|
+
add(#{log_level}, nil, **context.merge(progname: arg), &block)
|
91
91
|
else
|
92
|
-
add(#{log_level}, arg, context)
|
92
|
+
add(#{log_level}, arg, **context)
|
93
93
|
end
|
94
94
|
end
|
95
95
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: contextual_logger
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- James Ebentier
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-03-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: json
|
@@ -56,7 +56,7 @@ licenses:
|
|
56
56
|
metadata:
|
57
57
|
source_code_uri: https://github.com/Invoca/contextual_logger
|
58
58
|
allowed_push_host: https://rubygems.org
|
59
|
-
post_install_message:
|
59
|
+
post_install_message:
|
60
60
|
rdoc_options: []
|
61
61
|
require_paths:
|
62
62
|
- lib
|
@@ -71,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
71
71
|
- !ruby/object:Gem::Version
|
72
72
|
version: '0'
|
73
73
|
requirements: []
|
74
|
-
rubygems_version: 3.
|
75
|
-
signing_key:
|
74
|
+
rubygems_version: 3.1.6
|
75
|
+
signing_key:
|
76
76
|
specification_version: 4
|
77
77
|
summary: Add context to your logger
|
78
78
|
test_files: []
|