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

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

Open
Stuart-Williams-CLA opened this issue Jul 18, 2024 · 1 comment
Assignees
Labels
question Further information is requested vsc Visual Studio Code Extension

Comments

@Stuart-Williams-CLA
Copy link

Stuart-Williams-CLA commented Jul 18, 2024

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 blueww self-assigned this Jul 19, 2024
@blueww blueww added question Further information is requested vsc Visual Studio Code Extension labels Jul 19, 2024
@blueww
Copy link
Member

blueww commented Jul 19, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested vsc Visual Studio Code Extension
Projects
None yet
Development

No branches or pull requests

2 participants