Please Document Azurite Logging in VS CODE - not obvious how to see logs

[Stuart-Williams-CLA]

Which service(blob, file, queue, table) does this issue concern?

Azurite in VS CODE

Which version of the Azurite was used?

Latest from Gallery

Where do you get Azurite? (npm, DockerHub, NuGet, Visual Studio Code Extension)

VS CODE Gallery

What's the Node.js version?

v16.13.1

What problem was encountered?

Documentation is unclear how to see Azurite Debug Logs in VS Code

Steps to reproduce the issue?

See above

If possible, please provide the debug log using the -d parameter, replacing <pathtodebuglog> with an appropriate path for your OS, or review the instructions for docker containers:

No idea, how do you set -d for azurite in VS Code? (This is another documentation issue!)

-d "<pathtodebuglog>"

Please be sure to remove any PII or sensitive information before sharing!
The debug log will log raw request headers and bodies, so that we can replay these against Azurite using REST and create tests to validate resolution.

Have you found a mitigation/solution?

NOPE. Please update the documentation, should be an easy fix.

[blueww]

@Stuart-Williams-CLA Thanks for raising the issue!

However, we do have the doc for debug log configuration of VSCode extension in readme.md: https://github.com/Azure/Azurite?tab=readme-ov-file#visual-studio-code-extension:~:text=by%20default%20false-,azurite.debug,-Output%20debug%20log

If you think the above section is not clear enough for customer to find Azurite debug log, Azurite welcome contribution. It would be great if you could raise a PR to make the description more clear!

[mrcz]

I also had this question, and the response is extremely unhelpful as it links to documentation that it is clear from the question that the person asking has already read.

So the question is, "If I run azurite from the command line, I set a debug file with the -d option, however if I try to do the same from within the vscode plugin, there is only a debug: true/false option. So where is the output written to?"

Perhaps the document linked to has changed but it says something about it going into an azurite channel with no explanation of what that might be and a google search for it gives no useful results.

So I have spent the better part of a day to find out the answer, and you do the following:

1. Set debug to true in azurite options inside vscode/plugins
2. Go to the 'View' menu and select 'Output'
3. In the pane that opens (in the bottom of vscode in my case), at the top right of the pane, select "Azurite"
4. The logs should now be visible in the output pane

[blueww]

@mrcz

Thanks for the details!

Azurite welcome contribution! Would you like to raise a PR to give a more detail guild to open the Azurite channel in VScode?