Skip to content

Commit fdaa017

Browse files
author
Ferdinand Neman
committed
Added readme and some minor housekeeping
1 parent 8da34a9 commit fdaa017

File tree

6 files changed

+43
-60
lines changed

6 files changed

+43
-60
lines changed

‎Engine.go

-42
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ func Trace(str ...interface{}) {
4040
return
4141
}
4242
entry := NewLogEntry(TraceLevel, nil, msg)
43-
if Mask {
44-
entry = entry.Mask()
45-
}
4643
if OutFormat == JSONFormat {
4744
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
4845
} else {
@@ -59,9 +56,6 @@ func Debug(str ...interface{}) {
5956
return
6057
}
6158
entry := NewLogEntry(DebugLevel, nil, fmt.Sprint(str...))
62-
if Mask {
63-
entry = entry.Mask()
64-
}
6559
if OutFormat == JSONFormat {
6660
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
6761
} else {
@@ -78,9 +72,6 @@ func Info(str ...interface{}) {
7872
return
7973
}
8074
entry := NewLogEntry(InfoLevel, nil, fmt.Sprint(str...))
81-
if Mask {
82-
entry = entry.Mask()
83-
}
8475
if OutFormat == JSONFormat {
8576
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
8677
} else {
@@ -97,9 +88,6 @@ func Warn(str ...interface{}) {
9788
return
9889
}
9990
entry := NewLogEntry(WarnLevel, nil, fmt.Sprint(str...))
100-
if Mask {
101-
entry = entry.Mask()
102-
}
10391
if OutFormat == JSONFormat {
10492
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
10593
} else {
@@ -116,9 +104,6 @@ func Error(str ...interface{}) {
116104
return
117105
}
118106
entry := NewLogEntry(ErrorLevel, nil, fmt.Sprint(str...))
119-
if Mask {
120-
entry = entry.Mask()
121-
}
122107
if OutFormat == JSONFormat {
123108
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
124109
} else {
@@ -135,9 +120,6 @@ func Fatal(str ...interface{}) {
135120
return
136121
}
137122
entry := NewLogEntry(FatalLevel, nil, fmt.Sprint(str...))
138-
if Mask {
139-
entry = entry.Mask()
140-
}
141123
if OutFormat == JSONFormat {
142124
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
143125
} else {
@@ -155,9 +137,6 @@ func Tracef(format string, args ...interface{}) {
155137
return
156138
}
157139
entry := NewLogEntryf(TraceLevel, nil, format, args...)
158-
if Mask {
159-
entry = entry.Mask()
160-
}
161140
if OutFormat == JSONFormat {
162141
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
163142
} else {
@@ -174,9 +153,6 @@ func Debugf(format string, args ...interface{}) {
174153
return
175154
}
176155
entry := NewLogEntryf(DebugLevel, nil, format, args...)
177-
if Mask {
178-
entry = entry.Mask()
179-
}
180156
if OutFormat == JSONFormat {
181157
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
182158
} else {
@@ -193,9 +169,6 @@ func Infof(format string, args ...interface{}) {
193169
return
194170
}
195171
entry := NewLogEntryf(InfoLevel, nil, format, args...)
196-
if Mask {
197-
entry = entry.Mask()
198-
}
199172
if OutFormat == JSONFormat {
200173
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
201174
} else {
@@ -212,9 +185,6 @@ func Warnf(format string, args ...interface{}) {
212185
return
213186
}
214187
entry := NewLogEntryf(WarnLevel, nil, format, args...)
215-
if Mask {
216-
entry = entry.Mask()
217-
}
218188
if OutFormat == JSONFormat {
219189
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
220190
} else {
@@ -231,9 +201,6 @@ func Errorf(format string, args ...interface{}) {
231201
return
232202
}
233203
entry := NewLogEntryf(ErrorLevel, nil, format, args...)
234-
if Mask {
235-
entry = entry.Mask()
236-
}
237204
if OutFormat == JSONFormat {
238205
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
239206
} else {
@@ -250,9 +217,6 @@ func Fatalf(format string, args ...interface{}) {
250217
return
251218
}
252219
entry := NewLogEntryf(FatalLevel, nil, format, args...)
253-
if Mask {
254-
entry = entry.Mask()
255-
}
256220
if OutFormat == JSONFormat {
257221
_, _ = GetWriter().Write([]byte(entry.JSONString() + "\n"))
258222
} else {
@@ -281,9 +245,6 @@ type LogEngineImpl struct {
281245

282246
func (engine *LogEngineImpl) toString(lvl LogLevel, mask bool, str string) (string, *LogEntry) {
283247
entry := NewLogEntry(lvl, engine.attributes, str)
284-
if mask {
285-
entry = entry.Mask()
286-
}
287248
if OutFormat == JSONFormat {
288249
return entry.JSONString() + "\n", entry
289250
}
@@ -295,9 +256,6 @@ func (engine *LogEngineImpl) toString(lvl LogLevel, mask bool, str string) (stri
295256

296257
func (engine *LogEngineImpl) toStringf(lvl LogLevel, mask bool, format string, args ...interface{}) (string, *LogEntry) {
297258
entry := NewLogEntryf(lvl, engine.attributes, format, args...)
298-
if mask {
299-
entry = entry.Mask()
300-
}
301259
if OutFormat == JSONFormat {
302260
return entry.JSONString() + "\n", entry
303261
}

‎Hook.go

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package hyperlog
22

33
import (
4+
"fmt"
5+
"os"
46
"sync"
57
)
68

@@ -44,7 +46,10 @@ func Fire(entry *LogEntry) {
4446
for fl, hooks := range hookMap {
4547
if fl&entry.Level.Flag() == entry.Level.Flag() {
4648
for _, hook := range hooks {
47-
hook.FireHook(entry)
49+
err := hook.FireHook(entry)
50+
if err != nil {
51+
_, _ = os.Stderr.WriteString(fmt.Sprintf("error while firing hook. got %s\n", err))
52+
}
4853
}
4954
}
5055
}

‎LogModel.go

-17
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package hyperlog
22

33
import (
4-
"HyperIDP/pkg/masking"
54
"encoding/json"
65
"fmt"
76
"strings"
@@ -91,22 +90,6 @@ type LogEntry struct {
9190
Attributes map[string]string `json:"attrs,omitempty"`
9291
}
9392

94-
func (e *LogEntry) Mask() *LogEntry {
95-
le := &LogEntry{
96-
Level: e.Level,
97-
Time: e.Time,
98-
Message: masking.Default.MaskSentence(e.Message),
99-
Attributes: nil,
100-
}
101-
if e.Attributes != nil && len(e.Attributes) > 0 {
102-
le.Attributes = make(map[string]string)
103-
for k, v := range e.Attributes {
104-
le.Attributes[k] = masking.Default.MaskSentence(v)
105-
}
106-
}
107-
return le
108-
}
109-
11093
func (e *LogEntry) String() string {
11194
ret := make([]string, 0)
11295
ret = append(ret, fmt.Sprintf("[%s]", e.Level))

‎Readme.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Hyperlog
2+
3+
Simple logging framework that works.
4+
It enable the following capabilities:
5+
6+
- Log Level
7+
- JSON Log Output
8+
- Log Hook and triggers on any level
9+
- Shutdown Hook
10+
- Log to any implementation io.Writer
11+
- Writer implementation to write log for rolling based on time
12+
- Writer implementation to write log for rolling based on size
13+
- Log writer with "Attribute" (a.k.a "Field")
14+
- Http middleware to log Request/Response

‎go.mod

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
module hyperlog
22

33
go 1.22
4+
5+
require (
6+
github.com/magiconair/properties v1.8.7
7+
github.com/stretchr/testify v1.9.0
8+
)
9+
10+
require (
11+
github.com/davecgh/go-spew v1.1.1 // indirect
12+
github.com/pmezard/go-difflib v1.0.0 // indirect
13+
gopkg.in/yaml.v3 v3.0.1 // indirect
14+
)

‎go.sum

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
2+
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3+
github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY=
4+
github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
5+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
6+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
7+
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
8+
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
9+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
10+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
11+
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
12+
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

0 commit comments

Comments
 (0)