package slog.internal

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ForwardBatchData

• uint64 id = 1

• repeated Transaction transactions = 2

• TransactionType transaction_type = 3

  All txns in this batch has this same type. Can either be SINGLE_HOME or MULTI_HOME. LOCK_ONLY txns are also considered SINGLE_HOME.

• repeated TransactionEventInfo events = 4

  For recording the event time for all transactions in this batch simultaneously

Used in: Request

• uint64 batch_id = 1

Used in: Request

• uint64 tag = 1

• uint32 channel = 2

• bool stop = 3

* The schema of a configuration file.

• string protocol = 1

  Protocol for the zmq sockets in the broker. Use "tcp" for normal running and "icp" for unit and integration tests

• repeated Region regions = 2

  Region groups. Each group has a list of machine addresses with the size equal to number of partitions

• repeated uint32 broker_ports = 3

  Port for the zmq sockets in the broker. Each value will create a new broker thread

• uint32 server_port = 4

  Port for the server

• uint32 forwarder_port = 5

  Port for the forwarder

• uint32 sequencer_port = 6

  Port for the sequencer

• uint32 clock_synchronizer_port = 7

  Port for clock synchronizer. Set to 0 to disable clock synchronization

• uint32 num_partitions = 8

  Number of partitions per replica

• oneof partitioning

  Partitioning scheme

  • HashPartitioning hash_partitioning = 9

  • SimplePartitioning simple_partitioning = 10

  • SimplePartitioning2 simple_partitioning2 = 11

  • TPCCPartitioning tpcc_partitioning = 12

• uint32 num_workers = 13

  Number of worker threads for processing the transactions

• uint32 num_log_managers = 14

  Number of log manager threads. The logs are distributed evenly among these threads

• uint64 mh_orderer_batch_duration = 15

  How long the mh orderer waits for batching

• uint64 forwarder_batch_duration = 16

  How long the forwarder waits for batching

• uint64 sequencer_batch_duration = 17

  How long the sequencer waits for batching

• int32 sequencer_batch_size = 18

  How big can a batch be in number of txns

• bool sequencer_rrr = 19

  By default, a sequencer sticks to a single partition of a region to send the batch to. If this option is true, the partitions are selected in a round-robin manner (rrr: round-robin replication).

• uint32 replication_factor = 20

  Number of regions that need to be synchronously replicated to

• repeated string replication_order = 21

  Order of regions for synchronous replication. This is a list of strings each of which corresponds to a region. Each string is an ordered comma-separated list of region ids that the current replica will synchronously replicate to based on replication order. The current region will be ignored if exists in the list. For example, ['1,2', '2,1,0', ''] means that, with a replication factor of 3, region 0 will synchronously replicate to 1 and 2, region 1 will replicate to 2 and 0, and region 2 will not synchronously replicate to anywhere.

• optional ReplicationDelayExperiment replication_delay = 22

  Replication of txn batches will be delayed to simulate uneven network latency

• repeated TransactionEvent enabled_events = 23

  Do not record specified events

• bool bypass_mh_orderer = 24

  For multi-home txn, send lock-only txns directly to the regions, skipping the global orderer

• bool force_bypass_mh_orderer = 25

  Skip check when bypass mh orderer

• uint64 ddr_interval = 26

  Deadlock checking/resolving interval in ms. Set to 0 to disable deadlock resolving thread

• repeated CpuPinning cpu_pinnings = 27

  Pin each module to a cpu

• ExecutionType execution_type = 28

  Transaction execution type

• bool synchronized_batching = 29

  For each MH transaction, the involved regions will wait in such a way that their respective lock-only txns are put into the batches at approximately the same time

• optional MetricOptions metric_options = 30

  Options for metrics

• uint64 fs_latency_interval = 31

  The forwarder sends probes to the sequencer to measure latency between current region and other regions on a set interval. This interval is in ms.

• uint64 clock_sync_interval = 32

  Interval in ms for clock synchronizer to send messages

• int64 timestamp_buffer_us = 33

  A txn is assigned a future timestamp, which will be equal to current time + latency to the furthest region. When a txn arrives at a region, we want it to wait for a bit so that it can see other txns with lower timestamp and get ordered after them. However, clocks are not perfectly synchronized and latency estimation may be off. The txn may arrive at a region A when time at A has already passed the txn's timestamp. This value is thus used to extend the time a txn might be buffered at a region.

• uint32 avg_latency_window_size = 34

  Rolling window size used to average the latency measurement

• int32 broker_rcvbuf = 35

  Kernel receiving buffer size (bytes) of a broker socket

