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]: Added return of the original function result when tracer not defined #1268

Merged

Conversation

tazarov
Copy link
Contributor

@tazarov tazarov commented Oct 22, 2023

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    - When (for some reason) the tracer is not defined, we seem to be returning None, added original function return for completeness
    • Added _transform_attributes method as this seemed to be throwing an exception

Test plan

How are these changes tested?

Manual testing with Zipkin/Jaeger

Documentation Changes

N/A

…efined

- Added _transform_attributes method as this seemed to be throwing an exception
@github-actions
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 (Readbility, Modularity, Intuitiveness)

@tazarov
Copy link
Contributor Author

tazarov commented Oct 22, 2023

@beggers, have a look. I might be wrong, but this worked for me using local tracing (referring to _transform_attributes).

Copy link
Contributor

@beggers beggers left a comment

Choose a reason for hiding this comment

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

Appreciate the thoroughness here. One small request then we can get this in before we cut tomorrow's release.

@@ -129,4 +139,4 @@ def add_attributes_to_current_span(
if not tracer:
return
span = trace.get_current_span()
span.set_attributes(_transform_attributes(attributes)) # type: ignore
span.set_attributes(_transform_attributes(attributes))
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, this was sloppy on my part. The correct fix here is to simply remove the call to _transform_attributes.

The call to _transform_attributes is a holdover from when add_attributes_to_current_span accepted a Dict[str, Any], since OTel wants attribute values to be one of [str, bool, float, int]. @HammadB and I talked about this in code review and decided we should strongly type add_attributes_to_current_span so transformation is no longer necessary.

All that said: let's delete _transform_attributes and the call to it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

mypy is still complaining:

image

Should I do this instead?:

span.set_attributes({k: cast(types.AttributeValue, v)
                        for k, v in attributes.items()})

It seems that Otel expects AttributeValue so we might have to do the conversion.

Note: We can even widen the accepted values to include sequences of the ones you mentioned above:

AttributeValue = Union[
    str,
    bool,
    int,
    float,
    Sequence[str],
    Sequence[bool],
    Sequence[int],
    Sequence[float],
]

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, this is why I shouldn't review code on Sunday night ;)

I like your original method of solving this, or I'd be happy to cast to AttributeValue inline in add_attributes_to_current_span -- up to you. And sorry to have asked you to make an unnecessary change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Take a look at the latest change, it works and feels more minimalistic. (we live and die with mypy)

@@ -110,7 +120,7 @@ def wrapper(*args: Any, **kwargs: Dict[Any, Any]) -> Any:
if trace_granularity < granularity:
return f(*args, **kwargs)
if not tracer:
return
return f(*args, **kwargs)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice.

@beggers
Copy link
Contributor

beggers commented Oct 24, 2023

Merging so we can release today

@beggers beggers merged commit e95de3d into chroma-core:main Oct 24, 2023
84 checks passed
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.

2 participants