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

Deprecate support for directly accessing logger #1690

Merged
merged 6 commits into from
Oct 16, 2024

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Oct 1, 2024

Description

Contributes to rapidsai/build-planning#104

This PR removes support for accessing rmm's underlying spdlog logger directly.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@vyasr vyasr added breaking Breaking change improvement Improvement / enhancement to an existing function labels Oct 1, 2024
@vyasr vyasr self-assigned this Oct 1, 2024
@vyasr vyasr requested a review from a team as a code owner October 1, 2024 16:34
@vyasr vyasr requested review from harrism and bdice October 1, 2024 16:34
@github-actions github-actions bot added the cpp Pertains to C++ code label Oct 1, 2024
@vyasr vyasr requested a review from wence- October 1, 2024 18:22
@wence- wence- added the 5 - DO NOT MERGE Hold off on merging; see PR for details label Oct 2, 2024
@wence-
Copy link
Contributor

wence- commented Oct 2, 2024

Setting to do not merge, I think the Cython bindings in rmm/_lib/logger.pyx also want updated.

@wence-
Copy link
Contributor

wence- commented Oct 10, 2024

@vyasr am I right in my belief that the cython bindings now also want to use the detail API call?

@vyasr
Copy link
Contributor Author

vyasr commented Oct 10, 2024

@vyasr am I right in my belief that the cython bindings now also want to use the detail API call?

You are correct. In fact we probably need to do more than that. This PR can probably just do that, but we will need to add some public rmm APIs to do things that were previously being done by accessing the spdlog logger's APIs directly in the Cython layer. I'll work on that in a follow-up where I'll try to isolate the core APIs that rmm will need to support in order to not expose spdlog directly. I suspect that we're going to have to ask users to do some sort of unique symbol generation on their end so as to be able to generate a private set of spdlog symbols that they don't leak to consumers. That will also end up updating the tests, which for now I'm having call the detail API. I think that's a consistent approach here because in the Python layer we are exposing these other functions so we can look into providing replacements, and then exposing them in C++. For C++ users, for the moment they'll lose the direct access functionality but gain whatever replacements we add.

@vyasr vyasr requested review from a team as code owners October 10, 2024 22:25
@vyasr vyasr requested a review from msarahan October 10, 2024 22:25
@github-actions github-actions bot added the Python Related to RMM Python API label Oct 10, 2024
@vyasr vyasr removed the 5 - DO NOT MERGE Hold off on merging; see PR for details label Oct 10, 2024
@vyasr vyasr requested a review from wence- October 10, 2024 22:33
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Thanks!

@wence-
Copy link
Contributor

wence- commented Oct 16, 2024

/merge

@rapids-bot rapids-bot bot merged commit de42f57 into rapidsai:branch-24.12 Oct 16, 2024
58 checks passed
@harrism
Copy link
Member

harrism commented Oct 16, 2024

Reminder we need an issue for the required Cython/Python changes.

@vyasr vyasr deleted the feat/deprecate_spdlog_logger branch October 21, 2024 23:22
@vyasr
Copy link
Contributor Author

vyasr commented Oct 21, 2024

#1709

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change cpp Pertains to C++ code improvement Improvement / enhancement to an existing function Python Related to RMM Python API
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants