[Doc] Explain how to know whether RAY_BACKEND_LOG_LEVEL worked (#12010)

* Fix broken link to nonexistent Temporary Files page.

* How to know that RAY_BACKEND_LOG_LEVEL worked.

* Reference the definition of DEBUG in case it changes.
This commit is contained in:
dHannasch 2020-11-13 15:02:57 -07:00 committed by GitHub
parent 277558895d
commit effa553077
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 3 deletions

View file

@ -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
---------------------

View file

@ -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