7125e24619
Summary: If user do not end the trace manually, the tracing will continue which can potential use up all the storage space and cause problem. In this PR, the max trace file size is added to the TraceOptions and user can set the value if they need or the default is 64GB. Pull Request resolved: https://github.com/facebook/rocksdb/pull/4610 Differential Revision: D12893400 Pulled By: zhichao-cao fbshipit-source-id: acf4b5a6076bb691778bdfbac4864e1006758953
49 lines
1.7 KiB
C++
49 lines
1.7 KiB
C++
// 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
|
|
|
|
#include "rocksdb/env.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
// Allow custom implementations of TraceWriter and TraceReader.
|
|
// By default, RocksDB provides a way to capture the traces to a file using the
|
|
// factory NewFileTraceWriter(). But users could also choose to export traces to
|
|
// any other system by providing custom implementations of TraceWriter and
|
|
// TraceReader.
|
|
|
|
// TraceWriter allows exporting RocksDB traces to any system, one operation at
|
|
// a time.
|
|
class TraceWriter {
|
|
public:
|
|
TraceWriter() {}
|
|
virtual ~TraceWriter() {}
|
|
|
|
virtual Status Write(const Slice& data) = 0;
|
|
virtual Status Close() = 0;
|
|
virtual uint64_t GetFileSize() = 0;
|
|
};
|
|
|
|
// TraceReader allows reading RocksDB traces from any system, one operation at
|
|
// a time. A RocksDB Replayer could depend on this to replay opertions.
|
|
class TraceReader {
|
|
public:
|
|
TraceReader() {}
|
|
virtual ~TraceReader() {}
|
|
|
|
virtual Status Read(std::string* data) = 0;
|
|
virtual Status Close() = 0;
|
|
};
|
|
|
|
// Factory methods to read/write traces from/to a file.
|
|
Status NewFileTraceWriter(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceWriter>* trace_writer);
|
|
Status NewFileTraceReader(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceReader>* trace_reader);
|
|
} // namespace rocksdb
|