tagged_objects_logger 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +36 -6
- data/lib/tagged_objects_logger.rb +2 -2
- data/lib/tagged_objects_logger/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7f1052e3d149c69d4a5d2c9e03fd553b39017723d1b882e9f396aff312447e4e
|
|
4
|
+
data.tar.gz: 29651f7516017e60be115bc323ea427edb7d63b808a11ec9232fa62271a7c186
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f3665fac68ae1c26db7ec217402c699136a29e072131f30e07a077d680c6122ff81adb9e1241ff791f983e1ac5878d9bec736ace7d96b7c4e91ae0b16ead59e1
|
|
7
|
+
data.tar.gz: 2d2d9bebbb02f178a8df5849c6b53c3d0cd317fe1af46c67559e2bd249de14c2eeb8c40c80cb5572dc5217063ddd4ac613e534ea10c63f249a6e14ceb634be5b
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -32,21 +32,51 @@ After configuring environment logger variable with TaggedLogger instance you can
|
|
|
32
32
|
This gem tags object by its class name and ID in the log file.
|
|
33
33
|
Log file created in log/[Rails environment].log.
|
|
34
34
|
Log path could be customized by passing log path while intializing TaggedLogger instance ex: TaggedLogger.instance(Log_file_path)
|
|
35
|
-
|
|
35
|
+
|
|
36
|
+
### Methods
|
|
37
|
+
|
|
38
|
+
- #### TaggedLogger .unknown(message, objects_list)
|
|
39
|
+
An unknown message that should always be logged.
|
|
40
|
+
- #### TaggedLogger .fatal(message, objects_list)
|
|
41
|
+
An unhandleable error that results in a program crash.
|
|
42
|
+
- #### TaggedLogger .error(message, objects_list)
|
|
43
|
+
A handleable error condition.
|
|
44
|
+
- #### TaggedLogger .warn(message, objects_list)
|
|
45
|
+
A warning.
|
|
46
|
+
- #### TaggedLogger .info(message, objects_list)
|
|
47
|
+
Generic (useful) information about system operation.
|
|
48
|
+
- #### TaggedLogger .debug(message, objects_list)
|
|
49
|
+
Low-level information for developers.
|
|
50
|
+
|
|
51
|
+
__message__: should be of type String
|
|
52
|
+
__objects_list__: every object should have ID as an attribute
|
|
53
|
+
|
|
54
|
+
An Example of Log file content generated by each of these functions:
|
|
36
55
|
```
|
|
37
56
|
# Logfile created on 2018-07-18 14:59:55 +0200 by logger.rb/61378
|
|
38
|
-
|
|
57
|
+
A, [2018-07-18T14:59:55.708679 #20025] ANY -- : [TestObject_25]: [TestObject_26]: [TestObject_27]: This is unknown message
|
|
58
|
+
|
|
59
|
+
F, [2018-07-18T14:59:55.706860 #20025] FATAL -- : [TestObject_22]: [TestObject_23]: [TestObject_24]: This is a Fatal error
|
|
39
60
|
|
|
40
61
|
E, [2018-07-18T14:59:55.700376 #20025] ERROR -- : [TestObject_16]: [TestObject_17]: [TestObject_18]: This is My Error Message
|
|
41
62
|
|
|
42
|
-
|
|
63
|
+
W, [2018-07-18T14:59:55.710540 #20025] WARN -- : [TestObject_28]: [TestObject_29]: [TestObject_30]: This is just a warning
|
|
43
64
|
|
|
44
|
-
|
|
65
|
+
I, [2018-07-18T14:59:55.698298 #20025] INFO -- : [TestObject_13]: [TestObject_14]: [TestObject_15]: This is My Info Message
|
|
45
66
|
|
|
46
|
-
|
|
67
|
+
D, [2018-07-18T14:59:55.704728 #20025] DEBUG -- : [TestObject_19]: [TestObject_20]: [TestObject_21]: This is My Debug Message
|
|
68
|
+
```
|
|
47
69
|
|
|
48
|
-
|
|
70
|
+
### Log message format
|
|
71
|
+
Assume this message:
|
|
72
|
+
```
|
|
73
|
+
F, [2018-07-18T14:59:55.706860 #20025] FATAL -- : [TestObject_22]: [TestObject_23]: [TestObject_24]: This is a Fatal error
|
|
49
74
|
```
|
|
75
|
+
__F__: A character refer to the type of message, here it refers to Fatal error message
|
|
76
|
+
__2018-07-18T14:59:55.706860 \#20025__: Date and time of the generated message
|
|
77
|
+
__FATAL__: Type of message
|
|
78
|
+
__[TestObject_22]: [TestObject_23]: [TestObject_24]__: the tagged objects, every object written in this form [ClassName_ObjectID]
|
|
79
|
+
__This is a Fatal error__: Text message. Message may include multiple lines
|
|
50
80
|
|
|
51
81
|
## Development
|
|
52
82
|
|
|
@@ -48,7 +48,7 @@ class TaggedLogger < Logger
|
|
|
48
48
|
def tags(objects_list)
|
|
49
49
|
tags = ''
|
|
50
50
|
objects_list.each do |object|
|
|
51
|
-
next if object.nil?
|
|
51
|
+
next if object.nil? || !object.try(:id)
|
|
52
52
|
tags += "[#{object.class}_#{object.id}]: "
|
|
53
53
|
end
|
|
54
54
|
tags
|
|
@@ -56,7 +56,7 @@ class TaggedLogger < Logger
|
|
|
56
56
|
|
|
57
57
|
def parse_message(message, tags)
|
|
58
58
|
tagged_message = ''
|
|
59
|
-
message_lines = message.split("\n")
|
|
59
|
+
message_lines = message.to_s.split("\n")
|
|
60
60
|
message_lines.each do |line|
|
|
61
61
|
tagged_message += (tags + line + "\n")
|
|
62
62
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: tagged_objects_logger
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Truncourist
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-07-
|
|
11
|
+
date: 2018-07-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|