[Core] Rename ray_log_filepath, ray_err_log_filepath to stdout_filepath, stderr_filepath (#51341)

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>

Author: jjyao

python/ray/_private/node.py

@@ -1204,8 +1204,8 @@ def start_gcs_server(self):
         process_info = ray._private.services.start_gcs_server(
             self.redis_address,
             log_dir=self._logs_dir,
-            ray_log_filepath=stdout_log_fname,
-            ray_err_log_filepath=stderr_log_fname,
+            stdout_filepath=stdout_log_fname,
+            stderr_filepath=stderr_log_fname,
             session_name=self.session_name,
             redis_username=self._ray_params.redis_username,
             redis_password=self._ray_params.redis_password,
@@ -1277,8 +1277,8 @@ def start_raylet(
             dashboard_agent_listen_port=self._ray_params.dashboard_agent_listen_port,
             use_valgrind=use_valgrind,
             use_profiler=use_profiler,
-            ray_log_filepath=stdout_log_fname,
-            ray_err_log_filepath=stderr_log_fname,
+            stdout_filepath=stdout_log_fname,
+            stderr_filepath=stderr_log_fname,
             huge_pages=self._ray_params.huge_pages,
             fate_share=self.kernel_fate_share,
             socket_to_use=None,

python/ray/_private/services.py

@@ -1443,8 +1443,8 @@ def get_address(redis_address):
 def start_gcs_server(
     redis_address: str,
     log_dir: str,
-    ray_log_filepath: Optional[str],
-    ray_err_log_filepath: Optional[str],
+    stdout_filepath: Optional[str],
+    stderr_filepath: Optional[str],
     session_name: str,
     redis_username: Optional[str] = None,
     redis_password: Optional[str] = None,
@@ -1459,10 +1459,10 @@ def start_gcs_server(
     Args:
         redis_address: The address that the Redis server is listening on.
         log_dir: The path of the dir where gcs log files are created.
-        ray_log_filepath: The file path to dump gcs server log, which is
-            written via `RAY_LOG`. If None, logs will be sent to stdout.
-        ray_err_log_filepath: The file path to dump gcs server error log, which is
-            written via `RAY_LOG`. If None, logs will be sent to stderr.
+        stdout_filepath: The file path to dump gcs server stdout.
+            If None, stdout is not redirected.
+        stderr_filepath: The file path to dump gcs server stderr.
+            If None, stderr is not redirected.
         session_name: The session name (cluster id) of this cluster.
         redis_username: The username of the Redis server.
         redis_password: The password of the Redis server.
@@ -1488,10 +1488,10 @@ def start_gcs_server(
         f"--ray-commit={ray.__commit__}",
     ]
 
-    if ray_log_filepath:
-        command += [f"--ray_log_filepath={ray_log_filepath}"]
-    if ray_err_log_filepath:
-        command += [f"--ray_err_log_filepath={ray_err_log_filepath}"]
+    if stdout_filepath:
+        command += [f"--stdout_filepath={stdout_filepath}"]
+    if stderr_filepath:
+        command += [f"--stderr_filepath={stderr_filepath}"]
 
     if redis_address:
         redis_ip_address, redis_port, enable_redis_ssl = get_address(redis_address)
@@ -1507,11 +1507,11 @@ def start_gcs_server(
         command += [f"--redis_password={redis_password}"]
 
     stdout_file = None
-    if ray_log_filepath:
+    if stdout_filepath:
         stdout_file = open(os.devnull, "w")
 
     stderr_file = None
-    if ray_err_log_filepath:
+    if stderr_filepath:
         stderr_file = open(os.devnull, "w")
 
     process_info = start_ray_process(
@@ -1557,8 +1557,8 @@ def start_raylet(
     runtime_env_agent_port: Optional[int] = None,
     use_valgrind: bool = False,
     use_profiler: bool = False,
-    ray_log_filepath: Optional[str] = None,
-    ray_err_log_filepath: Optional[str] = None,
+    stdout_filepath: Optional[str] = None,
+    stderr_filepath: Optional[str] = None,
     huge_pages: bool = False,
     fate_share: Optional[bool] = None,
     socket_to_use: Optional[int] = None,
@@ -1612,10 +1612,10 @@ def start_raylet(
             of valgrind. If this is True, use_profiler must be False.
         use_profiler: True if the raylet should be started inside
             a profiler. If this is True, use_valgrind must be False.
-        ray_log_filepath: The file path to dump raylet log, which is
-            written via `RAY_LOG`. If None, logs will be sent to stdout.
-        ray_err_log_filepath: The error file path to dump raylet log, which is
-            written via `RAY_LOG`. If None, logs will be sent to stderr.
+        stdout_filepath: The file path to dump raylet stdout.
+            If None, stdout is not redirected.
+        stderr_filepath: The file path to dump raylet stderr.
+            If None, stderr is not redirected.
         tracing_startup_hook: Tracing startup hook.
         max_bytes: Log rotation parameter. Corresponding to
             RotatingFileHandler's maxBytes.
@@ -1769,7 +1769,7 @@ def start_raylet(
         f"--gcs-address={gcs_address}",
         f"--cluster-id-hex={cluster_id}",
     ]
-    if ray_log_filepath is None and ray_err_log_filepath is None:
+    if stdout_filepath is None and stderr_filepath is None:
         # If not redirecting logging to files, unset log filename.
         # This will cause log records to go to stderr.
         dashboard_agent_command.append("--logging-filename=")
@@ -1833,10 +1833,10 @@ def start_raylet(
         f"--cluster-id={cluster_id}",
     ]
 
-    if ray_log_filepath:
-        command.append(f"--ray_log_filepath={ray_log_filepath}")
-    if ray_err_log_filepath:
-        command.append(f"--ray_err_log_filepath={ray_err_log_filepath}")
+    if stdout_filepath:
+        command.append(f"--stdout_filepath={stdout_filepath}")
+    if stderr_filepath:
+        command.append(f"--stderr_filepath={stderr_filepath}")
 
     if is_head_node:
         command.append("--head")
@@ -1866,11 +1866,11 @@ def start_raylet(
         )
 
     stdout_file = None
-    if ray_log_filepath:
+    if stdout_filepath:
         stdout_file = open(os.devnull, "w")
 
     stderr_file = None
-    if ray_err_log_filepath:
+    if stderr_filepath:
         stderr_file = open(os.devnull, "w")
 
     process_info = start_ray_process(

src/ray/gcs/gcs_server/gcs_server_main.cc

@@ -31,13 +31,8 @@ DEFINE_string(redis_address, "", "The ip address of redis.");
 DEFINE_bool(redis_enable_ssl, false, "Use tls/ssl in redis connection.");
 DEFINE_int32(redis_port, -1, "The port of redis.");
 DEFINE_string(log_dir, "", "The path of the dir where log files are created.");
-DEFINE_string(ray_log_filepath,
-              "",
-              "The log filepath to dump gcs server log, which is written via `RAY_LOG`.");
-DEFINE_string(
-    ray_err_log_filepath,
-    "",
-    "The filepath to dump gcs server error log, which is written via `RAY_LOG`.");
+DEFINE_string(stdout_filepath, "", "The filepath to dump gcs server stdout.");
+DEFINE_string(stderr_filepath, "", "The filepath to dump gcs server stderr.");
 DEFINE_int32(gcs_server_port, 0, "The port of gcs server.");
 DEFINE_int32(metrics_agent_port, -1, "The port of metrics agent.");
 DEFINE_string(config_list, "", "The config list of raylet.");
@@ -53,19 +48,19 @@ DEFINE_string(ray_commit, "", "The commit hash of Ray.");
 int main(int argc, char *argv[]) {
   gflags::ParseCommandLineFlags(&argc, &argv, true);
 
-  if (!FLAGS_ray_log_filepath.empty()) {
+  if (!FLAGS_stdout_filepath.empty()) {
     ray::StreamRedirectionOption stdout_redirection_options;
-    stdout_redirection_options.file_path = FLAGS_ray_log_filepath;
+    stdout_redirection_options.file_path = FLAGS_stdout_filepath;
     stdout_redirection_options.rotation_max_size =
         ray::RayLog::GetRayLogRotationMaxBytesOrDefault();
     stdout_redirection_options.rotation_max_file_count =
         ray::RayLog::GetRayLogRotationBackupCountOrDefault();
     ray::RedirectStdout(stdout_redirection_options);
   }
 
-  if (!FLAGS_ray_err_log_filepath.empty()) {
+  if (!FLAGS_stderr_filepath.empty()) {
     ray::StreamRedirectionOption stderr_redirection_options;
-    stderr_redirection_options.file_path = FLAGS_ray_err_log_filepath;
+    stderr_redirection_options.file_path = FLAGS_stderr_filepath;
     stderr_redirection_options.rotation_max_size =
         ray::RayLog::GetRayLogRotationMaxBytesOrDefault();
     stderr_redirection_options.rotation_max_file_count =

src/ray/raylet/main.cc

@@ -74,14 +74,8 @@ DEFINE_string(native_library_path,
 DEFINE_string(temp_dir, "", "Temporary directory.");
 DEFINE_string(session_dir, "", "The path of this ray session directory.");
 DEFINE_string(log_dir, "", "The path of the dir where log files are created.");
-DEFINE_string(
-    ray_log_filepath,
-    "",
-    "The filename to dump raylet log on stdout, which is written via `RAY_LOG`.");
-DEFINE_string(
-    ray_err_log_filepath,
-    "",
-    "The filename to dump raylet error log on stderr, which is written via `RAY_LOG`.");
+DEFINE_string(stdout_filepath, "", "The filepath to dump raylet stdout.");
+DEFINE_string(stderr_filepath, "", "The filepath to dump raylet stderr.");
 DEFINE_string(resource_dir, "", "The path of this ray resource directory.");
 DEFINE_int32(ray_debugger_external, 0, "Make Ray debugger externally accessible.");
 // store options
@@ -136,19 +130,19 @@ absl::flat_hash_map<std::string, std::string> parse_node_labels(
 int main(int argc, char *argv[]) {
   gflags::ParseCommandLineFlags(&argc, &argv, true);
 
-  if (!FLAGS_ray_log_filepath.empty()) {
+  if (!FLAGS_stdout_filepath.empty()) {
     ray::StreamRedirectionOption stdout_redirection_options;
-    stdout_redirection_options.file_path = FLAGS_ray_log_filepath;
+    stdout_redirection_options.file_path = FLAGS_stdout_filepath;
     stdout_redirection_options.rotation_max_size =
         ray::RayLog::GetRayLogRotationMaxBytesOrDefault();
     stdout_redirection_options.rotation_max_file_count =
         ray::RayLog::GetRayLogRotationBackupCountOrDefault();
     ray::RedirectStdout(stdout_redirection_options);
   }
 
-  if (!FLAGS_ray_err_log_filepath.empty()) {
+  if (!FLAGS_stderr_filepath.empty()) {
     ray::StreamRedirectionOption stderr_redirection_options;
-    stderr_redirection_options.file_path = FLAGS_ray_err_log_filepath;
+    stderr_redirection_options.file_path = FLAGS_stderr_filepath;
     stderr_redirection_options.rotation_max_size =
         ray::RayLog::GetRayLogRotationMaxBytesOrDefault();
     stderr_redirection_options.rotation_max_file_count =
@@ -167,8 +161,8 @@ int main(int argc, char *argv[]) {
                                          ray::RayLog::ShutDownRayLog,
                                          /*app_name=*/argv[0],
                                          ray::RayLogLevel::INFO,
-                                         /*ray_log_filepath=*/"",
-                                         /*ray_err_log_filepath=*/"",
+                                         /*log_filepath=*/"",
+                                         /*err_log_filepath=*/"",
                                          /*log_rotation_max_size=*/0,
                                          /*log_rotation_file_num=*/1);
 

src/ray/util/logging.cc

@@ -382,7 +382,6 @@ void RayLog::InitLogFormat() {
   log_rotation_file_num_ = log_rotation_file_num;
 
   // All the logging sinks to add.
-  // One for file/stdout, another for stderr.
   std::array<spdlog::sink_ptr, 2> sinks;  // Intentionally no initialization.
 
   auto level = GetMappedSeverity(severity_threshold_);
@@ -397,7 +396,7 @@ void RayLog::InitLogFormat() {
     }
   }
 
-  // Set sink for stdout.
+  // Set sink for logs above the user defined level.
   if (!log_filepath.empty()) {
     // Sink all log stuff to default file logger we defined here. We may need
     // multiple sinks for different files or loglevel.
@@ -424,7 +423,7 @@ void RayLog::InitLogFormat() {
     sinks[0] = std::move(console_sink);
   }
 
-  // Set sink for stderr.
+  // Set sink for error logs.
   if (!err_log_filepath.empty()) {
     spdlog::sink_ptr err_sink;
     if (log_rotation_max_size_ == 0) {