Periodically flush info log out of application buffer (#7488)
Summary: This PR schedules a background thread (shared across all DB instances) to flush info log every ten seconds. This improves debuggability in case of RocksDB hanging since it ensures the log messages leading up to the hang will eventually become visible in the log. The bulk of this PR is moving monitoring/stats_dump_scheduler* to db/periodic_work_scheduler* and making the corresponding name changes since now the scheduler handles info log flushing, not just stats dumping. Pull Request resolved: https://github.com/facebook/rocksdb/pull/7488 Reviewed By: riversand963 Differential Revision: D24065165 Pulled By: ajkr fbshipit-source-id: 339c47a0ff43b79fdbd055fbd9fefbb6f9d8d3b5main
Andrew Kryczka
4 years ago
committed by
Facebook GitHub Bot
parent
94fc676d3f
commit
1e00909730
@ -0,0 +1,70 @@ |
||||
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
||||
// This source code is licensed under both the GPLv2 (found in the
|
||||
// COPYING file in the root directory) and Apache 2.0 License
|
||||
// (found in the LICENSE.Apache file in the root directory).
|
||||
|
||||
#pragma once |
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "db/db_impl/db_impl.h" |
||||
#include "util/timer.h" |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
|
||||
// PeriodicWorkScheduler is a singleton object, which is scheduling/running
|
||||
// DumpStats(), PersistStats(), and FlushInfoLog() for all DB instances. All DB
|
||||
// instances use the same object from `Default()`.
|
||||
//
|
||||
// Internally, it uses a single threaded timer object to run the periodic work
|
||||
// functions. Timer thread will always be started since the info log flushing
|
||||
// cannot be disabled.
|
||||
class PeriodicWorkScheduler { |
||||
public: |
||||
static PeriodicWorkScheduler* Default(); |
||||
|
||||
PeriodicWorkScheduler() = delete; |
||||
PeriodicWorkScheduler(const PeriodicWorkScheduler&) = delete; |
||||
PeriodicWorkScheduler(PeriodicWorkScheduler&&) = delete; |
||||
PeriodicWorkScheduler& operator=(const PeriodicWorkScheduler&) = delete; |
||||
PeriodicWorkScheduler& operator=(PeriodicWorkScheduler&&) = delete; |
||||
|
||||
void Register(DBImpl* dbi, unsigned int stats_dump_period_sec, |
||||
unsigned int stats_persist_period_sec); |
||||
|
||||
void Unregister(DBImpl* dbi); |
||||
|
||||
// Periodically flush info log out of application buffer at a low frequency.
|
||||
// This improves debuggability in case of RocksDB hanging since it ensures the
|
||||
// log messages leading up to the hang will eventually become visible in the
|
||||
// log.
|
||||
static const uint64_t kDefaultFlushInfoLogPeriodSec = 10; |
||||
|
||||
protected: |
||||
std::unique_ptr<Timer> timer; |
||||
|
||||
explicit PeriodicWorkScheduler(Env* env); |
||||
|
||||
private: |
||||
std::string GetTaskName(DBImpl* dbi, const std::string& func_name); |
||||
}; |
||||
|
||||
#ifndef NDEBUG |
||||
// PeriodicWorkTestScheduler is for unittest, which can specify the Env like
|
||||
// SafeMockTimeEnv. It also contains functions for unittest.
|
||||
class PeriodicWorkTestScheduler : public PeriodicWorkScheduler { |
||||
public: |
||||
static PeriodicWorkTestScheduler* Default(Env* env); |
||||
|
||||
void TEST_WaitForRun(std::function<void()> callback) const; |
||||
|
||||
size_t TEST_GetValidTaskNum() const; |
||||
|
||||
private: |
||||
explicit PeriodicWorkTestScheduler(Env* env); |
||||
}; |
||||
#endif // !NDEBUG
|
||||
|
||||
} // namespace ROCKSDB_NAMESPACE
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
@ -1,64 +0,0 @@ |
||||
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
||||
// This source code is licensed under both the GPLv2 (found in the
|
||||
// COPYING file in the root directory) and Apache 2.0 License
|
||||
// (found in the LICENSE.Apache file in the root directory).
|
||||
|
||||
#pragma once |
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "db/db_impl/db_impl.h" |
||||
#include "util/timer.h" |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
|
||||
// StatsDumpScheduler is a singleton object, which is scheduling/running
|
||||
// DumpStats() and PersistStats() for all DB instances. All DB instances uses
|
||||
// the same object from `Default()`.
|
||||
// Internally, it uses a single threaded timer object to run the stats dump
|
||||
// functions. Timer thread won't be started if there's no function needs to run,
|
||||
// for example, option.stats_dump_period_sec and option.stats_persist_period_sec
|
||||
// are set to 0.
|
||||
class StatsDumpScheduler { |
||||
public: |
||||
static StatsDumpScheduler* Default(); |
||||
|
||||
StatsDumpScheduler() = delete; |
||||
StatsDumpScheduler(const StatsDumpScheduler&) = delete; |
||||
StatsDumpScheduler(StatsDumpScheduler&&) = delete; |
||||
StatsDumpScheduler& operator=(const StatsDumpScheduler&) = delete; |
||||
StatsDumpScheduler& operator=(StatsDumpScheduler&&) = delete; |
||||
|
||||
void Register(DBImpl* dbi, unsigned int stats_dump_period_sec, |
||||
unsigned int stats_persist_period_sec); |
||||
|
||||
void Unregister(DBImpl* dbi); |
||||
|
||||
protected: |
||||
std::unique_ptr<Timer> timer; |
||||
|
||||
explicit StatsDumpScheduler(Env* env); |
||||
|
||||
private: |
||||
std::string GetTaskName(DBImpl* dbi, const std::string& func_name); |
||||
}; |
||||
|
||||
#ifndef NDEBUG |
||||
// StatsDumpTestScheduler is for unittest, which can specify the Env like
|
||||
// SafeMockTimeEnv. It also contains functions for unittest.
|
||||
class StatsDumpTestScheduler : public StatsDumpScheduler { |
||||
public: |
||||
static StatsDumpTestScheduler* Default(Env* env); |
||||
|
||||
void TEST_WaitForRun(std::function<void()> callback) const; |
||||
|
||||
size_t TEST_GetValidTaskNum() const; |
||||
|
||||
private: |
||||
explicit StatsDumpTestScheduler(Env* env); |
||||
}; |
||||
#endif // !NDEBUG
|
||||
|
||||
} // namespace ROCKSDB_NAMESPACE
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
Loading…
Reference in new issue