provider.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. // Copyright The OpenTelemetry Authors
  2. // SPDX-License-Identifier: Apache-2.0
  3. #pragma once
  4. #include <mutex>
  5. #include "opentelemetry/common/macros.h"
  6. #include "opentelemetry/common/spin_lock_mutex.h"
  7. #include "opentelemetry/logs/noop.h"
  8. #include "opentelemetry/nostd/shared_ptr.h"
  9. #include "opentelemetry/version.h"
  10. OPENTELEMETRY_BEGIN_NAMESPACE
  11. namespace logs
  12. {
  13. #if OPENTELEMETRY_ABI_VERSION_NO < 2
  14. class EventLoggerProvider;
  15. #endif
  16. class LoggerProvider;
  17. /**
  18. * Stores the singleton global LoggerProvider.
  19. */
  20. class OPENTELEMETRY_EXPORT Provider
  21. {
  22. public:
  23. /**
  24. * Returns the singleton LoggerProvider.
  25. *
  26. * By default, a no-op LoggerProvider is returned. This will never return a
  27. * nullptr LoggerProvider.
  28. */
  29. static nostd::shared_ptr<LoggerProvider> GetLoggerProvider() noexcept
  30. {
  31. std::lock_guard<common::SpinLockMutex> guard(GetLock());
  32. return nostd::shared_ptr<LoggerProvider>(GetProvider());
  33. }
  34. /**
  35. * Changes the singleton LoggerProvider.
  36. */
  37. static void SetLoggerProvider(const nostd::shared_ptr<LoggerProvider> &tp) noexcept
  38. {
  39. std::lock_guard<common::SpinLockMutex> guard(GetLock());
  40. GetProvider() = tp;
  41. }
  42. #if OPENTELEMETRY_ABI_VERSION_NO < 2
  43. /**
  44. * Returns the singleton EventLoggerProvider.
  45. *
  46. * By default, a no-op EventLoggerProvider is returned. This will never return a
  47. * nullptr EventLoggerProvider.
  48. */
  49. OPENTELEMETRY_DEPRECATED static nostd::shared_ptr<EventLoggerProvider>
  50. GetEventLoggerProvider() noexcept
  51. {
  52. std::lock_guard<common::SpinLockMutex> guard(GetLock());
  53. return nostd::shared_ptr<EventLoggerProvider>(GetEventProvider());
  54. }
  55. /**
  56. * Changes the singleton EventLoggerProvider.
  57. */
  58. OPENTELEMETRY_DEPRECATED static void SetEventLoggerProvider(
  59. const nostd::shared_ptr<EventLoggerProvider> &tp) noexcept
  60. {
  61. std::lock_guard<common::SpinLockMutex> guard(GetLock());
  62. GetEventProvider() = tp;
  63. }
  64. #endif
  65. private:
  66. OPENTELEMETRY_API_SINGLETON static nostd::shared_ptr<LoggerProvider> &GetProvider() noexcept
  67. {
  68. static nostd::shared_ptr<LoggerProvider> provider(new NoopLoggerProvider);
  69. return provider;
  70. }
  71. #if OPENTELEMETRY_ABI_VERSION_NO < 2
  72. OPENTELEMETRY_DEPRECATED
  73. OPENTELEMETRY_API_SINGLETON static nostd::shared_ptr<EventLoggerProvider> &
  74. GetEventProvider() noexcept
  75. {
  76. static nostd::shared_ptr<EventLoggerProvider> provider(new NoopEventLoggerProvider);
  77. return provider;
  78. }
  79. #endif
  80. OPENTELEMETRY_API_SINGLETON static common::SpinLockMutex &GetLock() noexcept
  81. {
  82. static common::SpinLockMutex lock;
  83. return lock;
  84. }
  85. };
  86. } // namespace logs
  87. OPENTELEMETRY_END_NAMESPACE