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

Deprecate support for directly accessing logger #1690

Merged
merged 6 commits into from
Oct 16, 2024
Merged

Deprecate support for directly accessing logger #1690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
95e2896
Deprecate support for directly accessing logger
vyasr Oct 1, 2024
fc33baf
Add a detail API to avoid the deprecation warning during build
vyasr Oct 1, 2024
fa752a0
Update tracking mr test
vyasr Oct 10, 2024
92e9848
Update Cython
vyasr Oct 10, 2024
f77ca5e
Revert extraneous changes
vyasr Oct 10, 2024
3f18480
Merge remote-tracking branch 'upstream/branch-24.12' into feat/deprec…
vyasr Oct 10, 2024
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
25 changes: 16 additions & 9 deletions include/rmm/logger.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@ struct bytes {
}
};

inline spdlog::logger& logger()
vyasr marked this conversation as resolved.
Show resolved Hide resolved
{
static detail::logger_wrapper wrapped{};
return wrapped.logger_;
}
} // namespace detail

/**
Expand All @@ -107,23 +112,25 @@ struct bytes {
*
* @return spdlog::logger& The logger.
*/
RMM_EXPORT inline spdlog::logger& logger()
[[deprecated(
"Support for direct access to spdlog loggers in rmm is planned for "
"removal")]] RMM_EXPORT inline spdlog::logger&
logger()
vyasr marked this conversation as resolved.
Show resolved Hide resolved
{
static detail::logger_wrapper wrapped{};
return wrapped.logger_;
return detail::logger();
}

//! @cond Doxygen_Suppress
//
// The default is INFO, but it should be used sparingly, so that by default a log file is only
// output if there is important information, warnings, errors, and critical failures
// Log messages that require computation should only be used at level TRACE and DEBUG
#define RMM_LOG_TRACE(...) SPDLOG_LOGGER_TRACE(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_DEBUG(...) SPDLOG_LOGGER_DEBUG(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_INFO(...) SPDLOG_LOGGER_INFO(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_WARN(...) SPDLOG_LOGGER_WARN(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_ERROR(...) SPDLOG_LOGGER_ERROR(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_CRITICAL(...) SPDLOG_LOGGER_CRITICAL(&rmm::logger(), __VA_ARGS__)
#define RMM_LOG_TRACE(...) SPDLOG_LOGGER_TRACE(&rmm::detail::logger(), __VA_ARGS__)
#define RMM_LOG_DEBUG(...) SPDLOG_LOGGER_DEBUG(&rmm::detail::logger(), __VA_ARGS__)
#define RMM_LOG_INFO(...) SPDLOG_LOGGER_INFO(&rmm::detail::logger(), __VA_ARGS__)
#define RMM_LOG_WARN(...) SPDLOG_LOGGER_WARN(&rmm::detail::logger(), __VA_ARGS__)
#define RMM_LOG_ERROR(...) SPDLOG_LOGGER_ERROR(&rmm::detail::logger(), __VA_ARGS__)
#define RMM_LOG_CRITICAL(...) SPDLOG_LOGGER_CRITICAL(&rmm::detail::logger(), __VA_ARGS__)

//! @endcond

Expand Down
2 changes: 1 addition & 1 deletion python/rmm/rmm/librmm/_logger.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ cdef extern from "spdlog/spdlog.h" namespace "spdlog" nogil:
bool should_log(logging_level msg_level)


cdef extern from "rmm/logger.hpp" namespace "rmm" nogil:
cdef extern from "rmm/logger.hpp" namespace "rmm::detail" nogil:
cdef spdlog_logger& logger() except +
10 changes: 5 additions & 5 deletions tests/mr/device/tracking_mr_tests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,16 +204,16 @@ TEST(TrackingTest, LogOutstandingAllocations)
{
std::ostringstream oss;
auto oss_sink = std::make_shared<spdlog::sinks::ostream_sink_st>(oss);
rmm::logger().sinks().push_back(oss_sink);
auto old_level = rmm::logger().level();
rmm::detail::logger().sinks().push_back(oss_sink);
auto old_level = rmm::detail::logger().level();

tracking_adaptor mr{rmm::mr::get_current_device_resource_ref()};
std::vector<void*> allocations;
for (std::size_t i = 0; i < num_allocations; ++i) {
allocations.push_back(mr.allocate(ten_MiB));
}

rmm::logger().set_level(spdlog::level::debug);
rmm::detail::logger().set_level(spdlog::level::debug);
EXPECT_NO_THROW(mr.log_outstanding_allocations());

#if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_DEBUG
Expand All @@ -224,8 +224,8 @@ TEST(TrackingTest, LogOutstandingAllocations)
mr.deallocate(allocation, ten_MiB);
}

rmm::logger().set_level(old_level);
rmm::logger().sinks().pop_back();
rmm::detail::logger().set_level(old_level);
rmm::detail::logger().sinks().pop_back();
}

} // namespace
Expand Down
Loading