Class: Logster::BaseStore

Inherits:
Object
  • Object
show all
Defined in:
lib/logster/base_store.rb

Direct Known Subclasses

RedisStore

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BaseStore

Returns a new instance of BaseStore.



8
9
10
11
12
13
 
# File 'lib/logster/base_store.rb', line 8

def initialize
  @max_retention = 60 * 60 * 24 * 7
  @skip_empty = true
  @allow_custom_patterns = false
  @patterns_cache = Logster::Cache.new
end

Instance Attribute Details

#allow_custom_patterns ⇒ Object

Returns the value of attribute allow_custom_patterns.



6
7
8
 
# File 'lib/logster/base_store.rb', line 6

def allow_custom_patterns
  @allow_custom_patterns
end

#ignore ⇒ Object

Returns the value of attribute ignore.



6
7
8
 
# File 'lib/logster/base_store.rb', line 6

def ignore
  @ignore
end

#level ⇒ Object

Returns the value of attribute level.



6
7
8
 
# File 'lib/logster/base_store.rb', line 6

def level
  @level
end

#max_retention ⇒ Object

Returns the value of attribute max_retention.



6
7
8
 
# File 'lib/logster/base_store.rb', line 6

def max_retention
  @max_retention
end

#skip_empty ⇒ Object

Returns the value of attribute skip_empty.



6
7
8
 
# File 'lib/logster/base_store.rb', line 6

def skip_empty
  @skip_empty
end

Instance Method Details

#bulk_delete(message_keys, grouping_keys) ⇒ Object

Delete messages associated with given message_keys



76
77
78
 
# File 'lib/logster/base_store.rb', line 76

def bulk_delete(message_keys, grouping_keys)
  not_implemented
end

#bulk_get(message_keys) ⇒ Object

Get a group of messages by their message_keys



52
53
54
 
# File 'lib/logster/base_store.rb', line 52

def bulk_get(message_keys)
  not_implemented
end

#check_rate_limits(severity) ⇒ Object

Checks all the existing rate limiters to check if any has been exceeded



97
98
99
 
# File 'lib/logster/base_store.rb', line 97

def check_rate_limits(severity)
  not_implemented
end

#clear ⇒ Object

Delete all unprotected messages in the store.



37
38
39
 
# File 'lib/logster/base_store.rb', line 37

def clear
  not_implemented
end

#clear_all ⇒ Object

Delete all messages, including protected messages.



42
43
44
 
# File 'lib/logster/base_store.rb', line 42

def clear_all
  not_implemented
end

#clear_patterns_cache(key) ⇒ Object 



244
245
246
 
# File 'lib/logster/base_store.rb', line 244

def clear_patterns_cache(key)
  @patterns_cache.clear(key)
end

#count ⇒ Object

The number of messages currently stored.



32
33
34
 
# File 'lib/logster/base_store.rb', line 32

def count
  not_implemented
end

#delete(message_key) ⇒ Object 



71
72
73
 
# File 'lib/logster/base_store.rb', line 71

def delete(message_key)
  not_implemented
end

#find_pattern_groups(load_messages: true) ⇒ Object

find all pattern groups; returns an array of Logster::Group



137
138
139
 
# File 'lib/logster/base_store.rb', line 137

def find_pattern_groups(load_messages: true)
  not_implemented
end

#get(message_key, load_env: true) ⇒ Object

Get a message by its message_key



47
48
49
 
# File 'lib/logster/base_store.rb', line 47

def get(message_key, load_env: true)
  not_implemented
end

#get_all_ignore_count ⇒ Object

returns a hash that maps patterns to the number of messages they have suppressed



128
129
130
 
# File 'lib/logster/base_store.rb', line 128

def get_all_ignore_count
  not_implemented
end

#get_all_messages ⇒ Object

Get all messages that you have in the store



57
58
59
 
# File 'lib/logster/base_store.rb', line 57

def get_all_messages
  not_implemented
end

#get_env(message_key) ⇒ Object

Get a message’s env by its message_key



62
63
64
 
# File 'lib/logster/base_store.rb', line 62

def get_env(message_key)
  not_implemented
end

#get_patterns(set_name) ⇒ Object

returns an array of strings each of which must be convertible to regexp



112
113
114
 
# File 'lib/logster/base_store.rb', line 112

def get_patterns(set_name)
  not_implemented
end

#increment_ignore_count(pattern) ⇒ Object

increments the number of messages that have been suppressed by a pattern



117
118
119
 
# File 'lib/logster/base_store.rb', line 117

def increment_ignore_count(pattern)
  not_implemented
end

#insert_pattern(set_name, pattern) ⇒ Object

