Function get_runtime_context

python/ray/runtime_context.py:641–667

Get the runtime context of the current driver/worker. The obtained runtime context can be used to get the metadata of the current driver, task, or actor. Example: .. testcode:: import ray # Get the job id. ray.get_runtime_context().get_job_

()

@PublicAPI
@client_mode_hook
def get_runtime_context() -> RuntimeContext:
    """Get the runtime context of the current driver/worker.

    The obtained runtime context can be used to get the metadata
    of the current driver, task, or actor.

    Example:

        .. testcode::

            import ray
            # Get the job id.
            ray.get_runtime_context().get_job_id()
            # Get the session name (used as SessionName label in Ray metrics).
            ray.get_runtime_context().get_session_name()
            # Get the actor id.
            ray.get_runtime_context().get_actor_id()
            # Get the task id.
            ray.get_runtime_context().get_task_id()

    """
    with _runtime_context_lock:
        global _runtime_context
        if _runtime_context is None:
            _runtime_context = RuntimeContext(ray._private.worker.global_worker)

        return _runtime_context