• int32 long_sender_sndbuf = 36

  Kernel sending buffer size (bytes) of long-distance sockets (e.g. those in the Forwarder and Sequencer)

• int32 tps_limit = 37

  Transaction admission rate limit at each server

Used in: Configuration

• ModuleId module = 1

• uint32 cpu = 2

• oneof type

  • Request request = 1

  • Response response = 2

  • bytes raw = 3

• uint32 from = 4

Used in: Configuration

• KEY_VALUE = 0

• NOOP = 1

• TPC_C = 2

Used in: Request

• optional Transaction txn = 1

• uint32 partition = 2

Used in: Request

• repeated Batch batch_data = 1

• uint32 generator = 2

  Machine that generated the batch

• uint32 generator_position = 3

  Batches generated by the same machine need to follow the order of creation. This field is used to number the batches following that order. It always start from 0 and increment by 1

Used in: Request

• oneof locality

  • LocalBatchOrder local_batch_order = 1

  • RemoteBatchOrder remote_batch_order = 2

Used in: Request

• optional Transaction txn = 1

Used in: Request

• repeated GraphLogEntry entries = 1

Used in: GraphLog

• uint64 txn_id = 1

• int32 num_partitions = 2

• bool is_complete = 3

• repeated uint64 incoming_edges = 4

* With hash partitioning, each key is interpreted as a byte string. The keys are distributed to the partitions based on their hash values. Initial data can be loaded from an external file.

Used in: Configuration

• uint32 partition_key_num_bytes = 1

  Number of prefix bytes of a key to use for partitioning

Used in: Request

• uint64 txn_id = 1

• repeated JanusDependency deps = 2

• int32 ballot = 3

Used in: Response

• uint64 txn_id = 1

• bool ok = 2

Used in: Request

• uint64 txn_id = 1

• repeated JanusDependency deps = 2

• optional Transaction txn = 3

Used in: JanusAcceptRequest, JanusCommit, JanusInquiryResult, JanusPreAcceptResponse

• uint64 txn_id = 1

• uint32 target_partition = 2

• uint64 participants_bitmap = 3

Used in: Request

• repeated uint64 txn_id = 1

Used in: Response

• repeated JanusInquiryResult results = 1

Used in: JanusInquireResponse

• uint64 txn_id = 1

• bool executed = 2

• repeated JanusDependency deps = 3

Used in: Request

• optional Transaction txn = 1

• int32 ballot = 2

Used in: Response

• uint64 txn_id = 1

• bool ok = 2

• repeated JanusDependency deps = 3

Used in: LookupMasterResponse

• bytes key = 1

• optional MasterMetadata metadata = 2

Used in: ForwardBatchOrder

• uint32 generator = 1

  generator is the machine that the batch is generated from

• uint32 slot = 2

• uint32 leader = 3

Used in: Request

• repeated uint64 txn_ids = 1

• repeated bytes keys = 2

Used in: Response

• repeated uint64 txn_ids = 1

• repeated KeyMasterMetadata lookup_results = 2

Used in: Configuration

• uint32 txn_events_sample = 1

• uint32 deadlock_resolver_runs_sample = 2

• uint32 deadlock_resolver_deadlocks_sample = 3

• bool deadlock_resolver_deadlock_details = 4

• uint32 forw_sequ_latency_sample = 5

• uint32 clock_sync_sample = 6

• bool logs = 7

• uint32 forwarder_batch_sample = 8

• uint32 sequencer_batch_sample = 9

• uint32 mhorderer_batch_sample = 10

• uint32 txn_timestamp_sample = 11

• uint32 generic_sample = 12

Used in: Request

• uint32 ballot = 1

• uint32 slot = 2

• uint64 value = 3

Used in: Response

• uint32 ballot = 1

• uint32 slot = 2

Used in: Request

• uint32 slot = 1

• uint64 value = 2

• uint32 leader = 3

Used in: Response

• uint32 slot = 1

Used in: Request

• uint64 value = 1

Used in: Request

• int64 src_time = 1

• uint32 dst = 2

* For debugging and testing purposes

Used in: Response

• int64 src_time = 1

• int64 dst_time = 2

• uint32 dst = 3

Used in: Configuration

• repeated string addresses = 1

  List of all server addresses in the system. This list must have the size equal to number of partitions If protocol is "tcp", these are IP addresses. If protocol is "icp", these are filesystem paths.

• repeated string public_addresses = 2

  AWS public addresses for the servers. This field is only used by the admin tool. If not specified, the addresses field is used instead.

• repeated string client_addresses = 3

  List of machines used for benchmarking. This field is only used by the admin tool

