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

Discuss and implement diagnostic levels #38

Open
eelstork opened this issue Jul 23, 2022 · 0 comments
Open

Discuss and implement diagnostic levels #38

eelstork opened this issue Jul 23, 2022 · 0 comments
Labels
debug-chan Logging related enhancement New feature or request

Comments

@eelstork
Copy link
Collaborator

Currently Debug-Chan does not offer diagnostic levels. For many projects, will not scale.

Ideas:

  • Severity/LOD in general is not a great concept. A severity of 0, 1, 2, ... does not mean much. However, users may assign meaning to these (accept custom enums if easy enough)
  • Debug-Chan is a logging tool. Its primary purpose is offering information beyond warnings and errors (happy to keep warnings and errors in the Unity console)
  • Logging from public/protected/private... channeling based on this would be somewhat meaningful; don't think C# diagnostics include this but can get at it.

If there's a need to refine the debug chan APIs, how I see it -

  • A log message expressing actual change (data write) is informative
  • A log message clarifying control, but no mutation, is diagnostic
  • Two-level messages including informative + diagnostic component may be good
  • A QA API may be helpful to log key milestones which are also useful for validating features (as opposed to investigating issues)
  • Ordinarily, we do not want objects to log when they can be described as "doing nothing" (quiescence rule) - that is, unless we think they should be doing something.

The core API should avoid overreach (log the way you want!); maybe attaching an int representing a channel / target will suffice; still, an optional API normalizing a good approach?

@eelstork eelstork added enhancement New feature or request debug-chan Logging related labels Jul 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debug-chan Logging related enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant