chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,405 @@
|
||||
import asyncio
|
||||
import concurrent.futures
|
||||
import io
|
||||
import logging
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import AsyncIterator, Optional
|
||||
|
||||
import grpc
|
||||
|
||||
import ray.dashboard.modules.log.log_consts as log_consts
|
||||
import ray.dashboard.modules.log.log_utils as log_utils
|
||||
import ray.dashboard.optional_utils as dashboard_optional_utils
|
||||
import ray.dashboard.utils as dashboard_utils
|
||||
from ray._private.ray_constants import env_integer
|
||||
from ray.core.generated import reporter_pb2, reporter_pb2_grpc
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
routes = dashboard_optional_utils.DashboardAgentRouteTable
|
||||
|
||||
# 64 KB
|
||||
BLOCK_SIZE = 1 << 16
|
||||
|
||||
# Keep-alive interval for reading the file
|
||||
DEFAULT_KEEP_ALIVE_INTERVAL_SEC = 1
|
||||
|
||||
RAY_DASHBOARD_LOG_TASK_LOG_SEARCH_MAX_WORKER_COUNT = env_integer(
|
||||
"RAY_DASHBOARD_LOG_TASK_LOG_SEARCH_MAX_WORKER_COUNT", default=2
|
||||
)
|
||||
|
||||
|
||||
def find_offset_of_content_in_file(
|
||||
file: io.BufferedIOBase, content: bytes, start_offset: int = 0
|
||||
) -> int:
|
||||
"""Find the offset of the first occurrence of content in a file.
|
||||
|
||||
Args:
|
||||
file: File object
|
||||
content: Content to find
|
||||
start_offset: Start offset to read from, inclusive.
|
||||
|
||||
Returns:
|
||||
Offset of the first occurrence of content in a file.
|
||||
"""
|
||||
logger.debug(f"Finding offset of content {content} in file")
|
||||
file.seek(start_offset, io.SEEK_SET) # move file pointer to start of file
|
||||
offset = start_offset
|
||||
while True:
|
||||
# Read in block
|
||||
block_data = file.read(BLOCK_SIZE)
|
||||
if block_data == b"":
|
||||
# Stop reading
|
||||
return -1
|
||||
# Find the offset of the first occurrence of content in the block
|
||||
block_offset = block_data.find(content)
|
||||
if block_offset != -1:
|
||||
# Found the offset in the block
|
||||
return offset + block_offset
|
||||
# Continue reading
|
||||
offset += len(block_data)
|
||||
|
||||
|
||||
def find_end_offset_file(file: io.BufferedIOBase) -> int:
|
||||
"""
|
||||
Find the offset of the end of a file without changing the file pointer.
|
||||
|
||||
Args:
|
||||
file: File object
|
||||
|
||||
Returns:
|
||||
Offset of the end of a file.
|
||||
"""
|
||||
old_pos = file.tell() # store old position
|
||||
file.seek(0, io.SEEK_END) # move file pointer to end of file
|
||||
end = file.tell() # return end of file offset
|
||||
file.seek(old_pos, io.SEEK_SET)
|
||||
return end
|
||||
|
||||
|
||||
def find_end_offset_next_n_lines_from_offset(
|
||||
file: io.BufferedIOBase, start_offset: int, n: int
|
||||
) -> int:
|
||||
"""
|
||||
Find the offsets of next n lines from a start offset.
|
||||
|
||||
Args:
|
||||
file: File object
|
||||
start_offset: Start offset to read from, inclusive.
|
||||
n: Number of lines to find.
|
||||
|
||||
Returns:
|
||||
Offset of the end of the next n line (exclusive)
|
||||
"""
|
||||
file.seek(start_offset) # move file pointer to start offset
|
||||
end_offset = None
|
||||
for _ in range(n): # loop until we find n lines or reach end of file
|
||||
line = file.readline() # read a line and consume new line character
|
||||
if not line: # end of file
|
||||
break
|
||||
end_offset = file.tell() # end offset.
|
||||
|
||||
logger.debug(f"Found next {n} lines from {start_offset} offset")
|
||||
return (
|
||||
end_offset if end_offset is not None else file.seek(0, io.SEEK_END)
|
||||
) # return last line offset or end of file offset if no lines found
|
||||
|
||||
|
||||
def find_start_offset_last_n_lines_from_offset(
|
||||
file: io.BufferedIOBase, offset: int, n: int, block_size: int = BLOCK_SIZE
|
||||
) -> int:
|
||||
"""
|
||||
Find the offset of the beginning of the line of the last X lines from an offset.
|
||||
|
||||
Args:
|
||||
file: File object
|
||||
offset: Start offset from which to find last X lines, -1 means end of file.
|
||||
The offset is exclusive, i.e. data at the offset is not included
|
||||
in the result.
|
||||
n: Number of lines to find
|
||||
block_size: Block size to read from file
|
||||
|
||||
Returns:
|
||||
Offset of the beginning of the line of the last X lines from a start offset.
|
||||
"""
|
||||
logger.debug(f"Finding last {n} lines from {offset} offset")
|
||||
if offset == -1:
|
||||
offset = file.seek(0, io.SEEK_END) # move file pointer to end of file
|
||||
else:
|
||||
file.seek(offset, io.SEEK_SET) # move file pointer to start offset
|
||||
|
||||
if n == 0:
|
||||
return offset
|
||||
nbytes_from_end = (
|
||||
0 # Number of bytes that should be tailed from the end of the file
|
||||
)
|
||||
# Non new line terminating offset, adjust the line count and treat the non-newline
|
||||
# terminated line as the last line. e.g. line 1\nline 2
|
||||
file.seek(max(0, offset - 1), os.SEEK_SET)
|
||||
if file.read(1) != b"\n":
|
||||
n -= 1
|
||||
|
||||
# Remaining number of lines to tail
|
||||
lines_more = n
|
||||
read_offset = max(0, offset - block_size)
|
||||
# So that we know how much to read on the last block (the block 0)
|
||||
prev_offset = offset
|
||||
|
||||
while lines_more >= 0 and read_offset >= 0:
|
||||
# Seek to the current block start
|
||||
file.seek(read_offset, 0)
|
||||
# Read the current block (or less than block) data
|
||||
block_data = file.read(min(block_size, prev_offset - read_offset))
|
||||
num_lines = block_data.count(b"\n")
|
||||
if num_lines > lines_more:
|
||||
# This is the last block to read.
|
||||
# Need to find the offset of exact number of lines to tail
|
||||
# in the block.
|
||||
# Use `split` here to split away the extra lines, i.e.
|
||||
# first `num_lines - lines_more` lines.
|
||||
lines = block_data.split(b"\n", num_lines - lines_more)
|
||||
# Added the len of those lines that at the end of the block.
|
||||
nbytes_from_end += len(lines[-1])
|
||||
break
|
||||
|
||||
# Need to read more blocks.
|
||||
lines_more -= num_lines
|
||||
nbytes_from_end += len(block_data)
|
||||
|
||||
if read_offset == 0:
|
||||
# We have read all blocks (since the start)
|
||||
break
|
||||
# Continuing with the previous block
|
||||
prev_offset = read_offset
|
||||
read_offset = max(0, read_offset - block_size)
|
||||
|
||||
offset_read_start = offset - nbytes_from_end
|
||||
assert (
|
||||
offset_read_start >= 0
|
||||
), f"Read start offset({offset_read_start}) should be non-negative"
|
||||
return offset_read_start
|
||||
|
||||
|
||||
async def _stream_log_in_chunk(
|
||||
context: grpc.aio.ServicerContext,
|
||||
file: io.BufferedIOBase,
|
||||
start_offset: int,
|
||||
end_offset: int = -1,
|
||||
keep_alive_interval_sec: int = -1,
|
||||
block_size: int = BLOCK_SIZE,
|
||||
) -> AsyncIterator[reporter_pb2.StreamLogReply]:
|
||||
"""Streaming log in chunk from start to end offset.
|
||||
|
||||
Stream binary file content in chunks from start offset to an end
|
||||
offset if provided, else to the end of the file.
|
||||
|
||||
Args:
|
||||
context: gRPC server side context
|
||||
file: Binary file to stream
|
||||
start_offset: File offset where streaming starts
|
||||
end_offset: If -1, implying streaming til the EOF.
|
||||
keep_alive_interval_sec: Duration for which streaming will be
|
||||
retried when reaching the file end, -1 means no retry.
|
||||
block_size: Number of bytes per chunk, exposed for testing
|
||||
|
||||
Yields:
|
||||
reporter_pb2.StreamLogReply: Successive chunks of the file contents,
|
||||
one per block.
|
||||
"""
|
||||
assert "b" in file.mode, "Only binary file is supported."
|
||||
assert not (
|
||||
keep_alive_interval_sec >= 0 and end_offset != -1
|
||||
), "Keep-alive is not allowed when specifying an end offset"
|
||||
|
||||
file.seek(start_offset, 0)
|
||||
cur_offset = start_offset
|
||||
|
||||
# Until gRPC is done
|
||||
while not context.done():
|
||||
# Read in block
|
||||
if end_offset != -1:
|
||||
to_read = min(end_offset - cur_offset, block_size)
|
||||
else:
|
||||
to_read = block_size
|
||||
|
||||
bytes = file.read(to_read)
|
||||
|
||||
if bytes == b"":
|
||||
# Stop reading
|
||||
if keep_alive_interval_sec >= 0:
|
||||
await asyncio.sleep(keep_alive_interval_sec)
|
||||
# Try reading again
|
||||
continue
|
||||
|
||||
# Have read the entire file, done
|
||||
break
|
||||
logger.debug(f"Sending {len(bytes)} bytes at {cur_offset}")
|
||||
yield reporter_pb2.StreamLogReply(data=bytes)
|
||||
|
||||
# Have read the requested section [start_offset, end_offset), done
|
||||
cur_offset += len(bytes)
|
||||
if end_offset != -1 and cur_offset >= end_offset:
|
||||
break
|
||||
|
||||
|
||||
class LogAgent(dashboard_utils.DashboardAgentModule):
|
||||
def __init__(self, dashboard_agent):
|
||||
super().__init__(dashboard_agent)
|
||||
log_utils.register_mimetypes()
|
||||
routes.static("/logs", self._dashboard_agent.log_dir, show_index=True)
|
||||
|
||||
async def run(self, server):
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
def is_minimal_module():
|
||||
return False
|
||||
|
||||
|
||||
_task_log_search_worker_pool = concurrent.futures.ThreadPoolExecutor(
|
||||
max_workers=RAY_DASHBOARD_LOG_TASK_LOG_SEARCH_MAX_WORKER_COUNT
|
||||
)
|
||||
|
||||
|
||||
class LogAgentV1Grpc(dashboard_utils.DashboardAgentModule):
|
||||
def __init__(self, dashboard_agent):
|
||||
super().__init__(dashboard_agent)
|
||||
|
||||
async def run(self, server):
|
||||
if server:
|
||||
reporter_pb2_grpc.add_LogServiceServicer_to_server(self, server)
|
||||
|
||||
@property
|
||||
def node_id(self) -> Optional[str]:
|
||||
return self._dashboard_agent.get_node_id()
|
||||
|
||||
@staticmethod
|
||||
def is_minimal_module():
|
||||
# Dashboard is only available with non-minimal install now.
|
||||
return False
|
||||
|
||||
async def ListLogs(self, request, context):
|
||||
"""
|
||||
Lists all files in the active Ray logs directory.
|
||||
|
||||
Part of `LogService` gRPC.
|
||||
|
||||
NOTE: These RPCs are used by state_head.py, not log_head.py
|
||||
"""
|
||||
path = Path(self._dashboard_agent.log_dir)
|
||||
if not path.exists():
|
||||
raise FileNotFoundError(
|
||||
f"Could not find log dir at path: {self._dashboard_agent.log_dir}"
|
||||
"It is unexpected. Please report an issue to Ray Github."
|
||||
)
|
||||
log_files = []
|
||||
for p in path.glob(request.glob_filter):
|
||||
log_files.append(str(p.relative_to(path)) + ("/" if p.is_dir() else ""))
|
||||
return reporter_pb2.ListLogsReply(log_files=log_files)
|
||||
|
||||
@classmethod
|
||||
def _resolve_filename(cls, root_log_dir: Path, filename: str) -> Path:
|
||||
"""
|
||||
Resolves the file path relative to the root log directory.
|
||||
|
||||
Args:
|
||||
root_log_dir: Root log directory.
|
||||
filename: File path relative to the root log directory.
|
||||
|
||||
Raises:
|
||||
FileNotFoundError: If the file path is invalid.
|
||||
|
||||
Returns:
|
||||
The absolute file path resolved from the root log directory.
|
||||
"""
|
||||
if not Path(filename).is_absolute():
|
||||
filepath = root_log_dir / filename
|
||||
else:
|
||||
filepath = Path(filename)
|
||||
|
||||
# We want to allow relative paths that include symlinks pointing outside of the
|
||||
# `root_log_dir`, so use `os.path.abspath` instead of `Path.resolve()` because
|
||||
# `os.path.abspath` does not resolve symlinks.
|
||||
filepath = Path(os.path.abspath(filepath))
|
||||
|
||||
if not filepath.is_file():
|
||||
raise FileNotFoundError(f"A file is not found at: {filepath}")
|
||||
|
||||
try:
|
||||
filepath.relative_to(root_log_dir)
|
||||
except ValueError as e:
|
||||
raise FileNotFoundError(f"{filepath} not in {root_log_dir}: {e}")
|
||||
|
||||
# Fully resolve the path before returning (including following symlinks).
|
||||
return filepath.resolve()
|
||||
|
||||
async def StreamLog(self, request, context):
|
||||
"""
|
||||
Streams the log in real time starting from `request.lines` number of lines from
|
||||
the end of the file if `request.keep_alive == True`. Else, it terminates the
|
||||
stream once there are no more bytes to read from the log file.
|
||||
|
||||
Part of `LogService` gRPC.
|
||||
|
||||
NOTE: These RPCs are used by state_head.py, not log_head.py
|
||||
"""
|
||||
# NOTE: If the client side connection is closed, this handler will
|
||||
# be automatically terminated.
|
||||
lines = request.lines if request.lines else 1000
|
||||
|
||||
try:
|
||||
filepath = self._resolve_filename(
|
||||
Path(self._dashboard_agent.log_dir), request.log_file_name
|
||||
)
|
||||
except FileNotFoundError as e:
|
||||
await context.send_initial_metadata([[log_consts.LOG_GRPC_ERROR, str(e)]])
|
||||
else:
|
||||
with open(filepath, "rb") as f:
|
||||
await context.send_initial_metadata([])
|
||||
|
||||
# Default stream entire file
|
||||
start_offset = (
|
||||
request.start_offset if request.HasField("start_offset") else 0
|
||||
)
|
||||
end_offset = (
|
||||
request.end_offset
|
||||
if request.HasField("end_offset")
|
||||
else find_end_offset_file(f)
|
||||
)
|
||||
|
||||
if lines != -1:
|
||||
# If specified tail line number, cap the start offset
|
||||
# with lines from the current end offset
|
||||
start_offset = max(
|
||||
find_start_offset_last_n_lines_from_offset(
|
||||
f, offset=end_offset, n=lines
|
||||
),
|
||||
start_offset,
|
||||
)
|
||||
|
||||
# If keep alive: following the log every 'interval'
|
||||
keep_alive_interval_sec = -1
|
||||
if request.keep_alive:
|
||||
keep_alive_interval_sec = (
|
||||
request.interval
|
||||
if request.interval
|
||||
else DEFAULT_KEEP_ALIVE_INTERVAL_SEC
|
||||
)
|
||||
|
||||
# When following (keep_alive), it will read beyond the end
|
||||
end_offset = -1
|
||||
|
||||
logger.info(
|
||||
f"Tailing logs from {start_offset} to {end_offset} for "
|
||||
f"lines={lines}, with keep_alive={keep_alive_interval_sec}"
|
||||
)
|
||||
|
||||
# Read and send the file data in chunk
|
||||
async for chunk_res in _stream_log_in_chunk(
|
||||
context=context,
|
||||
file=f,
|
||||
start_offset=start_offset,
|
||||
end_offset=end_offset,
|
||||
keep_alive_interval_sec=keep_alive_interval_sec,
|
||||
):
|
||||
yield chunk_res
|
||||
Reference in New Issue
Block a user