• string distance_ranking = 4

  Comma-separated string of region id (e.g "1,3,2") ordered from closest region to furthest region, not including this region. This field is only used by the admin tool.

• uint32 num_replicas = 5

  Number of replicas in this region. The number of addresses in this region must equal to num_replicas * num_partitions. The addresses list is split into num_replicas groups. Each group has num_partitions addresses.

• bool sync_replication = 6

  Use synchronous replication across all replicas

• bool shrink_mh_orderer = 7

  Reduce the resources of MH orderer to simulate resource constraint

Used in: ForwardBatchOrder

• uint64 batch_id = 1

• uint32 slot = 2

• uint32 home = 3

• bool need_ack = 4

Used in: Request

• uint64 txn_id = 1

• bool deadlocked = 2

• uint32 partition = 3

• repeated KeyValueEntry reads = 4

• bool will_abort = 5

• string abort_reason = 6

• AbortCode abort_code = 7

Used in: Configuration

• uint32 delay_pct = 1

  Percent of batches that are delayed

• uint32 delay_amount_ms = 2

  Average duration of delay in milliseconds

* The first message of a communication between two entities is always a Request. Some types of Request needs a Response (e.g. LookUpMasterRequest); names of these requests end with "Request". Some others are one-way requests (e.g. PaxosPropose) and do not end with "Request".

Used in: Envelope

• oneof type

  • Ping ping = 1

  • Signal signal = 2

  • BrokerRedirect broker_redirect = 3

  • ForwardTransaction forward_txn = 4

  • LookupMasterRequest lookup_master = 5

  • ForwardBatchData forward_batch_data = 6

  • ForwardBatchOrder forward_batch_order = 7

  • BatchReplicationAck batch_replication_ack = 8

  • PaxosPropose paxos_propose = 9

  • PaxosAcceptRequest paxos_accept = 10

  • PaxosCommitRequest paxos_commit = 11

  • RemoteReadResult remote_read_result = 12

  • FinishedSubtransaction finished_subtxn = 13

  • StatsRequest stats = 14

  • GraphLog graph_log = 15

  • JanusPreAcceptRequest janus_pre_accept = 16

    Janus

  • JanusAcceptRequest janus_accept = 17

  • JanusCommit janus_commit = 18

  • JanusInquireRequest janus_inquire = 19

* A response is always preceeded by a Request

Used in: Envelope

• oneof type

  • Pong pong = 1

  • LookupMasterResponse lookup_master = 2

  • PaxosAcceptResponse paxos_accept = 3

  • PaxosCommitResponse paxos_commit = 4

  • StatsResponse stats = 6

  • JanusPreAcceptResponse janus_pre_accept = 7

    Janus

  • JanusAcceptResponse janus_accept = 8

  • JanusInquireResponse janus_inquire = 9

* Generic signal message

Used in: Request

(message has no fields)

* With simple partitioning, each key is assumed to be a number. The keys are distributed to the partitions based on key values modulo the number of partitions. Initial data cannot be loaded from an external file but can be generated at startup. The following is an example of home and partition assignment of the generated data with 3 partitions and 4 regions. home | 0 1 2 3 0 1 2 3 0 ... ------------|------------------------------- partition 0 | 0 3 6 9 12 15 18 21 24 ... partition 1 | 1 4 7 10 13 16 19 22 25 ... partition 2 | 2 5 8 11 14 17 20 23 26 ... ------------|------------------------------- | keys

Used in: Configuration

• uint64 num_records = 1

  Number of records to generate

• uint32 record_size_bytes = 2

  Size of a generated record in bytes

* With simple partitioning, each key is assumed to be a number. The keys are distributed to the regions based on key values modulo the number of regions. Initial data cannot be loaded from an external file but can be generated at startup. The following is an example of home and partition assignment of the generated data with 3 partitions and 4 regions. partition | 0 1 2 3 0 1 2 3 0 ... ------------|------------------------------- home 0 | 0 3 6 9 12 15 18 21 24 ... home 1 | 1 4 7 10 13 16 19 22 25 ... home 2 | 2 5 8 11 14 17 20 23 26 ... ------------|------------------------------- | keys

Used in: Configuration

• uint64 num_records = 1

  Number of records to generate

• uint32 record_size_bytes = 2

  Size of a generated record in bytes

Used in: Request

• uint64 id = 1

• uint64 level = 2

Used in: Response

• uint64 id = 1

• bytes stats_json = 2

* Similar to simple partitioning but instead of using the whole key, only the warehouse id portion of the key is used for partitioning.

Used in: Configuration

• int32 warehouses = 1

  Number of warehouses