package debugpb
Get desktop application:
View/edit binary Protocol Buffers messages
service Debug
debugpb.proto:30Debug service for TiKV. Errors are defined as follow: - OK: Okay, we are good! - UNKNOWN: For unknown error. - INVALID_ARGUMENT: Something goes wrong within requests. - NOT_FOUND: It is key or region not found, it's based on context, detailed reason can be found in grpc message. Note: It bypasses raft layer.
rpc Get (, )
debugpb.proto:33Read a value arbitrarily for a key. Note: Server uses key directly w/o any encoding.
message
debugpb.proto:114DB db = 1
string cf = 2
bytes key = 3
message
debugpb.proto:120bytes value = 1
rpc RaftLog (, )
debugpb.proto:36Read raft info.
message
debugpb.proto:124uint64 region_id = 1
uint64 log_index = 2
message
debugpb.proto:129optional entry = 1
rpc RegionInfo (, )
debugpb.proto:37message
debugpb.proto:133uint64 region_id = 1
message
debugpb.proto:137optional raft_local_state = 1
optional raft_apply_state = 2
optional region_local_state = 3
rpc RegionSize (, )
debugpb.proto:41Calculate size of a region. Note: DO NOT CALL IT IN PRODUCTION, it's really expensive.
message
debugpb.proto:143uint64 region_id = 1
repeated string cfs = 2
message
debugpb.proto:148repeated entries = 1
rpc ScanMvcc (, stream )
debugpb.proto:46Scan a specific range. Note: DO NOT CALL IT IN PRODUCTION, it's really expensive. Server uses keys directly w/o any encoding.
message
debugpb.proto:157bytes from_key = 1
bytes to_key = 2
uint64 limit = 3
message
debugpb.proto:163bytes key = 1
optional info = 2
rpc Compact (, )
debugpb.proto:50Compact a column family in a specified range. Note: Server uses keys directly w/o any encoding.
message
debugpb.proto:177DB db = 1
string cf = 2
bytes from_key = 3
bytes to_key = 4
uint32 threads = 5
BottommostLevelCompaction bottommost_level_compaction = 6
message
debugpb.proto:186(message has no fields)
rpc InjectFailPoint (, )
debugpb.proto:54Inject a fail point. Currently, it's only used in tests. Note: DO NOT CALL IT IN PRODUCTION.
message
debugpb.proto:189string name = 1
string actions = 2
message
debugpb.proto:194(message has no fields)
rpc RecoverFailPoint (, )
debugpb.proto:56Recover from a fail point.
message
debugpb.proto:197string name = 1
message
debugpb.proto:201(message has no fields)
rpc ListFailPoints (, )
debugpb.proto:58List all fail points.
message
debugpb.proto:204(message has no fields)
message
debugpb.proto:207repeated entries = 1
rpc GetMetrics (, )
debugpb.proto:61Get Metrics
message
debugpb.proto:216bool all = 1
message
debugpb.proto:220string prometheus = 1
string rocksdb_kv = 2
string rocksdb_raft = 3
string jemalloc = 4
uint64 store_id = 5
Do a consistent check for a region.
message
debugpb.proto:228uint64 region_id = 1
message
debugpb.proto:232(message has no fields)
rpc ModifyTikvConfig (, )
debugpb.proto:67dynamically modify tikv's config
message
debugpb.proto:235MODULE module = 1
string config_name = 2
string config_value = 3
message
debugpb.proto:241(message has no fields)
rpc GetRegionProperties (, )
debugpb.proto:70Get region properties
message
debugpb.proto:249uint64 region_id = 1
message
debugpb.proto:253repeated props = 1
rpc GetStoreInfo (, )
debugpb.proto:73Get store ID
message
debugpb.proto:257(message has no fields)
message
debugpb.proto:260uint64 store_id = 1
kvrpcpb.APIVersion api_version = 2
rpc GetClusterInfo (, )
debugpb.proto:76Get cluster ID
message
debugpb.proto:265(message has no fields)
message
debugpb.proto:268uint64 cluster_id = 1
rpc GetAllRegionsInStore (, )
debugpb.proto:79Get all region IDs in the store
message
debugpb.proto:272(message has no fields)
message
debugpb.proto:275repeated uint64 regions = 1
rpc ResetToVersion (, )
debugpb.proto:82Make this TiKV node return to the status on this node to certain ts.
message
debugpb.proto:279uint64 ts = 1
message
debugpb.proto:283(message has no fields)
rpc GetRangeProperties (, )
debugpb.proto:85Get range properties
message
debugpb.proto:286bytes start_key = 1
bytes end_key = 2
message
debugpb.proto:291repeated properties = 1
rpc FlashbackToVersion (, )
debugpb.proto:88Flashback given key range to a specified version.
message
debugpb.proto:300optional context = 1
uint64 version = 2
uint64 region_id = 3
bytes start_key = 4
bytes end_key = 5
uint64 start_ts = 6
uint64 commit_ts = 7
message
debugpb.proto:310string error = 1
GetRegionReadProgress returns the some useful info in RegionReadProgress
message
debugpb.proto:314uint64 region_id = 1
bool log_locks = 2
when set to true, print a log of the locks with min start_ts in the resolver.
uint64 min_start_ts = 3
only print locks whose start_ts >= min_start_ts. Can be used to find certain transaction.
message
debugpb.proto:320uint64 safe_ts = 1
below are from region_read_progress module
uint64 applied_index = 2
uint64 pending_front_applied_index = 3
uint64 pending_front_ts = 4
uint64 pending_back_applied_index = 5
uint64 pending_back_ts = 6
bool region_read_progress_paused = 7
uint64 duration_to_last_update_safe_ts_ms = 8
uint64 duration_to_last_consume_leader_ms = 9
bool region_read_progress_exist = 10
uint64 read_state_ts = 18
uint64 read_state_apply_index = 19
bool discard = 20
uint64 resolved_ts = 11
below are from resolved-ts module
uint64 resolver_tracked_index = 12
bool resolver_exist = 13
bool resolver_stopped = 14
uint64 num_locks = 16
uint64 num_transactions = 17
string error = 15
Used in:
Skip = 0
Skip bottommost level compaction
Force = 1
Force bottommost level compaction
IfHaveCompactionFilter = 2
Compact bottommost level if there is a compaction filter.
enum DB
debugpb.proto:94Used in: ,
INVALID = 0
KV = 1
RAFT = 2
message
debugpb.proto:292Used in:
string key = 1
string value = 2
message
debugpb.proto:208Used in:
string name = 1
string actions = 2
Used in:
UNUSED = 0
KVDB = 1
RAFTDB = 2
READPOOL = 3
SERVER = 4
STORAGE = 5
PD = 6
METRIC = 7
COPROCESSOR = 8
SECURITY = 9
IMPORT = 10
message
debugpb.proto:244Used in:
string name = 1
string value = 2
message
debugpb.proto:149Used in:
string cf = 1
uint64 size = 2