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

[BUG] Make opentelemetry dependencies optional #3290

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eculver
Copy link
Contributor

@eculver eculver commented Dec 11, 2024

Description of changes

This is just a DRAFT meant to discuss what it would take to provide a workaround for #2571 and any other potential issues with our protobuf files being inconsistent. The primary question we need to answer is:

Does this provide enough value than the cost it imposes on installing Chroma's dependencies?

In other words, this is imperfect, so is it even worth doing versus making OTEL truly optional in our codebase by doing a huge refactor.

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • This makes our opentelemetry dependencies optional
    • We are not doing anything magical here to turn off OTEL wholesale in the codebase by excluding these dependencies
    • We are doing this to avoid issues like [Bug]: Error chroma with protobuf #2571 where protos are built with incompatible versions external to Chroma
  • New functionality
    • This introduces the need to install OTEL dependencies with pip install chromadb[opentelemetry]

Test plan

  • I tested that I can target the optional dependencies by doing pip install '.[opentelemetry]'

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

  • README has been updated with a note about installing OTEL dependencies.

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

@eculver eculver changed the title Make opentelemetry dependencies optional [BUG] Make opentelemetry dependencies optional Dec 11, 2024
Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

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

Successfully merging this pull request may close these issues.

1 participant