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

The API should allow the switch of the debugger options. #5

Open
Tracked by #6
guibranco opened this issue Sep 13, 2024 · 3 comments
Open
Tracked by #6

The API should allow the switch of the debugger options. #5

guibranco opened this issue Sep 13, 2024 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Participation in the Hacktoberfest event help wanted Extra attention is needed 👷🏼 infrastructure Infrastructure-related tasks or issues 🕓 medium effort A task that can be completed in a few hours 🧪 tests Tasks related to testing

Comments

@guibranco
Copy link
Owner

guibranco commented Sep 13, 2024

Description

The API should provide an endpoint that allows users to switch debugger options dynamically. This would enable users to turn debugging features on or off and modify debugger settings without restarting or reconfiguring the entire system.

Rationale

  1. Dynamic Debugging: Allowing the switch of debugger options through an API will enable developers to toggle debugging modes based on real-time needs, improving flexibility during development and troubleshooting.
  2. Efficiency: Developers can adjust debugging settings without stopping the application, reducing downtime and maintaining system performance during issue resolution.
  3. Automation: Integrating this capability into CI/CD pipelines or monitoring tools would allow automated switching of debug modes in response to specific events or triggers, ensuring faster issue identification and resolution.
  4. Customizability: Different debugging levels can be applied depending on the environment or situation, ensuring the right level of information is captured when necessary.

Expected Behavior

  1. A new endpoint, such as /debugger-options, allows the user to:
    • Enable or disable the debugger.
    • Update specific debugger settings, but name.
  2. The endpoint should allow both GET (to retrieve current debugger settings) and POST/PUT (to update debugger options).

API Example

Retrieve Current Debugger Settings

GET /debugger-options

Sample Response

{
  "all": true,
 "repositories": false,
 "issues": false,
 "pushes": false
}

Update Debugger Settings

PUT /debugger-options/all
Content-Type: application/json

{
  "setting": false
}

Sample Response

{
  "status": "success",
  "message": "Debugger options updated successfully"
}

Additional Notes

  • The endpoint should validate input values (e.g., only accept predefined debug options).
  • Include safeguards to prevent accidental disabling of critical debugging features.
  • Consider adding environment-specific restrictions (e.g., disabling certain debugging modes in production environments).
  • Optionally include support for different debugger types if the system allows multiple debugging mechanisms (e.g., logging-based, breakpoints, etc.).
Copy link

gitauto-ai bot commented Sep 13, 2024

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-09-21 10:07:38+00:00.
Consider subscribing if you want more requests.
If you have any questions or concerns, please contact us at info@gitauto.ai.

@guibranco guibranco added enhancement New feature or request 👷🏼 infrastructure Infrastructure-related tasks or issues 🧪 tests Tasks related to testing 🕓 medium effort A task that can be completed in a few hours labels Sep 13, 2024
Copy link

gitauto-ai bot commented Sep 24, 2024

Sorry, we have an error. Please try again.

Have feedback or need help?
Feel free to email info@gitauto.ai.

@guibranco guibranco added help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest Participation in the Hacktoberfest event labels Oct 9, 2024
@guibranco guibranco transferred this issue from guibranco/gstraccini-bot-service Oct 9, 2024
Copy link

gitauto-ai bot commented Oct 9, 2024

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-10-21 10:07:38+00:00.
Consider subscribing if you want more requests.
If you have any questions or concerns, please contact us at info@gitauto.ai.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Participation in the Hacktoberfest event help wanted Extra attention is needed 👷🏼 infrastructure Infrastructure-related tasks or issues 🕓 medium effort A task that can be completed in a few hours 🧪 tests Tasks related to testing
Projects
None yet
Development

No branches or pull requests

1 participant