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

Loguru integration #37

Open
bbonenfant opened this issue Sep 23, 2020 · 2 comments
Open

Loguru integration #37

bbonenfant opened this issue Sep 23, 2020 · 2 comments
Labels
enhancement New feature or request question Further information is requested

Comments

@bbonenfant
Copy link
Contributor

Exploratory ticket on the use of loguru within snappiershot.

Some topics to cover:

  • Do we want to add a dependency like this (if not could we have this be an optional "feature")?
  • How is logging typically done within packages and/or plugins?
  • What would we be logging within snappiershot? How would users find and interact with these logs?
@bbonenfant bbonenfant added the enhancement New feature or request label Sep 23, 2020
@bbonenfant bbonenfant added the question Further information is requested label Oct 15, 2020
@lenabradley
Copy link
Contributor

I'm undecided if logging really makes sense here or not (loguru-based or otherwise); I go back and forth depending on the day

Random thoughts:

  • if we do add logging, it should be off-by-default & something that package-developers can turn on as needed
  • things we might want to log:
    • details about gathering/recording/looking-up snapshot context
    • details about file reading/writing
    • details about which custom en/decoders are being used/called
  • while this could all be useful, i'm currently inclined to say we shoudl hold off and add it when we actually start to feel the need for these things.
  • loguru vs logging:
    • loguru:
      • pros: easy to use, easy for outside developers to quickly learn & add/modify
      • cons: added dependency, could cause confusion to users
    • logging:
      • pros: in standardlib so no added dependency
      • cons: harder to setup initially, maybe harder for some developers to learn & use

@bbonenfant
Copy link
Contributor Author

I agree that any logging should be off-by-default and that we should hold off for now until we see for use cases.
Also, I believe that we should use logging over loguru to avoid a potentially heavy dependency.

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

No branches or pull requests

2 participants