Function logs

python/ray/dashboard/modules/job/cli.py:535–569

Gets the logs of a job. Example: `ray job logs ` Args: address: Address of the Ray cluster to connect to. job_id: The submission ID of the job whose logs to fetch. follow: If True, stream the logs (``tail -f`` style) instead of printing them once.

(
    address: Optional[str],
    job_id: str,
    follow: bool,
    headers: Optional[str],
    verify: Union[bool, str],
)

@add_click_logging_options
@PublicAPI(stability="stable")
def logs(
    address: Optional[str],
    job_id: str,
    follow: bool,
    headers: Optional[str],
    verify: Union[bool, str],
):
    """Gets the logs of a job.

    Example:
        `ray job logs <my_job_id>`

    Args:
        address: Address of the Ray cluster to connect to.
        job_id: The submission ID of the job whose logs to fetch.
        follow: If True, stream the logs (``tail -f`` style) instead of printing them once.
        headers: JSON string of headers to attach to requests.
        verify: Path to a CA bundle, or boolean toggling TLS verification.
    """
    client = _get_sdk_client(address, headers=headers, verify=verify)
    sdk_version = client.get_version()
    # sdk version 0 did not have log streaming
    if follow:
        if int(sdk_version) > 0:
            get_or_create_event_loop().run_until_complete(_tail_logs(client, job_id))
        else:
            cli_logger.warning(
                "Tailing logs is not enabled for the Jobs SDK client version "
                f"{sdk_version}. Please upgrade Ray to latest version "
                "for this feature."
            )
    else:
        # Set no_format to True because the logs may have unescaped "{" and "}"
        # and the CLILogger calls str.format().
        cli_logger.print(client.get_job_logs(job_id), end="", no_format=True)


@job_cli_group.command()