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

why.init() automatic uploads is confusing #1570

Closed
1 task done
jamie256 opened this issue Sep 26, 2024 · 1 comment
Closed
1 task done

why.init() automatic uploads is confusing #1570

jamie256 opened this issue Sep 26, 2024 · 1 comment
Assignees

Comments

@jamie256
Copy link
Contributor

jamie256 commented Sep 26, 2024

Description

Many of the whylogs examples use why.init() which results in automatic uploading of profiles while logging. This is confusing when adapting the code to production use cases where you want to decouple the profiling and manage the upload explicitly with a WhyLabsWriter.

Suggestions

  • Create an opt-in parameter for automatic uploads of profiles, and update examples to use that.
  • Change default behavior to not automatically upload profiles while logging.
  • Detect when there is an existing authenticated session and opted in for automatic uploads in the WhyLabsWriter and log a warning to the user to help give visibility into the scenario where users upload the same profile twice unintentionally.
  • Consider allowing anonymous sessions to automatically upload, and make this behavior scoped to anonymous sessions.
@jamie256
Copy link
Contributor Author

jamie256 commented Oct 1, 2024

Fixed in #1571

@jamie256 jamie256 closed this as completed Oct 1, 2024
richard-rogers added a commit that referenced this issue Oct 2, 2024
## Description

Updates `init()` docstring to describe `upload_on_log`

## Related

Relates to #1570


- [ ] I have reviewed the [Guidelines for Contributing](CONTRIBUTING.md)
and the [Code of Conduct](CODE_OF_CONDUCT.md).
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

No branches or pull requests

2 participants