nickna / Neighborly

An open-source vector database
MIT License
9 stars 2 forks source link

Add Logging and Error Handling #22

Open nickna opened 1 month ago

nickna commented 1 month ago

Description:

Enhance the logging and error handling mechanisms in Neighborly to provide more informative and actionable logs and error messages.

Tasks:

Resources:

Impact:

Enhanced logging and error handling will make it easier to diagnose and fix issues, improving the stability and maintainability of Neighborly.

How to Contribute:

  1. Fork the repository and create a new branch for your changes.
  2. Implement the logging and error handling improvements.
  3. Ensure all new and existing tests pass.
  4. Submit a pull request with a detailed description of the changes.
nickna commented 3 weeks ago

Added logging support in this commit: 0644adace84783c06e773bb9d3a55353b5fe502b

hangy commented 2 weeks ago

Added logging support in this commit: 0644ada

To be honest, I'd move the concrete logger from the library to the API. At least if the idea is to enable using the package as an in-memory vector db in a program, then it would be better to just log to Microsoft.Extensions.Logging.Abstractions, and allow consumers of the NuGet package to define their own log targets.