core.otlp
=========

.. py:module:: core.otlp

.. autoapi-nested-parse::

   Elegant OTLP integration for jobmon that prevents global log pollution.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/core/otlp/formatters/index
   /autoapi/core/otlp/handlers/index
   /autoapi/core/otlp/manager/index
   /autoapi/core/otlp/resources/index
   /autoapi/core/otlp/utils/index
   /autoapi/core/otlp/validation/index


Attributes
----------

.. autoapisummary::

   core.otlp.OTLP_AVAILABLE
   core.otlp.OpenTelemetryLogFormatter


Classes
-------

.. autoapisummary::

   core.otlp.JobmonOTLPFormatter
   core.otlp.JobmonOTLPLoggingHandler
   core.otlp.JobmonOTLPStructlogHandler


Functions
---------

.. autoapisummary::

   core.otlp.add_span_details_processor
   core.otlp.get_current_span_details


Package Contents
----------------

.. py:data:: OTLP_AVAILABLE
   :value: True


.. py:class:: JobmonOTLPFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

   Bases: :py:obj:`logging.Formatter`


   Formatter that adds OpenTelemetry span details to jobmon logs.


   .. py:method:: format(record: logging.LogRecord) -> str

      Format log record with OpenTelemetry span details.



.. py:class:: JobmonOTLPLoggingHandler(level: int = logging.NOTSET, exporter: Optional[Union[Any, Dict]] = None)

   Bases: :py:obj:`logging.Handler`


   Universal OTLP logging handler supporting dict configs and pre-configured exporters.

   This handler follows the principle of single responsibility while being flexible enough
   to work with different configuration patterns:

   1. Inline dict configuration (server pattern):
       handlers:
         otlp_logs:
           class: jobmon.core.otlp.JobmonOTLPLoggingHandler
           level: INFO
           exporter:
             module: opentelemetry.exporter.otlp.proto.grpc._log_exporter
             class: OTLPLogExporter
             endpoint: otelcol.dev.aks.scicomp.ihme.washington.edu:443
             options: [["grpc.max_send_message_length", 16777216]]
             max_export_batch_size: 8

   2. Pre-configured exporter instance:
       handler = JobmonOTLPLoggingHandler(exporter=my_exporter)


   .. py:attribute:: _exporter_config
      :value: None



   .. py:attribute:: _otlp_handler
      :type:  Optional[logging.Handler]
      :value: None



   .. py:attribute:: _debug_mode


   .. py:method:: emit(record: logging.LogRecord) -> None

      Emit a log record to OTLP.



   .. py:method:: _create_handler() -> Optional[logging.Handler]

      Create OTLP handler by processing the exporter configuration.



   .. py:method:: _create_exporter_from_dict(config: Any) -> Optional[Any]

      Create an OTLP exporter from dictionary configuration (handles ConvertingDict).



   .. py:method:: _create_processor_from_dict(exporter: Any, config: Any) -> Any

      Create a batch processor with configuration from dict (handles ConvertingDict).



.. py:class:: JobmonOTLPStructlogHandler(level: int = logging.NOTSET, exporter: Optional[Union[Any, Dict]] = None)

   Bases: :py:obj:`JobmonOTLPLoggingHandler`


   OTLP logging handler with structlog formatting for structured logs.

   This handler extends JobmonOTLPLoggingHandler to provide structured logging
   using structlog formatting before sending to OTLP.


.. py:function:: add_span_details_processor(logger: Any, method_name: str, event_dict: Dict[str, Any]) -> Dict[str, Any]

   Structlog processor to add OpenTelemetry span details to log entries.

   :param logger: The logger instance (not used, but required by Structlog processor signature).
   :param method_name: The logging method name (e.g., "info", "debug").
   :param event_dict: The event dictionary representing the log entry.

   :returns: The modified event dictionary with OpenTelemetry span details added.


.. py:function:: get_current_span_details() -> Tuple[Optional[str], Optional[str], Optional[str]]

   Get details of the current OpenTelemetry span.

   :returns: Tuple of (span_id, trace_id, parent_span_id) as hex strings, or (None, None, None)


.. py:data:: OpenTelemetryLogFormatter