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

It's hard to debug errors in the sphinx agent #822

Open
alcarney opened this issue May 24, 2024 · 1 comment
Open

It's hard to debug errors in the sphinx agent #822

alcarney opened this issue May 24, 2024 · 1 comment
Labels
bug Something isn't working lsp Issues that relate to the language server
Milestone

Comments

@alcarney
Copy link
Member

Expected behavior

When an error occurs in the Sphinx agent, there is sufficient information in the logs to debug the issue

Actual behavior

Only the error message and a general location of the error are available

[esbonio.SphinxManager] Unable to start SphinxClient: Handler <function index_roles at 0x7fbd4ddad9e0> for event 'builder-inited' threw an exception (exception: Circular reference detected)
Traceback (most recent call last):
  File "/var/home/alex/Projects/swyddfa/esbonio/develop/code/bundled/libs/esbonio/server/features/sphinx_manager/client_subprocess.py", line 210, in start
    self.sphinx_info = await self.protocol.send_request_async(
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
pygls.exceptions.JsonRpcInternalError: Handler <function index_roles at 0x7fbd4ddad9e0> for event 'builder-inited' threw an exception (exception: Circular reference detected)

Log output

No response

(Optional) Settings from conf.py

No response

@alcarney alcarney added bug Something isn't working lsp Issues that relate to the language server labels May 24, 2024
@alcarney alcarney added this to the 1.0 milestone May 24, 2024
@alcarney alcarney added this to Esbonio May 24, 2024
@github-project-automation github-project-automation bot moved this to Todo in Esbonio May 24, 2024
@alcarney
Copy link
Member Author

Configuring the agent to write logs to stderr should be enough to resolve this. The trick is figuring out a nice way to configure it via the parent language server

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working lsp Issues that relate to the language server
Projects
Status: Todo
Development

No branches or pull requests

1 participant