__init__.py 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. # Copyright The OpenTelemetry Authors
  2. # SPDX-License-Identifier: Apache-2.0
  3. """
  4. The OpenTelemetry logging API describes the classes used to generate logs and events.
  5. The :class:`.LoggerProvider` provides users access to the :class:`.Logger`.
  6. This module provides abstract (i.e. unimplemented) classes required for
  7. logging, and a concrete no-op implementation :class:`.NoOpLogger` that allows applications
  8. to use the API package alone without a supporting implementation.
  9. To get a logger, you need to provide the package name from which you are
  10. calling the logging APIs to OpenTelemetry by calling `LoggerProvider.get_logger`
  11. with the calling module name and the version of your package.
  12. The following code shows how to obtain a logger using the global :class:`.LoggerProvider`::
  13. from opentelemetry._logs import get_logger
  14. logger = get_logger("example-logger")
  15. .. versionadded:: 1.15.0
  16. """
  17. from opentelemetry._logs._internal import (
  18. Logger,
  19. LoggerProvider,
  20. LogRecord,
  21. NoOpLogger,
  22. NoOpLoggerProvider,
  23. get_logger,
  24. get_logger_provider,
  25. set_logger_provider,
  26. )
  27. from opentelemetry._logs.severity import SeverityNumber
  28. __all__ = [
  29. "Logger",
  30. "LoggerProvider",
  31. "LogRecord",
  32. "NoOpLogger",
  33. "NoOpLoggerProvider",
  34. "get_logger",
  35. "get_logger_provider",
  36. "set_logger_provider",
  37. "SeverityNumber",
  38. ]