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

"Live" debug options #101

Open
diafour opened this issue Jan 22, 2020 · 1 comment
Open

"Live" debug options #101

diafour opened this issue Jan 22, 2020 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@diafour
Copy link
Contributor

diafour commented Jan 22, 2020

Debug endpoint introduced by #8 can be used to set debug options in runtime:

  • endpoints:
    • /debug/settings[.json|.yaml] — list settings (DebugKeepTmpFiles, LogLevel, etc.)
    • /debug/settings/ GET | PUT (set value) | DELETE(reset to default)
  • add cli command debug to addon-operator:
    • shell-operator debug settings list [-o yaml|json]
    • shell-operator debug settings get <name>|<group>
    • shell-operator debug settings set <name> <value>
    • shell-operator debug settings reset <name>
  • possible options:
    • debug.keepTmpFiles
    • log.level
    • debug.log.helmOutput — log output from helm commands
    • debug.log.kubernetesEvents — log information about incoming kubernetes events
    • debug.log.kubernetesEvents.dumpObjects — also dump incoming objects
    • ...
@diafour diafour added this to the 1.0.0 milestone Jan 22, 2020
@diafour diafour added the enhancement New feature or request label Jan 24, 2020
@diafour diafour mentioned this issue Feb 6, 2020
@diafour diafour modified the milestones: 1.0.0, future Mar 30, 2021
@diafour
Copy link
Contributor Author

diafour commented Sep 1, 2021

More debugging tools:

  • Debug log buffer. A user can get debug log even if the log level is not a debug.
  • Get 'live' log focused on module/hook/binding.
  • Change log level for module/hook/binding.
  • Get snapshots from Monitor for hook or binding. (feat(debug): command to get snapshots #345)
  • Toggle logging of Kubernetes events and incoming objects for hook or binding.
  • Show history of hook executions for the module.
  • Task execution history in queue listing. Show N finished tasks for shell-operator debug queue.
  • Show queues for the module. Main queue + all queues in module hooks. (feat: debug endpoint and cli #105, feat(debug): command to get snapshots #345)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant