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

Feature: Add comments and execution logs #2824

Open
Metal-Mighty opened this issue Jan 24, 2024 · 0 comments
Open

Feature: Add comments and execution logs #2824

Metal-Mighty opened this issue Jan 24, 2024 · 0 comments
Labels
enhancement New feature or request refinement

Comments

@Metal-Mighty
Copy link

Is your feature request related to a problem? Please describe.
I was digging in the code of the portal to find the source of an issue and I noticed that

  1. The code is very sparsely commented,
  2. We are missing a lot of execution logs that could be helpful to follow the actions on the portal and get some information about queries done to APIs and cloud providers to know more about the execution context.

Describe the solution you'd like
For 1., add comments to all methods and document the code inside methods when necessary, depending on complexity.
For 2., add execution logs and debug information for context, e.g. in AzureIoTHub.Portal.Infrastructure.Services.LoRaWanManagementService.ExecuteLoRaDeviceMessage, I don't know the query's target, the device Id, the URI of the tarfet API, ... which would provide more insight on the internal behavior of the portal without having to setup a local instance for debugging and bugfixes.

Describe alternatives you've considered

Additional context

@Metal-Mighty Metal-Mighty added enhancement New feature or request refinement labels Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refinement
Projects
Status: 📝 Todo
Development

No branches or pull requests

1 participant