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.

Sign up for GitHub

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

Jump to bottom

chore: Make keyword argument more explicit #4387

Merged
merged 1 commit into from
Aug 26, 2024
Merged

chore: Make keyword argument more explicit #4387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/phoenix-otel/src/phoenix/otel/otel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def register(
endpoint: Optional[str] = None,
project_name: Optional[str] = None,
batch: bool = False,
set_global_tracer: bool = True,
set_global_tracer_provider: bool = True,
headers: Optional[Dict[str, str]] = None,
verbose: bool = True,
) -> _TracerProvider:
Expand All @@ -51,7 +51,7 @@ def register(
not provided, the `PHOENIX_PROJECT_NAME` environment variable will be used.
batch (bool): If True, spans will be processed using a BatchSpanprocessor. If False, spans
will be processed one at a time using a SimpleSpanProcessor.
set_global_tracer (bool): If False, the TracerProvider will not be set as the global
set_global_tracer_provider (bool): If False, the TracerProvider will not be set as the global
tracer provider. Defaults to True.
headers (dict, optional): Optional headers to include in the HTTP request to the collector.
verbose (bool): If True, configuration details will be printed to stdout.
Expand All @@ -68,12 +68,12 @@ def register(
tracer_provider.add_span_processor(span_processor)
tracer_provider._default_processor = True

if set_global_tracer:
if set_global_tracer_provider:
trace_api.set_tracer_provider(tracer_provider)
global_provider_msg = (
"| \n"
"| `register` has set this TracerProvider as the global OpenTelemetry default.\n"
"| To disable this behavior, call `register` with `set_global_tracer=False`.\n"
"| To disable this behavior, call `register` with `set_global_tracer_provider=False`.\n"
)
else:
global_provider_msg = ""
Expand Down
Loading