debug.go 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. // Copyright 2015 go-swagger maintainers
  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 spec
  15. import (
  16. "fmt"
  17. "log"
  18. "os"
  19. "path"
  20. "runtime"
  21. )
  22. // Debug is true when the SWAGGER_DEBUG env var is not empty.
  23. //
  24. // It enables a more verbose logging of this package.
  25. var Debug = os.Getenv("SWAGGER_DEBUG") != ""
  26. var (
  27. // specLogger is a debug logger for this package
  28. specLogger *log.Logger
  29. )
  30. func init() {
  31. debugOptions()
  32. }
  33. func debugOptions() {
  34. specLogger = log.New(os.Stdout, "spec:", log.LstdFlags)
  35. }
  36. func debugLog(msg string, args ...interface{}) {
  37. // A private, trivial trace logger, based on go-openapi/spec/expander.go:debugLog()
  38. if Debug {
  39. _, file1, pos1, _ := runtime.Caller(1)
  40. specLogger.Printf("%s:%d: %s", path.Base(file1), pos1, fmt.Sprintf(msg, args...))
  41. }
  42. }