diff --git a/doc/source/configure.rst b/doc/source/configure.rst index c0ff73963..0c33a9fc6 100644 --- a/doc/source/configure.rst +++ b/doc/source/configure.rst @@ -63,6 +63,8 @@ If using the command line, connect to the Ray cluster as follow: per worker to avoid contention. +.. _temp-dir-log-files: + Logging and Debugging --------------------- diff --git a/doc/source/debugging.rst b/doc/source/debugging.rst index 8b12f1f02..f909f9fe1 100644 --- a/doc/source/debugging.rst +++ b/doc/source/debugging.rst @@ -93,8 +93,18 @@ starting Ray. For example, you can do: ray start This will print any ``RAY_LOG(DEBUG)`` lines in the source code to the -``raylet.err`` file, which you can find in the `Temporary Files`_. +``raylet.err`` file, which you can find in :ref:`temp-dir-log-files`. +If it worked, you should see as the first line in ``raylet.err``: + +.. code-block:: shell + + logging.cc:270: Set ray log level from environment variable RAY_BACKEND_LOG_LEVEL to -1 + +(-1 is defined as RayLogLevel::DEBUG in logging.h.) + +.. literalinclude:: /../../src/ray/util/logging.h + :language: C + :lines: 52,54 -.. _`issues`: https://github.com/ray-project/ray/issues -.. _`Temporary Files`: http://docs.ray.io/en/master/tempfile.html +.. _`issues`: https://github.com/ray-project/ray/issues \ No newline at end of file