log.go 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. // mgo - MongoDB driver for Go
  2. //
  3. // Copyright (c) 2010-2012 - Gustavo Niemeyer <gustavo@niemeyer.net>
  4. //
  5. // All rights reserved.
  6. //
  7. // Redistribution and use in source and binary forms, with or without
  8. // modification, are permitted provided that the following conditions are met:
  9. //
  10. // 1. Redistributions of source code must retain the above copyright notice, this
  11. // list of conditions and the following disclaimer.
  12. // 2. Redistributions in binary form must reproduce the above copyright notice,
  13. // this list of conditions and the following disclaimer in the documentation
  14. // and/or other materials provided with the distribution.
  15. //
  16. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  17. // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  20. // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. package mgo
  27. import (
  28. "fmt"
  29. "sync"
  30. )
  31. // ---------------------------------------------------------------------------
  32. // Logging integration.
  33. // Avoid importing the log type information unnecessarily. There's a small cost
  34. // associated with using an interface rather than the type. Depending on how
  35. // often the logger is plugged in, it would be worth using the type instead.
  36. type log_Logger interface {
  37. Output(calldepth int, s string) error
  38. }
  39. var (
  40. globalLogger log_Logger
  41. globalDebug bool
  42. globalMutex sync.Mutex
  43. )
  44. // RACE WARNING: There are known data races when logging, which are manually
  45. // silenced when the race detector is in use. These data races won't be
  46. // observed in typical use, because logging is supposed to be set up once when
  47. // the application starts. Having raceDetector as a constant, the compiler
  48. // should elide the locks altogether in actual use.
  49. // Specify the *log.Logger object where log messages should be sent to.
  50. func SetLogger(logger log_Logger) {
  51. if raceDetector {
  52. globalMutex.Lock()
  53. defer globalMutex.Unlock()
  54. }
  55. globalLogger = logger
  56. }
  57. // Enable the delivery of debug messages to the logger. Only meaningful
  58. // if a logger is also set.
  59. func SetDebug(debug bool) {
  60. if raceDetector {
  61. globalMutex.Lock()
  62. defer globalMutex.Unlock()
  63. }
  64. globalDebug = debug
  65. }
  66. func log(v ...interface{}) {
  67. if raceDetector {
  68. globalMutex.Lock()
  69. defer globalMutex.Unlock()
  70. }
  71. if globalLogger != nil {
  72. globalLogger.Output(2, fmt.Sprint(v...))
  73. }
  74. }
  75. func logln(v ...interface{}) {
  76. if raceDetector {
  77. globalMutex.Lock()
  78. defer globalMutex.Unlock()
  79. }
  80. if globalLogger != nil {
  81. globalLogger.Output(2, fmt.Sprintln(v...))
  82. }
  83. }
  84. func logf(format string, v ...interface{}) {
  85. if raceDetector {
  86. globalMutex.Lock()
  87. defer globalMutex.Unlock()
  88. }
  89. if globalLogger != nil {
  90. globalLogger.Output(2, fmt.Sprintf(format, v...))
  91. }
  92. }
  93. func debug(v ...interface{}) {
  94. if raceDetector {
  95. globalMutex.Lock()
  96. defer globalMutex.Unlock()
  97. }
  98. if globalDebug && globalLogger != nil {
  99. globalLogger.Output(2, fmt.Sprint(v...))
  100. }
  101. }
  102. func debugln(v ...interface{}) {
  103. if raceDetector {
  104. globalMutex.Lock()
  105. defer globalMutex.Unlock()
  106. }
  107. if globalDebug && globalLogger != nil {
  108. globalLogger.Output(2, fmt.Sprintln(v...))
  109. }
  110. }
  111. func debugf(format string, v ...interface{}) {
  112. if raceDetector {
  113. globalMutex.Lock()
  114. defer globalMutex.Unlock()
  115. }
  116. if globalDebug && globalLogger != nil {
  117. globalLogger.Output(2, fmt.Sprintf(format, v...))
  118. }
  119. }