1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2015-2020 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Monitoring
# Subscribes to command events and logs them.
#
# @since 2.1.0
class CommandLogSubscriber
include Loggable
# @return [ Hash ] options The options.
attr_reader :options
# Constant for the max number of characters to print when inspecting
# a query field.
#
# @since 2.1.0
LOG_STRING_LIMIT = 250
# Create the new log subscriber.
#
# @example Create the log subscriber.
# CommandLogSubscriber.new
#
# @param [ Hash ] options The options.
#
# @option options [ Logger ] :logger An optional custom logger.
#
# @since 2.1.0
def initialize(options = {})
@options = options
end
# Handle the command started event.
#
# @example Handle the event.
# subscriber.started(event)
#
# @param [ CommandStartedEvent ] event The event.
#
# @since 2.1.0
def started(event)
if logger.debug?
_prefix = prefix(event,
connection_generation: event.connection_generation,
connection_id: event.connection_id,
server_connection_id: event.server_connection_id,
)
log_debug("#{_prefix} | STARTED | #{format_command(event.command)}")
end
end
# Handle the command succeeded event.
#
# @example Handle the event.
# subscriber.succeeded(event)
#
# @param [ CommandSucceededEvent ] event The event.
#
# @since 2.1.0
def succeeded(event)
if logger.debug?
log_debug("#{prefix(event)} | SUCCEEDED | #{'%.3f' % event.duration}s")
end
end
# Handle the command failed event.
#
# @example Handle the event.
# subscriber.failed(event)
#
# @param [ CommandFailedEvent ] event The event.
#
# @since 2.1.0
def failed(event)
if logger.debug?
log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
end
end
private
def format_command(args)
begin
truncating? ? truncate(args) : args.inspect
rescue Exception
'<Unable to inspect arguments>'
end
end
def prefix(event, connection_generation: nil, connection_id: nil,
server_connection_id: nil
)
extra = [connection_generation, connection_id].compact.join(':')
if extra == ''
extra = nil
else
extra = "conn:#{extra}"
end
if server_connection_id
extra += " sconn:#{server_connection_id}"
end
"#{event.address.to_s} req:#{event.request_id}#{extra && " #{extra}"} | " +
"#{event.database_name}.#{event.command_name}"
end
def truncate(command)
((s = command.inspect).length > LOG_STRING_LIMIT) ? "#{s[0..LOG_STRING_LIMIT]}..." : s
end
def truncating?
@truncating ||= (options[:truncate_logs] != false)
end
end
end
end
|
