search

Azure / Azurite

A lightweight server clone of Azure Storage that simulates most of the commands supported by it with minimal dependencies
MIT License
1.85k stars 325 forks source link

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

Open Stuart-Williams-CLA opened 4 months ago

Stuart-Williams-CLA commented 4 months ago

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 commented 4 months ago

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