Skip to content

Commit f1026b8

Browse files
codemediccodemedic
committed
Add golog as alias for all log from this module
Also a minor nil reference fix.
1 parent 409b1c2 commit f1026b8

File tree

5 files changed

+160
-106
lines changed

5 files changed

+160
-106
lines changed

Diff for: ‎doc_test.go

+120-72
Original file line numberDiff line numberDiff line change
@@ -6,62 +6,72 @@ import (
66
"math/rand"
77
"os"
88

9-
"github.com/codemedic/go-log"
9+
golog "github.com/codemedic/go-log"
1010
)
1111

1212
func ExampleNewStderr() {
13-
l := log.Must(log.NewStderr(
14-
log.OptionsMust(log.Options(
15-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
16-
log.WithUTCTimestampFromEnv("LOG_UTC", true),
17-
log.WithSourceLocationDisabled,
18-
log.WithMicrosecondsTimestamp,
13+
// import golog "github.com/codemedic/go-log"
14+
15+
l := golog.Must(golog.NewStderr(
16+
golog.OptionsMust(golog.Options(
17+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
18+
golog.WithUTCTimestampFromEnv("LOG_UTC", true),
19+
golog.WithSourceLocationDisabled,
20+
golog.WithMicrosecondsTimestamp,
1921
))))
2022

2123
defer l.Close()
2224
}
2325

2426
func ExampleNewStdout() {
25-
l := log.Must(log.NewStdout(
26-
log.OptionsMust(log.Options(
27-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
28-
log.WithUTCTimestampFromEnv("LOG_UTC", true),
29-
log.WithSourceLocationLong,
30-
log.WithMicrosecondsTimestamp,
27+
// import golog "github.com/codemedic/go-log"
28+
29+
l := golog.Must(golog.NewStdout(
30+
golog.OptionsMust(golog.Options(
31+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
32+
golog.WithUTCTimestampFromEnv("LOG_UTC", true),
33+
golog.WithSourceLocationLong,
34+
golog.WithMicrosecondsTimestamp,
3135
))))
3236

3337
defer l.Close()
3438
}
3539

3640
func ExampleNewLogfile() {
37-
l := log.Must(log.NewLogfile("/tmp/test-logfile.log", 0644,
38-
log.OptionsMust(log.Options(
39-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
40-
log.WithUTCTimestampFromEnv("LOG_UTC", true),
41-
log.WithSourceLocationFromEnv("LOG_SOURCE_LOCATION", "short"),
42-
log.WithMicrosecondsTimestamp,
41+
// import golog "github.com/codemedic/go-log"
42+
43+
l := golog.Must(golog.NewLogfile("/tmp/test-logfile.log", 0644,
44+
golog.OptionsMust(golog.Options(
45+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
46+
golog.WithUTCTimestampFromEnv("LOG_UTC", true),
47+
golog.WithSourceLocationFromEnv("LOG_SOURCE_LOCATION", "short"),
48+
golog.WithMicrosecondsTimestamp,
4349
))))
4450

4551
defer l.Close()
4652
}
4753

4854
func ExampleNewSyslog() {
49-
l := log.Must(log.NewSyslog(
50-
log.OptionsMust(log.Options(
55+
// import golog "github.com/codemedic/go-log"
56+
57+
l := golog.Must(golog.NewSyslog(
58+
golog.OptionsMust(golog.Options(
5159
// set the log-level dynamically from the environment
52-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
60+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
5361
// set the syslog tag
54-
log.WithSyslogTag("test-syslog"),
62+
golog.WithSyslogTag("test-syslog"),
5563
// write to syslog server over UDP
56-
log.WithSyslogDaemonURL("udp://syslog.acme.com:514"),
64+
golog.WithSyslogDaemonURL("udp://syslog.acme.com:514"),
5765
))))
5866

5967
defer l.Close()
6068
}
6169

6270
func ExampleWithLevel() {
63-
l := log.Must(log.NewSyslog(
64-
log.WithLevel(log.Info),
71+
// import golog "github.com/codemedic/go-log"
72+
73+
l := golog.Must(golog.NewSyslog(
74+
golog.WithLevel(golog.Info),
6575
))
6676

6777
defer l.Close()
@@ -71,8 +81,10 @@ func ExampleWithLevel() {
7181
}
7282

7383
func ExampleWithPrintLevel() {
74-
l := log.Must(log.NewSyslog(
75-
log.WithPrintLevel(log.Info),
84+
// import golog "github.com/codemedic/go-log"
85+
86+
l := golog.Must(golog.NewSyslog(
87+
golog.WithPrintLevel(golog.Info),
7688
))
7789

7890
defer l.Close()
@@ -81,158 +93,194 @@ func ExampleWithPrintLevel() {
8193
}
8294

8395
func ExampleWithSourceLocationDisabled() {
84-
l := log.Must(log.NewSyslog(
85-
log.WithSourceLocationDisabled(),
96+
// import golog "github.com/codemedic/go-log"
97+
98+
l := golog.Must(golog.NewSyslog(
99+
golog.WithSourceLocationDisabled(),
86100
))
87101

88102
defer l.Close()
89103
}
90104

91105
func ExampleWithSourceLocationLong() {
92-
l := log.Must(log.NewSyslog(
93-
log.WithSourceLocationLong(),
106+
// import golog "github.com/codemedic/go-log"
107+
108+
l := golog.Must(golog.NewSyslog(
109+
golog.WithSourceLocationLong(),
94110
))
95111

96112
defer l.Close()
97113
}
98114

99115
func ExampleWithSourceLocationShort() {
100-
l := log.Must(log.NewSyslog(
101-
log.WithSourceLocationShort(),
116+
// import golog "github.com/codemedic/go-log"
117+
118+
l := golog.Must(golog.NewSyslog(
119+
golog.WithSourceLocationShort(),
102120
))
103121

104122
defer l.Close()
105123
}
106124

107125
func ExampleWithSourceLocationFromEnv() {
108-
l := log.Must(log.NewSyslog(log.OptionsMust(log.Options(
109-
log.WithSourceLocationFromEnv("LOG_CALLER_LOCATION", "short"),
126+
// import golog "github.com/codemedic/go-log"
127+
128+
l := golog.Must(golog.NewSyslog(golog.OptionsMust(golog.Options(
129+
golog.WithSourceLocationFromEnv("LOG_CALLER_LOCATION", "short"),
110130
))))
111131

112132
defer l.Close()
113133
}
114134

115135
func ExampleWithMicrosecondsTimestamp() {
116-
l := log.Must(log.NewSyslog(
117-
log.WithMicrosecondsTimestamp(true),
136+
// import golog "github.com/codemedic/go-log"
137+
138+
l := golog.Must(golog.NewSyslog(
139+
golog.WithMicrosecondsTimestamp(true),
118140
))
119141

120142
defer l.Close()
121143
}
122144

123145
func ExampleWithMicrosecondsTimestampFromEnv() {
124-
l := log.Must(log.NewSyslog(log.OptionsMust(log.Options(
125-
log.WithMicrosecondsTimestampFromEnv("LOG_MICROSECOND_TIMESTAMP", true),
146+
// import golog "github.com/codemedic/go-log"
147+
148+
l := golog.Must(golog.NewSyslog(golog.OptionsMust(golog.Options(
149+
golog.WithMicrosecondsTimestampFromEnv("LOG_MICROSECOND_TIMESTAMP", true),
126150
))))
127151

128152
defer l.Close()
129153
}
130154

131155
func ExampleOptions() {
132-
l := log.Must(log.NewSyslog(
133-
log.OptionsMust(
134-
log.Options(
135-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
136-
log.WithMicrosecondsTimestamp))))
156+
// import golog "github.com/codemedic/go-log"
157+
158+
l := golog.Must(golog.NewSyslog(
159+
golog.OptionsMust(
160+
golog.Options(
161+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
162+
golog.WithMicrosecondsTimestamp))))
137163

138164
defer l.Close()
139165
}
140166

141167
func ExampleOptionsMust() {
142-
l := log.Must(log.NewSyslog(
143-
log.OptionsMust(
144-
log.Options(
145-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
146-
log.WithMicrosecondsTimestamp))))
168+
// import golog "github.com/codemedic/go-log"
169+
170+
l := golog.Must(golog.NewSyslog(
171+
golog.OptionsMust(
172+
golog.Options(
173+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
174+
golog.WithMicrosecondsTimestamp))))
147175

148176
defer l.Close()
149177
}
150178

151179
func ExampleWithStdlogHandler() {
152-
l := log.Must(log.NewSyslog(
153-
log.WithStdlogHandler(false),
180+
// import golog "github.com/codemedic/go-log"
181+
182+
l := golog.Must(golog.NewSyslog(
183+
golog.WithStdlogHandler(false),
154184
))
155185

156186
defer l.Close()
157187
}
158188

159189
func ExampleWithStdlogSorter() {
160-
l, _ := log.NewSyslog(log.WithStdlogSorter(func(b []byte) log.Level {
190+
// import golog "github.com/codemedic/go-log"
191+
192+
l, _ := golog.NewSyslog(golog.WithStdlogSorter(func(b []byte) golog.Level {
161193
switch {
162194
case bytes.HasPrefix(b, []byte("WARNING")):
163195
fallthrough
164196
case bytes.HasPrefix(b, []byte("ERROR")):
165-
return log.Warning // ERROR and WARNING lines as Warning
197+
return golog.Warning // ERROR and WARNING lines as Warning
166198
case bytes.HasPrefix(b, []byte("INFO")):
167199
fallthrough
168200
case bytes.HasPrefix(b, []byte("DEBUG")):
169-
return log.Disabled // disable DEBUG & INFO lines
201+
return golog.Disabled // disable DEBUG & INFO lines
170202
default:
171-
return log.Info // everything else as Info
203+
return golog.Info // everything else as Info
172204
}
173205
}))
174206

175207
defer l.Close()
176208
}
177209

178210
func ExampleWithSyslogTag() {
179-
l := log.Must(log.NewSyslog(
180-
log.WithSyslogTag("my-app-name"),
211+
// import golog "github.com/codemedic/go-log"
212+
213+
l := golog.Must(golog.NewSyslog(
214+
golog.WithSyslogTag("my-app-name"),
181215
))
182216

183217
defer l.Close()
184218
}
185219

186-
func ExampleWithSyslogDaemonURL_udp() {
187-
l := log.Must(log.NewSyslog(
188-
log.WithSyslogDaemonURL("udp://syslog.acme.com:514"),
220+
func ExampleWithSyslogDaemonURL_uDP() {
221+
// import golog "github.com/codemedic/go-log"
222+
223+
l := golog.Must(golog.NewSyslog(
224+
golog.WithSyslogDaemonURL("udp://syslog.acme.com:514"),
189225
))
190226

191227
defer l.Close()
192228
}
193229

194230
func ExampleWithSyslogDaemonURL_local() {
195-
l := log.Must(log.NewSyslog(
196-
log.WithSyslogDaemonURL("unixgram:///dev/log"),
231+
// import golog "github.com/codemedic/go-log"
232+
233+
l := golog.Must(golog.NewSyslog(
234+
golog.WithSyslogDaemonURL("unixgram:///dev/log"),
197235
))
198236

199237
defer l.Close()
200238
}
201239

202240
func ExampleWithSyslogDaemonURLFromEnv() {
203-
l := log.Must(log.NewSyslog(log.OptionsMust(log.Options(
204-
log.WithSyslogDaemonURLFromEnv("LOG_SERVER", "udp://syslog.acme.com:514"),
241+
// import golog "github.com/codemedic/go-log"
242+
243+
l := golog.Must(golog.NewSyslog(golog.OptionsMust(golog.Options(
244+
golog.WithSyslogDaemonURLFromEnv("LOG_SERVER", "udp://syslog.acme.com:514"),
205245
))))
206246

207247
defer l.Close()
208248
}
209249

210250
func ExampleWithUTCTimestamp() {
211-
l := log.Must(log.NewSyslog(
212-
log.WithUTCTimestamp(true),
251+
// import golog "github.com/codemedic/go-log"
252+
253+
l := golog.Must(golog.NewSyslog(
254+
golog.WithUTCTimestamp(true),
213255
))
214256

215257
defer l.Close()
216258
}
217259

218260
func ExampleWithUTCTimestampFromEnv() {
219-
l := log.Must(log.NewSyslog(log.OptionsMust(log.Options(
220-
log.WithUTCTimestampFromEnv("LOG_UTC", true),
261+
// import golog "github.com/codemedic/go-log"
262+
263+
l := golog.Must(golog.NewSyslog(golog.OptionsMust(golog.Options(
264+
golog.WithUTCTimestampFromEnv("LOG_UTC", true),
221265
))))
222266

223267
defer l.Close()
224268
}
225269

226270
func ExampleWithWriter() {
227-
l := log.Must(log.NewSyslog(
228-
log.WithWriter(os.Stdout),
271+
// import golog "github.com/codemedic/go-log"
272+
273+
l := golog.Must(golog.NewSyslog(
274+
golog.WithWriter(os.Stdout),
229275
))
230276

231277
defer l.Close()
232278
}
233279

234280
func Example() {
235-
l := log.Must(log.NewSyslog())
281+
// import golog "github.com/codemedic/go-log"
282+
283+
l := golog.Must(golog.NewSyslog())
236284
defer l.Close()
237285

238286
l.Debug("debug message")

Diff for: ‎examples/logfile/main.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
package main
22

33
import (
4-
stdlog "log"
4+
"log"
55
"sync"
66

7-
"github.com/codemedic/go-log"
7+
golog "github.com/codemedic/go-log"
88
)
99

1010
func main() {
11-
l := log.Must(log.NewLogfile("/tmp/test-logfile.log", 0644,
12-
log.OptionsMust(log.Options(
13-
log.WithLevelFromEnv("LOG_LEVEL", log.Info),
14-
log.WithUTCTimestampFromEnv("LOG_UTC", true),
15-
log.WithSourceLocationFromEnv("LOG_SOURCE_LOCATION", "short"),
16-
log.WithMicrosecondsTimestamp,
11+
l := golog.Must(golog.NewLogfile("/tmp/test-logfile.log", 0644,
12+
golog.OptionsMust(golog.Options(
13+
golog.WithLevelFromEnv("LOG_LEVEL", golog.Info),
14+
golog.WithUTCTimestampFromEnv("LOG_UTC", true),
15+
golog.WithSourceLocationFromEnv("LOG_SOURCE_LOCATION", "short"),
16+
golog.WithMicrosecondsTimestamp,
1717
))))
1818
defer l.Close()
1919

@@ -31,5 +31,5 @@ func main() {
3131

3232
wg.Wait()
3333

34-
stdlog.Print("done")
34+
log.Print("done")
3535
}

0 commit comments

Comments
 (0)