takes a string as ‘pattern` and places it under the set `set_name`



102
103
104
 
# File 'lib/logster/base_store.rb', line 102

def insert_pattern(set_name, pattern)
  not_implemented
end

#protect(message_key) ⇒ Object

Mark a message as protected; i.e. it is not deleted by the #clear method



67
68
69
 
# File 'lib/logster/base_store.rb', line 67

def protect(message_key)
  not_implemented
end

#rate_limited?(ip_address, perform: false, limit: 60) ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/logster/base_store.rb', line 132

def rate_limited?(ip_address, perform: false, limit: 60)
  not_implemented
end

#register_rate_limit(severities, limit, duration, &block) ⇒ Object

Registers a rate limit on the given severities of logs



92
93
94
 
# File 'lib/logster/base_store.rb', line 92

def register_rate_limit(severities, limit, duration, &block)
  not_implemented
end

#remove_ignore_count(pattern) ⇒ Object

removes number of suppressed messages by a pattern



122
123
124
 
# File 'lib/logster/base_store.rb', line 122

def remove_ignore_count(pattern)
  not_implemented
end

#remove_pattern(set_name, pattern) ⇒ Object

takes a string as ‘pattern` and removes it from the set `set_name`



107
108
109
 
# File 'lib/logster/base_store.rb', line 107

def remove_pattern(set_name, pattern)
  not_implemented
end

#remove_pattern_group(pattern) ⇒ Object

removes the Logster::Group instance associated with the given pattern



147
148
149
 
# File 'lib/logster/base_store.rb', line 147

def remove_pattern_group(pattern)
  not_implemented
end

#replace_and_bump(message) ⇒ Object

Modify the saved message to the given one (identified by message.key) and bump it to the top of the latest list



21
22
23
 
# File 'lib/logster/base_store.rb', line 21

def replace_and_bump(message)
  not_implemented
end

#report(severity, progname, msg, opts = {}) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/logster/base_store.rb', line 151

def report(severity, progname, msg, opts = {})
  return if (!msg || (String === msg && msg.empty?)) && skip_empty
  return if level && severity < level

  msg = msg.inspect unless String === msg
  msg = truncate_message(msg)
  message = Logster::Message.new(severity, progname, msg, opts[:timestamp], count: opts[:count])

  env = opts[:env]&.dup || {}
  backtrace = opts[:backtrace]
  if Hash === env && env[:backtrace]
    # Special - passing backtrace through env
    backtrace = env.delete(:backtrace)
  end

  message.populate_from_env(env)

  if backtrace
    if backtrace.respond_to? :join
      backtrace = backtrace.join("\n")
    end
    message.backtrace = backtrace
  else
    message.backtrace = caller.join("\n")
  end

  return if ignore && ignore.any? do |pattern|
    if message =~ pattern
      val = Regexp === pattern ? pattern.inspect : pattern.to_s
      increment_ignore_count(val)
      true
    end
  end

  if Logster.config.enable_custom_patterns_via_ui || allow_custom_patterns
    custom_ignore = @patterns_cache.fetch(Logster::SuppressionPattern::CACHE_KEY) do
      Logster::SuppressionPattern.find_all(store: self)
    end
    return if custom_ignore.any? do |pattern|
      if message =~ pattern
        increment_ignore_count(pattern.inspect)
        true
      end
    end
  end

  similar = nil

  if Logster.config.allow_grouping
    message.apply_message_size_limit(
      Logster.config.maximum_message_size_bytes,
      gems_dir: Logster.config.gems_dir
    )
    key = self.similar_key(message)
    similar = get(key, load_env: false) if key
  end

  message.drop_redundant_envs(Logster.config.max_env_count_per_message)
  message.apply_env_size_limit(Logster.config.max_env_bytes)
  saved = true
  if similar
    similar.merge_similar_message(message)
    replace_and_bump(similar)
    similar
  else
    message.apply_message_size_limit(
      Logster.config.maximum_message_size_bytes,
      gems_dir: Logster.config.gems_dir
    )
    saved = save(message)
    message
  end

  message = similar || message

  if (Logster.config.enable_custom_patterns_via_ui || allow_custom_patterns) && saved
    grouping_patterns = @patterns_cache.fetch(Logster::GroupingPattern::CACHE_KEY) do
      Logster::GroupingPattern.find_all(store: self)
    end

    grouping_patterns.each do |pattern|
      if message =~ pattern
        group = find_pattern_groups() { |pat| pat == pattern }[0]
        group ||= Logster::Group.new(pattern.inspect)
        group.add_message(message)
        save_pattern_group(group) if group.changed?
        break
      end
    end
  end
  message
end

#save(message) ⇒ Object

Save a new message at the front of the latest list.



16
17
18
 
# File 'lib/logster/base_store.rb', line 16

def save(message)
  not_implemented
end

#save_pattern_group(group) ⇒ Object

saves an instance of Logster::Group



142
143
144
 
# File 'lib/logster/base_store.rb', line 142

def save_pattern_group(group)
  not_implemented
end

#similar_key(message) ⇒ Object

Check if another message with the same grouping_key is already stored. Returns the similar message’s message.key



27
28
29
 
# File 'lib/logster/base_store.rb', line 27

def similar_key(message)
  not_implemented
end

#solve(message_key) ⇒ Object

Solve a particular message, causing all old messages with matching version and backtrace to be deleted (report should delete any solved messages when called)



87
88
89
 
# File 'lib/logster/base_store.rb', line 87

def solve(message_key)
  not_implemented
end

#unprotect(message_key) ⇒ Object

Clear the protected mark for a message.



81
82
83
 
# File 'lib/logster/base_store.rb', line 81

def unprotect(message_key)
  not_implemented
end