convenience.go 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. // Copyright (C) 2014 Space Monkey, Inc.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package spacelog
  15. import (
  16. "fmt"
  17. "io"
  18. )
  19. // Trace logs a collection of values if the logger's level is trace or even
  20. // more permissive.
  21. func (l *Logger) Trace(v ...interface{}) {
  22. if l.getLevel() <= Trace {
  23. l.getHandler().Log(l.name, Trace, fmt.Sprint(v...), 1)
  24. }
  25. }
  26. // Tracef logs a format string with values if the logger's level is trace or
  27. // even more permissive.
  28. func (l *Logger) Tracef(format string, v ...interface{}) {
  29. if l.getLevel() <= Trace {
  30. l.getHandler().Log(l.name, Trace, fmt.Sprintf(format, v...), 1)
  31. }
  32. }
  33. // Tracee logs an error value if the error is not nil and the logger's level
  34. // is trace or even more permissive.
  35. func (l *Logger) Tracee(err error) {
  36. if l.getLevel() <= Trace && err != nil {
  37. l.getHandler().Log(l.name, Trace, err.Error(), 1)
  38. }
  39. }
  40. // TraceEnabled returns true if the logger's level is trace or even more
  41. // permissive.
  42. func (l *Logger) TraceEnabled() bool {
  43. return l.getLevel() <= Trace
  44. }
  45. // Debug logs a collection of values if the logger's level is debug or even
  46. // more permissive.
  47. func (l *Logger) Debug(v ...interface{}) {
  48. if l.getLevel() <= Debug {
  49. l.getHandler().Log(l.name, Debug, fmt.Sprint(v...), 1)
  50. }
  51. }
  52. // Debugf logs a format string with values if the logger's level is debug or
  53. // even more permissive.
  54. func (l *Logger) Debugf(format string, v ...interface{}) {
  55. if l.getLevel() <= Debug {
  56. l.getHandler().Log(l.name, Debug, fmt.Sprintf(format, v...), 1)
  57. }
  58. }
  59. // Debuge logs an error value if the error is not nil and the logger's level
  60. // is debug or even more permissive.
  61. func (l *Logger) Debuge(err error) {
  62. if l.getLevel() <= Debug && err != nil {
  63. l.getHandler().Log(l.name, Debug, err.Error(), 1)
  64. }
  65. }
  66. // DebugEnabled returns true if the logger's level is debug or even more
  67. // permissive.
  68. func (l *Logger) DebugEnabled() bool {
  69. return l.getLevel() <= Debug
  70. }
  71. // Info logs a collection of values if the logger's level is info or even
  72. // more permissive.
  73. func (l *Logger) Info(v ...interface{}) {
  74. if l.getLevel() <= Info {
  75. l.getHandler().Log(l.name, Info, fmt.Sprint(v...), 1)
  76. }
  77. }
  78. // Infof logs a format string with values if the logger's level is info or
  79. // even more permissive.
  80. func (l *Logger) Infof(format string, v ...interface{}) {
  81. if l.getLevel() <= Info {
  82. l.getHandler().Log(l.name, Info, fmt.Sprintf(format, v...), 1)
  83. }
  84. }
  85. // Infoe logs an error value if the error is not nil and the logger's level
  86. // is info or even more permissive.
  87. func (l *Logger) Infoe(err error) {
  88. if l.getLevel() <= Info && err != nil {
  89. l.getHandler().Log(l.name, Info, err.Error(), 1)
  90. }
  91. }
  92. // InfoEnabled returns true if the logger's level is info or even more
  93. // permissive.
  94. func (l *Logger) InfoEnabled() bool {
  95. return l.getLevel() <= Info
  96. }
  97. // Notice logs a collection of values if the logger's level is notice or even
  98. // more permissive.
  99. func (l *Logger) Notice(v ...interface{}) {
  100. if l.getLevel() <= Notice {
  101. l.getHandler().Log(l.name, Notice, fmt.Sprint(v...), 1)
  102. }
  103. }
  104. // Noticef logs a format string with values if the logger's level is notice or
  105. // even more permissive.
  106. func (l *Logger) Noticef(format string, v ...interface{}) {
  107. if l.getLevel() <= Notice {
  108. l.getHandler().Log(l.name, Notice, fmt.Sprintf(format, v...), 1)
  109. }
  110. }
  111. // Noticee logs an error value if the error is not nil and the logger's level
  112. // is notice or even more permissive.
  113. func (l *Logger) Noticee(err error) {
  114. if l.getLevel() <= Notice && err != nil {
  115. l.getHandler().Log(l.name, Notice, err.Error(), 1)
  116. }
  117. }
  118. // NoticeEnabled returns true if the logger's level is notice or even more
  119. // permissive.
  120. func (l *Logger) NoticeEnabled() bool {
  121. return l.getLevel() <= Notice
  122. }
  123. // Warn logs a collection of values if the logger's level is warning or even
  124. // more permissive.
  125. func (l *Logger) Warn(v ...interface{}) {
  126. if l.getLevel() <= Warning {
  127. l.getHandler().Log(l.name, Warning, fmt.Sprint(v...), 1)
  128. }
  129. }
  130. // Warnf logs a format string with values if the logger's level is warning or
  131. // even more permissive.
  132. func (l *Logger) Warnf(format string, v ...interface{}) {
  133. if l.getLevel() <= Warning {
  134. l.getHandler().Log(l.name, Warning, fmt.Sprintf(format, v...), 1)
  135. }
  136. }
  137. // Warne logs an error value if the error is not nil and the logger's level
  138. // is warning or even more permissive.
  139. func (l *Logger) Warne(err error) {
  140. if l.getLevel() <= Warning && err != nil {
  141. l.getHandler().Log(l.name, Warning, err.Error(), 1)
  142. }
  143. }
  144. // WarnEnabled returns true if the logger's level is warning or even more
  145. // permissive.
  146. func (l *Logger) WarnEnabled() bool {
  147. return l.getLevel() <= Warning
  148. }
  149. // Error logs a collection of values if the logger's level is error or even
  150. // more permissive.
  151. func (l *Logger) Error(v ...interface{}) {
  152. if l.getLevel() <= Error {
  153. l.getHandler().Log(l.name, Error, fmt.Sprint(v...), 1)
  154. }
  155. }
  156. // Errorf logs a format string with values if the logger's level is error or
  157. // even more permissive.
  158. func (l *Logger) Errorf(format string, v ...interface{}) {
  159. if l.getLevel() <= Error {
  160. l.getHandler().Log(l.name, Error, fmt.Sprintf(format, v...), 1)
  161. }
  162. }
  163. // Errore logs an error value if the error is not nil and the logger's level
  164. // is error or even more permissive.
  165. func (l *Logger) Errore(err error) {
  166. if l.getLevel() <= Error && err != nil {
  167. l.getHandler().Log(l.name, Error, err.Error(), 1)
  168. }
  169. }
  170. // ErrorEnabled returns true if the logger's level is error or even more
  171. // permissive.
  172. func (l *Logger) ErrorEnabled() bool {
  173. return l.getLevel() <= Error
  174. }
  175. // Crit logs a collection of values if the logger's level is critical or even
  176. // more permissive.
  177. func (l *Logger) Crit(v ...interface{}) {
  178. if l.getLevel() <= Critical {
  179. l.getHandler().Log(l.name, Critical, fmt.Sprint(v...), 1)
  180. }
  181. }
  182. // Critf logs a format string with values if the logger's level is critical or
  183. // even more permissive.
  184. func (l *Logger) Critf(format string, v ...interface{}) {
  185. if l.getLevel() <= Critical {
  186. l.getHandler().Log(l.name, Critical, fmt.Sprintf(format, v...), 1)
  187. }
  188. }
  189. // Crite logs an error value if the error is not nil and the logger's level
  190. // is critical or even more permissive.
  191. func (l *Logger) Crite(err error) {
  192. if l.getLevel() <= Critical && err != nil {
  193. l.getHandler().Log(l.name, Critical, err.Error(), 1)
  194. }
  195. }
  196. // CritEnabled returns true if the logger's level is critical or even more
  197. // permissive.
  198. func (l *Logger) CritEnabled() bool {
  199. return l.getLevel() <= Critical
  200. }
  201. // Log logs a collection of values if the logger's level is the provided level
  202. // or even more permissive.
  203. func (l *Logger) Log(level LogLevel, v ...interface{}) {
  204. if l.getLevel() <= level {
  205. l.getHandler().Log(l.name, level, fmt.Sprint(v...), 1)
  206. }
  207. }
  208. // Logf logs a format string with values if the logger's level is the provided
  209. // level or even more permissive.
  210. func (l *Logger) Logf(level LogLevel, format string, v ...interface{}) {
  211. if l.getLevel() <= level {
  212. l.getHandler().Log(l.name, level, fmt.Sprintf(format, v...), 1)
  213. }
  214. }
  215. // Loge logs an error value if the error is not nil and the logger's level
  216. // is the provided level or even more permissive.
  217. func (l *Logger) Loge(level LogLevel, err error) {
  218. if l.getLevel() <= level && err != nil {
  219. l.getHandler().Log(l.name, level, err.Error(), 1)
  220. }
  221. }
  222. // LevelEnabled returns true if the logger's level is the provided level or
  223. // even more permissive.
  224. func (l *Logger) LevelEnabled(level LogLevel) bool {
  225. return l.getLevel() <= level
  226. }
  227. type writer struct {
  228. l *Logger
  229. level LogLevel
  230. }
  231. func (w *writer) Write(data []byte) (int, error) {
  232. if w.l.getLevel() <= w.level {
  233. w.l.getHandler().Log(w.l.name, w.level, string(data), 1)
  234. }
  235. return len(data), nil
  236. }
  237. // Writer returns an io.Writer that writes messages at the given log level.
  238. func (l *Logger) Writer(level LogLevel) io.Writer {
  239. return &writer{l: l, level: level}
  240. }
  241. type writerNoCaller struct {
  242. l *Logger
  243. level LogLevel
  244. }
  245. func (w *writerNoCaller) Write(data []byte) (int, error) {
  246. if w.l.getLevel() <= w.level {
  247. w.l.getHandler().Log(w.l.name, w.level, string(data), -1)
  248. }
  249. return len(data), nil
  250. }
  251. // WriterWithoutCaller returns an io.Writer that writes messages at the given
  252. // log level, but does not attempt to collect the Write caller, and provides
  253. // no caller information to the log event.
  254. func (l *Logger) WriterWithoutCaller(level LogLevel) io.Writer {
  255. return &writerNoCaller{l: l, level: level}
  256. }