pier_logging 0.1.10 → 0.1.15
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/pier_logging.rb +25 -1
- data/lib/pier_logging/helpers/env_config.rb +48 -0
- data/lib/pier_logging/logger.rb +6 -1
- data/lib/pier_logging/request_logger.rb +21 -6
- data/lib/pier_logging/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d5b9f495421c7b6e2b36d0cd8a0ff5978cba36feaf25350a383900347f58b9eb
|
4
|
+
data.tar.gz: 64339331f573395e582b713b460278ff41df69906b6584765b14f3a6f2f8f122
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9cbc2402ac849f1b89938d17e3b33c47829148e5bc67eda1250e189fb0b394385ffbc58877e875c8437cfabf7ddb8e0c524f3e3fce42adec755b5afc4a097cac
|
7
|
+
data.tar.gz: ef22e8acb1ec18fc43b54e60454759a7f2728375344feb9c97b3d8de24db0dfe1bb28cd3e824ba9f9518d03aa8e9db399a3b37856192b43ef9d225b2c9d06a18
|
data/lib/pier_logging.rb
CHANGED
@@ -9,6 +9,7 @@ require "pier_logging/formatter/base"
|
|
9
9
|
require "pier_logging/formatter/json"
|
10
10
|
require "pier_logging/formatter/readable"
|
11
11
|
require "pier_logging/helpers/headers"
|
12
|
+
require "pier_logging/helpers/env_config"
|
12
13
|
|
13
14
|
module PierLogging
|
14
15
|
def self.logger_configuration
|
@@ -53,17 +54,40 @@ module PierLogging
|
|
53
54
|
end
|
54
55
|
|
55
56
|
class RequestLoggerConfiguration
|
56
|
-
attr_reader :enabled, :user_info_getter
|
57
|
+
attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, :log_response, :hide_request_headers
|
57
58
|
|
58
59
|
def initialize
|
59
60
|
@user_info_getter = nil
|
60
61
|
@enabled = false
|
62
|
+
@hide_response_body_for_paths = nil
|
63
|
+
@log_response = true
|
64
|
+
@hide_request_headers = nil
|
61
65
|
end
|
62
66
|
|
63
67
|
def user_info_getter=(proc)
|
64
68
|
raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless proc.is_a? Proc
|
65
69
|
@user_info_getter = proc
|
66
70
|
end
|
71
|
+
|
72
|
+
def log_response=(log_response)
|
73
|
+
raise ArgumentError, "Config 'log_response' must be a 'boolean'" unless !!log_response == log_response
|
74
|
+
@log_response = log_response
|
75
|
+
end
|
76
|
+
|
77
|
+
def hide_response_body_for_paths=(hide_response_body_for_paths)
|
78
|
+
unless (hide_response_body_for_paths.is_a? Array) && (hide_response_body_for_paths.all?{|item| item.is_a? Regexp})
|
79
|
+
raise ArgumentError, "Config 'hide_response_body_for_paths' must be an 'Array of Regexps'"
|
80
|
+
end
|
81
|
+
|
82
|
+
@hide_response_body_for_paths = hide_response_body_for_paths
|
83
|
+
end
|
84
|
+
|
85
|
+
def hide_request_headers=(hide_request_headers)
|
86
|
+
unless (hide_request_headers.is_a? Array) && (hide_request_headers.all?{|item| item.is_a? Regexp})
|
87
|
+
raise ArgumentError, "Config 'hide_request_headers' must be an 'Array of Regexps'"
|
88
|
+
end
|
89
|
+
@hide_request_headers = hide_request_headers
|
90
|
+
end
|
67
91
|
|
68
92
|
def enabled=(enabled = false)
|
69
93
|
raise ArgumentError, "Config 'enabled' must be a 'boolean'" unless !!enabled == enabled
|
@@ -0,0 +1,48 @@
|
|
1
|
+
module PierLogging
|
2
|
+
module Helpers
|
3
|
+
class EnvConfig
|
4
|
+
def self.for(logger = nil, log_dir: 'log', log_file: PierLogging.logger_configuration.env)
|
5
|
+
{
|
6
|
+
enabled: log_enabled(logger),
|
7
|
+
output: log_output(logger, log_dir, log_file),
|
8
|
+
level: log_level(logger),
|
9
|
+
}
|
10
|
+
end
|
11
|
+
|
12
|
+
private
|
13
|
+
|
14
|
+
def self.log_output(logger, log_dir, log_file)
|
15
|
+
return nil unless log_enabled(logger)
|
16
|
+
log_output_env = ENV.fetch(output_env_var(logger), 'STDOUT').upcase
|
17
|
+
log_output_env == 'STDOUT' ? STDOUT : output_file_name(log_dir, log_file)
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.log_enabled(logger)
|
21
|
+
ENV.fetch(enabled_env_var(logger), 'true') == 'true'
|
22
|
+
end
|
23
|
+
|
24
|
+
def self.log_level(logger)
|
25
|
+
ENV.fetch(level_env_var(logger), 'info').upcase
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.output_env_var(logger)
|
29
|
+
['LOG', logger ,'OUTPUT'].compact.join('_').upcase
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.enabled_env_var(logger)
|
33
|
+
['LOG', logger ,'ENABLED'].compact.join('_').upcase
|
34
|
+
end
|
35
|
+
|
36
|
+
def self.level_env_var(logger)
|
37
|
+
['LOG', logger ,'LEVEL'].compact.join('_').upcase
|
38
|
+
end
|
39
|
+
|
40
|
+
def self.output_file_name(log_dir, log_file)
|
41
|
+
[
|
42
|
+
[ log_dir, log_file ].join('/'),
|
43
|
+
'log'
|
44
|
+
].join('.')
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
data/lib/pier_logging/logger.rb
CHANGED
@@ -2,7 +2,12 @@
|
|
2
2
|
module PierLogging
|
3
3
|
class Logger < Ougai::Logger
|
4
4
|
include ActiveSupport::LoggerThreadSafeLevel
|
5
|
-
include
|
5
|
+
include LoggerSilence
|
6
|
+
|
7
|
+
def initialize(*args)
|
8
|
+
super
|
9
|
+
after_initialize if respond_to? :after_initialize
|
10
|
+
end
|
6
11
|
|
7
12
|
def create_formatter
|
8
13
|
PierLogging.logger_configuration.formatter
|
@@ -59,7 +59,7 @@ module PierLogging
|
|
59
59
|
},
|
60
60
|
response: {
|
61
61
|
status: status,
|
62
|
-
body:
|
62
|
+
body: response_body(request.path, body),
|
63
63
|
type: type['Content-Type'],
|
64
64
|
}
|
65
65
|
})
|
@@ -71,8 +71,23 @@ module PierLogging
|
|
71
71
|
|
72
72
|
private
|
73
73
|
def get_request_headers_from_env(env)
|
74
|
-
|
75
|
-
|
74
|
+
hide_request_headers = PierLogging.request_logger_configuration.hide_request_headers
|
75
|
+
|
76
|
+
headers = env.select { |k,v| k[0..4] == 'HTTP_'}.
|
77
|
+
transform_keys { |k| k[5..-1].split('_').join('-').upcase }
|
78
|
+
|
79
|
+
return redact_hash(headers, hide_request_headers, nil) if hide_request_headers.present?
|
80
|
+
|
81
|
+
headers
|
82
|
+
end
|
83
|
+
|
84
|
+
def response_body(request_path, body)
|
85
|
+
return nil unless PierLogging.request_logger_configuration.log_response
|
86
|
+
|
87
|
+
hide_response_body_for_paths = PierLogging.request_logger_configuration.hide_response_body_for_paths
|
88
|
+
return nil if hide_response_body_for_paths && hide_response_body_for_paths.any?{ |path|request_path =~ path }
|
89
|
+
|
90
|
+
parse_body(body)
|
76
91
|
end
|
77
92
|
|
78
93
|
def build_message_from_request(request)
|
@@ -99,11 +114,11 @@ module PierLogging
|
|
99
114
|
body
|
100
115
|
end
|
101
116
|
|
102
|
-
def redact_hash(hash)
|
117
|
+
def redact_hash(hash, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
|
103
118
|
hash.traverse do |k,v|
|
104
|
-
should_redact =
|
119
|
+
should_redact = replace_keys.any?{ |regex| k =~regex }
|
105
120
|
if (should_redact)
|
106
|
-
[k,
|
121
|
+
[k, replace_by]
|
107
122
|
else
|
108
123
|
[k, v]
|
109
124
|
end
|
data/lib/pier_logging/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: pier_logging
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.15
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mauricio Banduk
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-07-
|
11
|
+
date: 2020-07-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: ougai
|
@@ -149,6 +149,7 @@ files:
|
|
149
149
|
- lib/pier_logging/formatter/base.rb
|
150
150
|
- lib/pier_logging/formatter/json.rb
|
151
151
|
- lib/pier_logging/formatter/readable.rb
|
152
|
+
- lib/pier_logging/helpers/env_config.rb
|
152
153
|
- lib/pier_logging/helpers/headers.rb
|
153
154
|
- lib/pier_logging/logger.rb
|
154
155
|
- lib/pier_logging/request_logger.rb
|