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

[CHORE] enable tracing for our crates #2993

Merged
merged 1 commit into from
Oct 23, 2024
Merged

[CHORE] enable tracing for our crates #2993

merged 1 commit into from
Oct 23, 2024

Conversation

rescrv
Copy link
Contributor

@rescrv rescrv commented Oct 23, 2024

Description of changes

  • We only had tracing for the worker crate. Enable it for all our crates at trace level and info level for non-chroma crates.

Test plan

How are these changes tested?

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

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

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)

@@ -39,7 +39,8 @@ pub(crate) fn init_otel_tracing(service_name: &String, otel_endpoint: &String) {
.with_filter(tracing_subscriber::filter::LevelFilter::INFO);
// global filter layer. Don't filter anything at global layer for this crate. And disable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: change the comment here as it is not in sync with the code below

@rescrv rescrv merged commit 3226650 into main Oct 23, 2024
70 checks passed
@rescrv rescrv deleted the rescrv/qol-tracing branch October 23, 2024 23:56
let global_layer = EnvFilter::new(
"error,".to_string()
+ &vec![
"chroma",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

everytime we add a crate, will we have to add it here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want it to be something other than error, yes. There's no real good way to select by crate and then not have to select by crate.

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.

3 participants