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

feat: Clarify register API documentation #4280

Merged
merged 2 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 10 additions & 7 deletions packages/phoenix-otel/src/phoenix/otel/otel.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,16 @@ def register(
can be found at https://opentelemetry.io/docs/specs/otel/trace/sdk/.

Args:
endpoint: The collector endpoint to which spans will be exported. If not provided, the
`PHOENIX_OTEL_COLLECTOR_ENDPOINT` environment variable will be used. The export
protocol will be inferred from the endpoint.
project_name: The name of the project to which spans will be associated. If not provided,
the `PHOENIX_PROJECT_NAME` environment variable will be used.
batch: If True, spans will be processed using a BatchSpanprocessor. If False, spans will be
processed one at a time using a SimpleSpanProcessor.
endpoint (str, optional): The collector endpoint to which spans will be exported. If not
provided, the `PHOENIX_OTEL_COLLECTOR_ENDPOINT` environment variable will be used. The
export protocol will be inferred from the endpoint.
project_name (str, optional): The name of the project to which spans will be associated. If
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 (bool): If False, the TracerProvider will not be set as the global provider.
Defaults to True.
headers (dict, optional): Optional headers to include in the HTTP request to the collector.
"""

project_name = project_name or get_env_project_name()
Expand Down
2 changes: 1 addition & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"package-name": "arize-phoenix-otel",
"release-type": "python",
"prerelease-type": "alpha",
"prerelease": true,
"prerelease": true
}
}
}
Loading