AllenInstitute / AllenInstitute/vis
Logging
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10
- Forks
- 1
- Avg merge
- 10h 24m
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem? Please describe.
We have a logger in vis-core that we should start using it more substantially through our packages.
Describe the solution you'd like
Ideally we place them in a lot of places to help debug issues in a live environment. That will take some deciding on when to use the different levels and where.
Describe alternatives you've considered
We can continue to not log much and debug things as we currently do.
Additional context
One problem to solve is that vis-geometry does not depend on vis-core so adding logs there would require pulling that in, which we don't really want to have to do. I'm sure there's ways to set it up so that we only call the logger if the vis-core package is a peerDependency though!
It's possible that we don't really need logging in vis-geometry since it's all mostly very straightforward math though.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing logger in vis-core and how the packages, especially vis-geometry, declare dependencies. Determine where logging should be added, which levels are appropriate, and whether vis-geometry should remain independent; the issue does not define a settled scope or completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100