Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add Troubleshooting topic to documentation #24601

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions presto-docs/src/main/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Presto Documentation
router
develop
presto-cpp
troubleshoot
release

.. Note: If "release" is not the last item, the CSS must be updated.
11 changes: 11 additions & 0 deletions presto-docs/src/main/sphinx/troubleshoot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
***************
Troubleshooting
***************

This section collects known problems and their identified solutions or workarounds,
and are grouped by topic.

.. toctree::
:maxdepth: 1

troubleshoot/deploy
79 changes: 79 additions & 0 deletions presto-docs/src/main/sphinx/troubleshoot/deploy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
================
Deploying Presto
================

This page presents common problems encountered when deploying Presto.

.. contents::
:local:
:backlinks: none
:depth: 1

``Permission denied: ‘/private/var/presto/data/var/run/launcher.pid``
---------------------------------------------------------------------

Problem
^^^^^^^

``bin/launcher run`` or ``bin/launcher start`` returns the following error:

``Permission denied: ‘/private/var/presto/data/var/run/launcher.pid``

Solution
^^^^^^^^

Run the command as root or using ``sudo``.

.. code-block:: none

sudo bin/launcher run
sudo bin/launcher start


``xcode select failed to locate python``
----------------------------------------

Problem
^^^^^^^

(OS X only) ``bin/launcher run`` or ``bin/launcher start`` returns the following error:

``xcode select failed to locate python requesting installation of command``

Solution
^^^^^^^^

Create a symlink where XCode looks for python that links to python3. An example of such a command:

.. code-block:: none

ln -s /Library/Developer/CommandLineTools/usr/bin/python3 /Library/Developer/CommandLineTools/usr/bin/python




``Error: VM option ‘UseG1GC’ is experimental``
----------------------------------------------

Problem
^^^^^^^
``bin/launcher run`` or ``bin/launcher start`` returns the following error:

.. code-block:: none

Error: VM option ‘UseG1GC’ is experimental and must be enabled via -XX:+UnlockExperimentalVM Options.

Error: Could not create the Java Virtual Machine.

Error: A fatal exception has occurred. Program will exit.

Solution
^^^^^^^^

This error occurs with some versions of Java.

1. Check the version of Java that is installed on the system.

2. If the installed version of Java is not the version in
`Requirements <https://github.com/prestodb/presto?tab=readme-ov-file#requirements>`_,
then uninstall Java and install a recommended version.