[OPIK-187] [SDK] Allow users to configure the project name in track decorator #348
Conversation
…ct name of parent object)
# Conflicts: # sdks/python/src/opik/api_objects/opik_client.py
| @@ -296,6 +309,16 @@ def _create_span( | |||
| if current_span_data is not None: | |||
| # There is already at least one span in current context. | |||
| # Simply attach a new span to it. | |||
|
|
|||
| if start_span_arguments.project_name != current_span_data.project_name: | |||
| LOGGER.warning( | |||
There was a problem hiding this comment.
My concern here is that we might spam the user with these messages if they try to add Spans with different project_names to a Trace with a specific project name, triggering a warning for each mismatch.
There was a problem hiding this comment.
Two options here, we can either move to "debug" and then users won't see it unless they enable debug mode or keep as is. Feel free to pick whichever one you think makes the most sense
There was a problem hiding this comment.
Ok, since this isn't a standard user flow, I suggest keeping a warning so the user knows when they're doing something wrong
There was a problem hiding this comment.
@japdubengsub I took a look, let's update the code so that is displayed only when the users explicitly specifies a project name for the span that is different than the parent span project name.
In the scenario below, we should not be showing a warning:
import opik
@opik.track
def lower_level_function(input_arg: str):
print(input_arg)
@opik.track(project_name="My project")
def top_level_function(input_arg: str):
print(input_arg)
lower_level_function(input_arg)
top_level_function("Hello world !")We should not show the:
OPIK: You are attempting to log data into a nested span under the project name "None". However, the project name "My project" from parent span will be used instead.
There was a problem hiding this comment.
Agree, only when explicitly provided.
| @@ -316,6 +340,15 @@ def _create_span( | |||
| # to context manually (not via decorator). | |||
| # In that case decorator should just create a span for the existing trace. | |||
|
|
|||
| if start_span_arguments.project_name != current_trace_data.project_name: | |||
| LOGGER.warning( | |||
There was a problem hiding this comment.
same concern as in comment above
There was a problem hiding this comment.
Same answer, only when explicitly provided.
| @@ -296,6 +309,16 @@ def _create_span( | |||
| if current_span_data is not None: | |||
| # There is already at least one span in current context. | |||
| # Simply attach a new span to it. | |||
|
|
|||
| if start_span_arguments.project_name != current_span_data.project_name: | |||
| LOGGER.warning( | |||
There was a problem hiding this comment.
Agree, only when explicitly provided.
| @@ -316,6 +340,15 @@ def _create_span( | |||
| # to context manually (not via decorator). | |||
| # In that case decorator should just create a span for the existing trace. | |||
|
|
|||
| if start_span_arguments.project_name != current_trace_data.project_name: | |||
| LOGGER.warning( | |||
There was a problem hiding this comment.
Same answer, only when explicitly provided.
ferc
changed the title
# Conflicts: # sdks/python/src/opik/decorator/base_track_decorator.py
…for the span that is different from the parent span project name
Details
This pull request adds support for a new parameter,
project_name, for use in thetrack()decorator.When specifying different
project_namevalues for aTraceand its nestedSpan, theproject_nameof the main object (theTrace) will be used. The same rule applies to nestedSpans.If the
project_nameof a parent object and its nested object do not match, a message will be displayed indicating that theproject_nameof the parent will be used.If
project_nameis not specified manually, all data will be logged to the Default Project.