core.logging
============

.. py:module:: core.logging

.. autoapi-nested-parse::

   Jobmon logging helpers for structlog telemetry context management.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/core/logging/context/index


Functions
---------

.. autoapisummary::

   core.logging.bind_jobmon_context
   core.logging.clear_jobmon_context
   core.logging.get_jobmon_context
   core.logging.set_jobmon_context
   core.logging.unset_jobmon_context


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

.. py:function:: bind_jobmon_context(**metadata: Any) -> Iterator[None]

   Context manager that binds Jobmon telemetry metadata temporarily.

   All keys are automatically prefixed with ``telemetry_`` if not already.


.. py:function:: clear_jobmon_context() -> None

   Remove all Jobmon telemetry metadata from the current context.


.. py:function:: get_jobmon_context() -> Dict[str, Any]

   Return a copy of all active Jobmon telemetry metadata.

   Returns all context variables with the ``telemetry_`` prefix.


.. py:function:: set_jobmon_context(*, allow_non_jobmon_keys: bool = False, **metadata: Any) -> None

   Bind telemetry metadata to the current structlog context.

   All keys are automatically prefixed with ``telemetry_`` unless
   allow_non_jobmon_keys is True.

   :param allow_non_jobmon_keys: **INTERNAL USE ONLY**. If True, bind keys as-is
                                 without adding ``telemetry_`` prefix. Used internally by the
                                 bind_context decorator and server middleware. External callers
                                 should not use this flag.
   :param \*\*metadata: Key-value pairs to bind to context.


.. py:function:: unset_jobmon_context(*keys: str, allow_non_jobmon_keys: bool = False) -> None

   Remove telemetry metadata keys from the current context.

   Keys are automatically prefixed with ``telemetry_`` unless
   allow_non_jobmon_keys is True.

   :param \*keys: Keys to remove from context.
   :param allow_non_jobmon_keys: **INTERNAL USE ONLY**. If True, remove keys as-is
                                 without adding ``telemetry_`` prefix. Used internally by the
                                 bind_context decorator and server middleware. External callers
                                 should not use this flag.