tigerbeetle-node - npm Package Versions

published 0.16.3 • 3 months ago

Changelog

TigerBeetle 0.16.3

Released: 2024-09-23

Safety And Performance

#2313

Improve cluster availability by more aggressive recovery for crashes that happen while a replica is checkpointing.
#2328

Add a more efficient recipe for balance-conditional transfers. A balance-conditional transfer is a transfer that succeeds only if the source account has more than a threshold amount of funds in it.

Features

#2327

Add a new recipe for enforcing debits_must_not_exceed_credits on some subset of transfers (this is a special case of a balance-conditional transfer, with the threshold value being equal to transferred amount).

Internals

#2330

Add triaged issue label to prevent newly opened issues from slipping through the cracks.
#2332

Add CI check for dead code.
#2323

Cleanup the source tree by removing top-level tools directory.
#2316

Make sure that process-spawning API used for build-time "scripting" consistently reports errors when the subprocess fails or hangs.

TigerTracks 🎧

Prelude in G Major

0.16.2

published 0.16.2 • 3 months ago

Changelog

TigerBeetle 0.16.2

Released: 2024-09-16

Safety And Performance

#2312

Tighten up the VSR assertions so the transition to .recovering_head can only be called from the .recovering status.
#2311

Make the primary abdicate if it is unable to process requests due to a broken clock.
#2260

Smoke integration test using the real multiversion binary.
#2270

Workload generator based on the Java client to be used in integration tests (i.e. Antithesis).

Features

#2298, #2307, #2304, #2309, #2321

Remove Tracy integration and dependencies. Add JSON traces for events with multiple running instances, such as IO, lookups, and scans.
#2300

Add the ability to filter by user_data_{128,64,32} and code in get_account_transfers and get_account_balances.

Internals

#2314, #2315

Mute the log on stderr when building client libraries. Reduce the log's severity of some entries logged as .err to .warn for less noise when running with log_level = .err.
#2310

Document and explain how time works in TigerBeetle ⏱️.
#2291

Refactor Forest.compact and remove some dead code.
#2294

Rewrite commit_dispatch, a chain of asynchronous stages calling each other, as a state machine implementation that resembles linear control flow that is much easier to read.
#2306

Fix the Node.js example that was using an incorrect enum flag. Thanks for the heads up @jorispz!
#2319

Update outdated scripts in HACKING.md.
#2317

Use git timestamps to build Docker images. This is a requirement for being deterministic in CI.
#2318

Devhub link to pending code reviews.

TigerTracks 🎧

What's On Your Mind

0.16.1

published 0.16.1 • 3 months ago

Changelog

TigerBeetle 0.16.1

Released: 2024-09-09

Safety And Performance

#2284

Improve view change efficiency; new heuristic for lagging replicas to forfeit view change.

A lagging replicas first gives a more up-to-date replica a chance to become primary by forfeiting view change. If the more up-to-date replica cannot step up as primary, the lagging replica attempts to step up as primary.
#2275, #2254, #2269, #2272

Complete rollout of the new state sync protocol.

Remove in-code remnants of the old state sync protocol. Replicas now panic if they receive messages belonging to the old protocol.

Internals

#2283

Improve log warnings for client eviction due to its version being too low/high.
#2288

Fix VOPR false positive wherein checkpoint was being updated twice in the upgrade path.
#2286

Fix typos found using codespell.
#2282

Document example for debiting multiple accounts and crediting a single account wherein the total amount to transfer to the credit account is known, but the balances of the individual debit accounts are not known.
#2281

Document the behavior of user_data_128/user_data_64/user_data_32 in the presence of pending transfers.
#2279

Inline Dockerfile in the release code, removing tools/docker/Dockerfile.
#2280, #2285

Add kcov code coverage to DevHub.
#2266, #2293

Add support for tracing IO & CPU events. This allows for coarse-grained performance analysis, for example collectively profiling IO and CPU performance (as opposed to IO or CPU in isolation).
#2273

Remove explicit header sector locks, using a common locking path for prepare and header sectors.
#2258

Change CliArgs -> CLIArgs in accordance with TigerStyle.
#2263

Vendor llvm-objcopy in the dependencies repository in accordance with our "no dependencies" policy. This ensures users don't have to manually install LLVM.
#2297

Assign correct date to the release binary date; it was earlier set to the epoch ("Jan 1 1970").
#2289

Introduce fatal errors for crashing the replica process in the face of uncorrectable errors (for example, insufficient memory/storage).
#2287

Add formatting check in the CI for the Go client.
#2278, #2292

Reduce dimensionality of configuration modes.

Removes the development configuration which was used to run the replica with asserts enabled, enabling asserts for the production configuration instead. Additionally, removes the -Dconfig CLI option, making production configuration the default.

TigerTracks 🎧

Fire on the Mountain

0.16.0

published 0.16.0 • 3 months ago

Changelog

TigerBeetle 0.16.0

Released: 2024-09-02

This release is 0.16.0 as it includes a new breaking API change around zero amount transfers, as well as the behavior around posting a full pending transfer amount or balancing as much as possible. These are all gated by the client's release version.

If you're running a client older than 0.16.0, you'll see the old behavior where zero amount transfers are disallowed, but on newer clients these are supported and will create a transfer with an amount of 0.

Additionally, the sentinel value to representing posting the full amount of a pending transfer, or doing a balancing transfer for as much as possible has changed. It's no longer 0, but instead AMOUNT_MAX.

See the tracking issue for more details.

Safety And Performance

#2221

Change how replicas that haven't finished syncing send a prepare_ok message, preventing them from falsely contributing to the durability of a checkpoint, which could potentially cause liveness issues in the event of storage faults.
#2255

The new state sync protocol regressed the behavior where the replica would try to repair the WAL before switching to state sync, and this puts the old behavior back in.

WAL repair is used when the lagging replica's log still intersects with the cluster's current log, while state sync is used when when the logs no longer intersect.
#2244

Try to repair (but not commit) prepares, even if we don't have all the headers between checkpoint and head.

This makes things consistent between the normal and repair paths, and improves concurrency while repairing.
#2253

Reject prepares on the primary if its view isn't durable, much like solo clusters.

This solves a failing VOPR seed wherein a primary accepting prepares before making its log_view durable exposes a break in its hash chain.
#2259, #2246

A few sysctls and security frameworks (eg, seccomp) might block io_uring. Print out a more helpful error message, rather than a generic "permission denied" or "system outdated".

Features

#2171

Add the new imported flag to allow user-defined timestamps when creating Accounts and Transfers from historical events.
#2220, #2237, #2238, #2239

Allow Transfers with amount=0 and change behavior for balancing and post-pending transfers, introducing the constant AMOUNT_MAX to replace the use of the zero sentinel when representing the maximum/original value in such cases. Note that this is a breaking change.

Also, explicitly define optional indexes, which previously were determined simply by not indexing zeroed values.
#2234

Introduce a new flag, Account.flags.closed, which causes an account to reject any further transfers, except for voiding two-phase transfers that are still pending.

The account flag can be set during creation or through a closing transfer. In the latter case, closed account can be re-opened by voiding or expiring the closing transfer.

Internals

#2211

Deprecates the old state sync protocol, no longer supporting both protocols simultaneously. As planned for this release, it only ignores old messages, allowing replicas to upgrade normally. In the next release, replicas would panic if they receive an old message.
#2233

Move multiversion build logic into build.zig from release.zig. This makes it much easier to build multiversion binaries as part of a regular zig build, without having to invoke CI or release process specific code that's normally part of release.zig.

It also makes it possible to build multiversion binaries on platforms that aren't x86_64 Linux.
#2215

Refactor the Multiversion API, bringing it in line with pre-existing code patterns.
#2251

Previously, TigerBeetle release numbers were based on a finicky conversion of GitHub's internal action run number to a version number.

This was error prone, and difficult to reason about before hand (what would the given version number for a release be?). Instead, make it so this very changelog is the source of truth for the version number which is explicitly set.
#2252

Change init function signatures to allow for in-place initialization. This addresses the silent stack growth caused by intermediate copy/move allocations during the initialization of large objects.

Specifically, the Forest struct can grow indefinitely depending on the number of Grooves/IndexTrees needed to support the StateMachine's custom logic, causing TigerBeetle to crash during startup due to stack-overflow.
#2265

Don't cancel in-progress GitHub actions on the main branch. In particular, this ensures that the devhub records the benchmark measurements for every merge to main, even if those merges occur in quick succession.
#2218

Make the experimental feature aof (append-only file) a runtime flag instead of a build-time setting. This simplifies operations, allowing the use of the same standard release binary in environments that require aof.
#2228

Renames the LSM constant lsm_batch_multiple to lsm_compaction_ops, providing clearer meaning on how it relates to the pace at which LSM tree compaction is triggered.
#2240

Add support for indexing flags, namely the new imported flag.

TigerTracks 🎧

0.15.6

published 0.15.6 • 4 months ago

Changelog

TigerBeetle 0.15.6

Released: 2024-08-19

Safety And Performance

#1951, #2212

Add new state sync protocol, fixing a couple of liveness issues. State sync is now performed as part of the view change.
#2207

Major state sync performance improvements.

Features

#2224, #2225, #2226

Ensure u128 (and related type) consistency across client implementations.
#2213

Fix multiversioning builds for aarch64 macOS.

Internals

#2210

Automatically include oldest supported releases in release notes.
#2214

Refactor build.zig to break up the biggest function in the codebase.
#2178

Minor improvements to zig install scripts.

TigerTracks 🎧

End of the Line

0.15.5

published 0.15.5 • 4 months ago

Changelog

https://github.com/tigerbeetle/tigerbeetle/

TigerBeetle 0.15.5

Released: 2024-08-12

Highlight of this release is fully rolled-out support for multiversion binaries. This means that, from now on, the upgrade procedure is going to be as simple as dropping the new version of tigerbeetle binary onto the servers. TigerBeetle will take care of restarting the cluster at the new version when it is appropriate. See https://docs.tigerbeetle.com/operating/upgrading for reference documentation.

Note that the upgrade procedure from 0.15.3 and 0.15.4 is a bit more involved.

When upgrading from 0.15.3, you'll need to stop and restart tigerbeetle binary manually.
When upgrading from 0.15.4, the binary will stop automatically by hitting an assert. You should restart it after that.

Safety And Performance

#2174 #2190,

Test client eviction in the VOPR.
#2187

Add integration tests for upgrades.
#2188

Add more hardening parameters to the suggested systemd unit definition.

Features

#2180, #2185, #2189, #2196

Make the root directory smaller by getting rid of scripts and .gitattributes entries. Root directory is the first thing you see when opening the repository, this space shouldn't be wasted!
#2199, #2165, #2198, #2184.

Complete the integration of multiversion binaries with the release infrastructure. From now on, the upgrade procedure is as simple as replacing the binary on disk with a new version. TigerBeetle will take care of safely and seamlessly restarting the cluster when appropriate itself.
#2181

Prepare to rollout the new state sync protocol. Stay tuned for the next release!

Internals

#2179, #2200

Simplify iteration over an LSM tree during scans.
#2182

Fix addresses logging in the client regressed by #2164.
#2193

Modernize scripts to generate client bindings to follow modern idioms for build.zig.
#2195

Fix typo in the currency exchange example.

TigerTracks 🎧

High Hopes

2024-08-05 (No release: Queued up to improve multiversion upgrade flow)

Safety And Performance

#2162

Past release checksums are further validated when printing multi-version information.
#2143

Write Ahead Log (WAL) appending was decoupled from WAL replication, tightening asserts.
#2153, #2170

VSR eviction edge cases receive more hardening.
#2175

Fix account overflows when doing a balance transfer for remaining funds (amount=0).
#2168, #2164, #2152, #2122

Command line argument parsing no longer dynamically allocates and handles error handling paths more explicitly.

Internals

#2169

Golang's tests for the CI were re-enabled for ARM64 macOS.
#2159

This is a CHANGELOG entry about fixing a previous CHANGELOG entry.

TigerTracks 🎧

Ramble On

2024-07-29

Safety And Performance

#2140, #2154

Fix a bug where MessageBus sees block/reply messages (due to state sync or repair) and peer_type says they are always from replica 0 (since Header.Block.replica == 0 always). So, if they are being sent by a non-R0 replica, it drops the messages with "message from unexpected peer".

This leads to a replica being stuck in state sync and unable to progress.
#2137

It was possible for a prepare to exist in a mixture of WALs and checkpoints, which could compromise physical durability under storage fault conditions, since the data is present across a commit-quorum of replicas in different forms.

Rather, ensure a prepare in the WAL is only overwritten if it belongs to a commit-quorum of checkpoints.
#2127, #2096

A few CI changes: run tests in CI for x86_64 macOS, add in client tests on macOS and run the benchmark with --validate in CI.
#2117

TigerBeetle reserves the most significant bit of the timestamp as the tombstone flag, so indicate and assert that timestamp_max is a maxInt(u63).
#2123, #2125

Internally, TigerBeetle uses AEGIS-128L for checksumming - hardware AES is a prerequisite for performance. Due to a build system bug, releases being built with a specified (-Dtarget=) target would only be built with baseline CPU features, and thus use the software AES implementation.

Enforce at comptime that hardware acceleration is available, fix the build system bug, log checksum performance on our devhub and build client libraries with hardware acceleration too.
#2139

TigerBeetle would wait until all repairable headers are fixed before trying to commits prepares, but if all the headers after the checkpoint are present then we can start committing even if some headers from before the checkpoint are missing.
#2141

Clarify that the order of replicas in --addresses is important. Currently, the order of replicas as specified has a direct impact on how messages are routed between them. Having a differing order leads to significantly degraded performance.
#2120

The state machine depended on prepare_timestamp to evaluate pulse(), but in an idle cluster, prepare_timestamp would only be set if pulse returned true! Thanks @ikolomiets for reporting.
#2028

Add a fuzzer for scans.
#2109

Fuzz storage.zig, by using a mocked IO layer.

Features

#2070

Certain workloads (for example, sending in tiny batches) can cause high amounts of space amplification in TigerBeetle, leading to data file sizes that are much larger than optimal.

This introduces a stopgap fix, greedily coalescing tables in level 0 of the LSM, which improves space amplification dramatically.
#2003

Add a data file inspector tool to the TigerBeetle CLI, handy for development and debugging alike. You can run it with tigerbeetle inspect --help.
#2136, #2013, #2126

TigerBeetle clusters can now be upgraded!
#2095

Add a custom formatter for displaying units in error messages. Thanks @tensorush!

Internals

#1380

Allows for language clients to manage their own Packet memory, removing the need for tb_client to do so and thus removing the concepts of acquire/release_packet and concurrency_max.
#2148

Add function length limits to our internal tidy tests.
#2116, #2114, #2111, #2132, #2131, #2124

Lots of small CFO improvements.

TigerTracks 🎧

Here I Go Again

2024-07-15 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#2078

Fix an incorrect assert that was too tight, crashing the replica after state sync, when the replica's operation number lags behind checkpoint.
#2103, #2056, #2072

Fixes and improvements to tests and simulator.
#2088

Improve the benchmark to verify the state after execution and enable tests in Windows CI!
#2090

Call fs_sync on macOS/Darwin after each write to properly deal with Darwin's O_DSYNC which doesn't behave like O_DSYNC on Linux.

Features

#2080

New operations query accounts and query transfers as a stopgap API to add some degree of user-defined query capabilities. This is an experimental feature meant to be replaced by a proper querying API.

Internals

#2067

Simplify the comptime configuration by merging config.test_min and config.fuzz_min.
#2091

Fixed many typos and misspellings, thanks to Jora Troosh.
#2099, #2097, #2098, #2100, #2092, #2094, #2089, #2073, #2087, #2086, #2083, #2085

Multiple and varied changes to conform all line lengths to not more than 100 columns, according to TigerStyle!
#2081

Run kcov during CI as a code coverage sanity check. No automated action is taken regarding the results. We're not focused on tracking the quantitative coverage metric, but rather on surfacing blind spots qualitatively.

TigerTracks 🎧

Sultans Of Swing

2024-07-08 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#2035, #2042, #2069

Strengthen LSM assertions.
#2077

Use flexible quorums for clock synchronization.

Features

#2037

Improve and clarify balancing transfer amount validation.

Internals

#2063

Add chaitanyabhandari to the list of release managers.
#2075

Update TigerStyle with advice for splitting long functions.
#2068, #2074

Fix flaky tests.
#1995

Add --security-opt seccomp=unconfined to Docker commands in docs, since newer versions of Docker block access to io_uring.
#2047, #2064, #2079

Clean up github actions workflows.
#2071

Make cfo supervisor robust to network errors.

TigerTracks 🎧

Линия жизни

2024-07-01 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#2058

tigerbeetle benchmark command can now simulate few "hot" accounts which account for most of transfers, the distribution expected in a typical deployment.

Features

#2040

Add a recipe for accounts with bounded balance

Internals

#2033, #2041

Rewrite build.zig to introduce a more regular naming scheme for top-level steps.
#2057

Our internal dashboard, devhub now has dark mode 😎.
#2052, #2032, #2044

Ensure that the generated tb_client.h C header is in sync with Zig code.

TigerTracks 🎧

Wish You Were Here

2024-06-24 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#2034, #2022, #2023

Fuzzer Fixing For Fun! Particularly around random number generation and number sequences.
#2004

Add simulator coverage for get_account_transfers and get_account_balances.

Features

#2010

Reduce the default --limit-pipeline-requests value, dropping RSS memory consumption.

Internals

#2024, #2018, #2027

Build system simplifications.
#2026, #2020, #2030, #2031, #2008

Tidying up (now) unused symbols and functionality.
#2016

Rename docs section from "Develop" to "Coding".

TigerTracks 🎧

On The Riverbank

2024-06-17 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#2000

Fix a case where an early return could result in a partially inserted transfer persisting.
#2011, #2009, #1981

Big improvements to allowing TigerBeetle to run with less memory! You can now run TigerBeetle in --development mode by default with an RSS of under 1GB. Most of these gains came from #1981 which allows running with a smaller runtime request size.
#2014, #2012, #2006

Devhub improvements - make it harder to miss failures due to visualization bugs, show the PR author in fuzzer table and color canary "failures" as success.

Features

#2001

Add --account-batch-size to the benchmark, mirroring --transfer-batch-size.
#2017, #1992, #1993

Rename the Deploy section to Operating, add a new correcting transfer recipe, and note that lookup_accounts shouldn't be used before creating transfers to avoid potential TOCTOUs.

Internals

#1878, #1997

⚡ Update Zig from 0.11.0 to 0.13.0! As part of this, replace non-mutated vars with const.
#1999

Similar to #1991, adds the async io_uring_prep_statx syscall for Linux's IO implementation, allowing non-blocking statx()s while serving requests - to determine when the binary on disk has changed.

TigerTracks 🎧

Canon in D

2024-06-10 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1986

Refactor an internal iterator to expose a mutable pointer instead of calling @constCast on it. There was a comment justifying the operation's safety, but it turned out to be safer to expose it as a mutable pointer (avoiding misusage from the origin) rather than performing an unsound mutation over a constant pointer.
#1985

Implement a random Grid/Scrubber tour origin, where each replica starts scrubbing the local storage in a different place, covering more blocks across the entire cluster.
#1990

Model and calculate the probability of data loss in terms of the Grid/Scrubber cycle interval, allowing to reduce the read bandwidth dedicated for scrubbing.
#1987

Fix a simulator bug where all the WAL sectors get corrupted when a replica crashes while writing them simultaneously.

Internals

#1991

As part of multiversioning binaries, adds the async io_uring_prep_openatsyscall for Linux's IO implementation, allowing non-blocking open()s while serving requests (which will be necessary during upgrade checks).
#1982

Require the --experimental flag when starting TigerBeetle with flags that aren't considered stable, that is, flags not explicitly documented in the help message, limiting the surface area for future compatibility.

TigerTracks 🎧

O Rappa - A feira

2024-06-03 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1980

Fix crash when upgrading solo replica.
#1952

Pin points crossing Go client FFI boundary to prevent memory corruption.

Internals

#1931, #1933

Improve Go client tests.
#1946

Add vsr.Client.register().

2024-05-27 (No release: Queued up for upcoming multi-version binary release)

Features

#1975

Build our .NET client for .NET 8, the current LTS version. Thanks @woksin!

Internals

#1971

Document recovery case @L in VSR.
#1965

We implicitly supported underscores in numerical CLI flags. Add tests to make this explicit.
#1974, #1970

Add the size of an empty data file to devhub, tweak the benchmark to always generate the same sized batches, and speed up loading the devhub itself.

TigerTracks 🎧

Fight Song

2024-05-20 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1938

Ease restriction which guarded against unnecessary pulses.

Internals

#1949, #1964

Docs fixes and cleanup.
#1957

Fix determinism bug in test workload checker.
#1955

Expose ticks_max as runtime CLI argument.
#1956, #1959, #1960, #1963

Devhub/benchmark improvements.

2024-05-13 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1918, #1916, #1913, #1921, #1922, #1920, #1945, #1941, #1934, #1927

Lots of CFO enhancements - the CFO can now do simple minimization, fuzz PRs and orchestrate the VOPR directly. See the output on our devhub!
#1948, #1929, #1924

Fix a bug in the VOPR, add simple minimization, and remove the voprhub code. Previously, the voprhub is what took care of running the VOPR. Now, it's handled by the CFO and treated much the same as other fuzzers.
#1947

Prevent time-travel in our replica test code.
#1943

Fix a fuzzer bug around checkpoint / commit ratios.

Features

#1898

Add the ability to limit the VSR pipeline size at runtime to save memory.

Internals

#1925

Fix path handling on Windows by switching to NtCreateFile. Before, TigerBeetle would silently treat all paths as relative on Windows.
#1917

In preparation for multiversion binaries, make release_client_min a parameter, set by release.zig. This allows us to ensure backwards compatibility with older clients.
#1827

Add some additional asserts around block lifetimes in compaction.
#1939

Fix parsing of multiple CLI positional fields.
#1923

Remove main_pkg_path = src/ early, to help us be compatible with Zig 0.12.
#1937, #1912, #1852

Docs organization and link fixes.

TigerTracks 🎧

Thank You (Not So Bad)

2024-05-06 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1906, #1904, #1903, #1901, #1899, #1886

Fixes and performance improvements to fuzzers.
#1897

Reduces cache size for the --development flag, which was originally created to bypass direct I/O requirements but can also aggregate other convenient options for non-production environments.
#1895

Reduction in memory footprint, calculating the maximum number of messages from runtime-known configurations.

Features

#1896

Removes the bootstrap.{sh,bat} scripts, replacing them with a more transparent instruction for downloading the binary release or building from source.
#1890

Nicely handles "illegal instruction" crashes, printing a friendly message when the CPU running a binary release is too old and does not support some modern instructions such as AES-NI and AVX2.

Internals

#1892

Include micro-benchmarks as part of the unit tests, so there's no need for a special case in the CI while we still compile and check them.
#1902

A TigerStyle addition on "why prefer a explicitly sized integer over usize".
#1894

Rename "Getting Started" to "Quick Start" for better organization and clarifications.
#1900

While TigerBeetle builds are deterministic, Zip files include a timestamp that makes the build output non-deterministic! This PR sets an explicit timestamp for entirely reproducible releases.
1909

Extracts the zig compiler path into a ZIG_EXE environment variable, allowing easier sharing of the same compiler across multiple git work trees.

TigerTracks 🎧

Thank You

2024-04-29 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1883

Move message allocation farther down into the tigerbeetle start code path. tigerbeetle format is now faster, since it no longer allocates these messages.
#1880

Reduce the connection limit, which was unnecessarily high.

Features

#1848

Implement zig-zag merge join for merging index scans. (Note that this functionality is not yet exposed to TigerBeetle's API.)
#1882

Print memory usage more accurately during tigerbeetle start.

Internals

#1874

Fix blob-size CI check with respect to shallow clones.
#1870, #1869

Add more fuzzers to CFO (Continuous Fuzzing Orchestrator).
#1868, #1875

Improve fuzzer performance.
#1864

On the devhub, show at most one failing seed per fuzzer.
#1820, #1867, #1877, #1873, #1853, #1872, #1845, #1871

Documentation improvements.

TigerTracks 🎧

The Core

2024-04-22 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1851

Implement grid scrubbing --- a background job that periodically reads the entire data file, verifies its correctness and repairs any corrupted blocks.
#1855, #1854.

Turn on continuous fuzzing and integrate it with devhub.

Internals

#1849

Improve navigation on the docs website.

TigerTracks 🎧

A very special song from our friend MEGAHIT!

TigerBeetle

2024-04-15 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1810

Incrementally recompute the number values to compact in the storage engine. This smooths out I/O latency, giving a nice bump to transaction throughput under load.

Features

#1843

Add --development flag to format and start commands in production binaries to downgrade lack of Direct I/O support from a hard error to a warning.

TigerBeetle uses Direct I/O for certain safety guarantees, but this feature is not available on all development environments due to varying file systems. This serves as a compromise between providing a separate development release binary and strictly requiring Direct I/O to be present.

Internals

#1833

Add fixed upper bound to loop in the StorageChecker.
#1836

Orchestrate continuous fuzzing of tigerbeetle components straight from the build system! This gives us some flexibility on configuring our set of machines which test and report errors.
#1842, #1844, #1832

Styling updates and fixes.

TigerTracks 🎧

CHERRY PEPSI

2024-04-08 (No release: Queued up for upcoming multi-version binary release)

Safety And Performance

#1821

Fix a case the VOPR found where a replica recovers into recovering_head unexpectedly.

Features

#1565

Improve CLI errors around sizing by providing human readable (1057MiB vs 1108344832) values.
#1818, #1831, #1829, #1817, #1826, #1825

Documentation improvements.

Internals

#1806

Additional LSM compaction comments and assertions.
#1824

Clarify some scan internals and add additional assertions.
#1828

Some of our comments had duplicate words - thanks @divdeploy for for noticing!

TigerTracks 🎧

All The Small Things

2024-04-01 (Placeholder: no release yet)

Safety And Performance

#1766

Reject incoming client requests that have an unexpected message length.
#1768

Fix message alignment.
#1772, #1786

StorageChecker now verifies grid determinism at bar boundaries.
#1776

Fix VOPR liveness false positive when standby misses an op.
#1814

Assert that the type-erased LSM block metadata matches the comptime one, specialized over Tree.
#1797

Use a FIFO as a block_pool instead of trying to slice arrays during compaction.

Features

#1774

Implement get_account_transfers and get_account_balances in the REPL.
#1781, #1784, #1765, #1816, #1808, #1802, #1798, #1793, #1805

Documentation improvements.
#1813

Improve Docker experience by handling SIGTERM through tini.
#1800

For reproducible benchmarks, allow setting --seed on the CLI.

Internals

#1640, #1782, #1788

Move request_queue outside of vsr.Client.
#1775

Extract CompactionPipeline to a dedicated function.
#1773

Replace compaction interface with comptime dispatch.
#1796

Remove the duplicated CompactionInfo value stored in PipelineSlot, referencing it from the Compaction by its coordinates.
#1809, #1807

CLI output improvements.
#1804, #1812, #1799, #1767

Improvements in the client libraries CI.
#1771, #1770, #1792

Metrics adjustments for Devhub and Nyrkio integration.
#1811, #1803, #1801, #1762

Various bug fixes in the build script and removal of the "Do not use in production" warning.

2024-03-19

Bump version to 0.15.x
Starting with 0.15.x, TigerBeetle is ready for production use, preserves durability and provides a forward upgrade path through storage stability.

Safety And Performance

#1755

Set TigerBeetle's block size to 512KB.

Previously, we used to have a block size of 1MB to help with approximate pacing. Now that pacing can be tuned independently of block size, reduce this value (but not too much - make the roads wider than you think) to help with read amplification on queries.

TigerTracks 🎧

Immigrant Song - Live 1972

2024-03-18

Safety And Performance

#1660

Implement compaction pacing: traditionally LSM databases run compaction on a background thread. In contrast compaction in tigerbeetle is deterministically interleaved with normal execution process, to get predictable latencies and to guarantee that ingress can never outrun compaction.

In this PR, this "deterministic scheduling" is greatly improved, slicing compaction work into smaller bites which are more evenly distributed across a bar of batched requests.
#1722

Include information about tigerbeetle version into the VSR protocol and the data file.
#1732, #1743, #1742, #1720, #1719, #1705, #1708, #1707, #1723, #1706, #1700, #1696, #1686.

Many availability issues found by the simulator fixed!
#1734

Fix a buffer leak when get_account_balances is called on an invalid account.

Features

#1671, #1713, #1709, #1688, #1691, #1690.

Many improvements to the documentation!
#1733

Rename get_account_history to get_account_balances.
#1657

Automatically expire pending transfers.
#1682

Implement in-place upgrades, so that the version of tigerbeetle binary can be updated without recreating the data file from scratch.
#1674

Consistently use MiB rather than MB in the CLI interface.
#1678

Mark --standby and benchmark CLI arguments as experimental.

Internals

#1726

Unify PostedGroove and the index pending_status.
#1681

Include an entire header into checkpoint state to ease recovery after state sync.

TigerTracks 🎧

Are You Gonna Go My Way

2024-03-11

Safety And Performance

#1663

Fetching account history and transfers now has unit tests, helping detect and fix a reported bug with posting and voiding transfers.

Internals

#1648, #1665, #1654, #1651

Testing and Timer logic was subject to some spring cleaning.

Features

#1656, #1659, #1666, #1667, #1667

Preparation for in-place upgrade support.
#1633, #1661, #1652, #1647, #1637, #1638, #1655

Documentation has received some very welcome organizational and clarity changes. Go check them out!

TigerTracks 🎧

Você Chegou

2024-03-04

Safety And Performance

#1584 Lower our memory usage by removing a redundant stash and not requiring a non-zero object cache size for Grooves.

The object cache is designed to help things like Account lookups, where the positive case can skip all the prefetch machinery, but it doesn't make as much sense for other Grooves.
#1581 #1611

Hook nyrkiö up to our CI! You can find our dashboard here in addition to our devhub.
#1635 #1634 #1623 #1619 #1609 #1608 #1595

Lots of small VSR changes, including a VOPR crash fix.
#1598

Fix a VOPR failure where state sync would cause a break in the hash chain.

Internals

#1599 #1597

Use Expand-Archive over unzip in PowerShell - thanks @felipevalerio for reporting!
#1607 #1620

Implement explicit coverage marks.
#1621 #1625 #1622 #1600 #1605 #1618 #1606

Minor doc fixups.
#1636 #1626

Default the VOPR to short log, and fix a false assertion in the liveness checker.
#1596

Fix a memory leak in our Java tests.

TigerTracks 🎧

Auffe aufn Berg

2024-02-26

Safety And Performance

#1591 #1589 #1579 #1576

Rework the log repair logic to never repair beyond a "confirmed" checkpoint, fixing a liveness issue where it was impossible for the primary to repair its entire log, even with a quorum of replicas at a recent checkpoint.
#1572

Some Java unit tests created native client instances without the proper deinitialization, causing an OutOfMemoryError during CI.
#1569 #1570

Fix Vopr's false alarms.

Internals

#1585

Document how assertions should be used, especially those with complexity O(n) under the constants.verify conditional.
#1580

Harmonize and automate the logging pattern by using the @src built-in to retrieve the function name.
#1568

Include the benchmark smoke as part of the zig build test command rather than a special case during CI.
#1574

Remove unused code coverage metrics from the CI.
#1575 #1573 #1582

Re-enable Windows CI 🎉.

TigerTracks 🎧

Dos Margaritas

(versión en español)

2024-02-19

Safety And Performance

#1533

DVCs implicitly nack missing prepares from old log-views.

(This partially addresses a liveness issue in the view change.)
#1552

When a replica joins a view by receiving an SV message, some of the SV's headers may be too far ahead to insert into the journal. (That is, they are beyond the replica's checkpoint trigger.)

During a view change, those headers are now eligible to be DVC headers.

(This partially addresses a liveness issue in the view change.)
#1560

Fixes a bug in the C client that wasn't handling error.TooManyOutstanding correctly.

Internals

#1482

Bring back Windows tests for .Net client in CI.
#1540

Add script to scaffold changelog updates.
#1542, #1553, #1559, #1561

Improve CI/test error reporting.
#1551

Draw devhub graph as line graph.
#1554

Simplify command to run a single test.
#1555

Add client batching integration tests.
#1557

Format default values into the CLI help message.
#1558

Track commit timestamp to enable retrospective benchmarking in the devhub.
#1562, #1563

Improve CI/test performance.
#1567

Guarantee that the test runner correctly reports "zero tests run" when run with a filter that matches no tests.

TigerTracks 🎧

Eye Of The Tiger

(Hat tip to iofthetiger!)

2024-02-12

Safety And Performance

#1519

Reduce checkpoint latency by checkpointing the grid concurrently with other trailers.
#1515

Fix a logical race condition (which was caught by an assert) when reading and writing client replies concurrently.
#1522

Double check that both checksum and request number match between a request and the corresponding reply.
#1520

Optimize fields with zero value by not adding them to an index.

Features

#1526, #1531.

Introduce get_account_history operation for querying the historical balances of a given account.
#1523

Add helper function for generating approximately monotonic IDs to various language clients.

TigerTracks 🎧

Musique à Grande Vitesse

2024-02-05

Safety And Performance

#1489, #1496, #1501.

Harden VSR against edge cases.
#1508, #1509.

Allows VSR to perform checkpoint steps concurrently to reduce latency spikes.
#1505

Removed unused indexes on account balances for a nice bump in throughput and lower memory usage.
#1512

Only zero-out the parts necessary for correctness of fresh storage buffers. "Defense in Depth" without sacrificing performance!

Features

#1491, #1503.

TigerBeetle's dev workbench now also tracks memory usage (RSS), throughput, and latency benchmarks over time!

Internals

#1481, #1493, #1495, #1498.

Simplify assertions and tests for VSR and Replica.
#1497, #1502, #1504.

.NET CI fixups
#1485, #1499, #1504.

Spring Cleaning

TigerTracks 🎧

Bone Dry

2024-01-29

Safety And Performance

#1446

Panic on checkpoint divergence. Previously, if a replica's state on disk diverged, we'd use state sync to bring it in line. Now, we don't allow any storage engine nondeterminism (mixed version clusters are forbidden) and panic if we encounter any.
#1476

Fix a liveness issues when starting a view across checkpoints in an idle cluster.
#1460

Stop an isolated replica from locking a standby out of a cluster.

Features

#1470

Change get_account_transfers to use timestamp_min and timestamp_max to allow filtering by timestamp ranges.
#1463

Allow setting --addresses=0 when starting TigerBeetle to enable a mode helpful for integration tests:
- A free port will be picked automatically.
- The port, and only the port, will be printed to stdout which will then be closed.
- TigerBeetle will exit when its stdin is closed.
#1402

TigerBeetle now has a dev workbench! Currently we track our build times and executable size over time.
#1461

tigerbeetle client ... is now tigerbeetle repl ....

Internals

#1480

Deprecate support and testing for Node 16, which is EOL.
#1477, #1469, #1475, #1457, #1452.

Improve VOPR & VSR logging, docs, assertions and tests.
#1474

Improve integration tests around Node and pending_transfer_expired - thanks to our friends at Rafiki for reporting!

TigerTracks 🎧

Paint It, Black

2024-01-22

Safety And Performance

#1438

Avoid an extra copy of data when encoding the superblock during checkpoint.
#1429

Use more precise upper bounds for static memory allocation, reducing memory usage by about 200MiB.
#1439

When reading data past the end of the file, defensively zero-out the result buffer.

Features

#1443

Upgrade C# client API to use Span<T>.
#1347

Add ID generation function to the Java client. TigerBeetle doesn't assign any meaning to IDs and can use anything as long as it is unique. However, for optimal performance it is best if these client-generated IDs are approximately monotonic. This can be achieved by, for example, using client's current timestamp for high order bits of an ID. The new helper does just that.

Internals

#1437, #1435, d7c3f46.

Rewrite git history to remove large files accidentally added to the repository during early quick prototyping phase. To make this durable, add CI checks for unwanted files. The original history is available at:

https://github.com/tigerbeetle/tigerbeetle-history-archive
#1421, #1401.

New tips for the style guide:
- write code top-down
- pair up assertions

TigerTracks 🎧

Don't Take No For An Answer

2024-01-15

Welcome to 2024!

Safety And Performance

#1425, #1412, #1410, #1408, #1395.

Run more fuzzers directly in CI as a part of not rocket science package.
#1413

Formalize some ad-hoc testing practices as proper integration tests (that is, tests that interact with a tigerbeetle binary through IPC).
#1404

Add a lint check for unused Zig files.
#1390

Improve cluster availability by including conservative information about the current view into ping-pong messages. In particular, prevent the cluster from getting stuck when all replicas become primaries for different views.
#1365

Test both the latest and the oldest supported Java version on CI.
#1389

Fix a data race on close in the Java client.

Features

#1403

Make binaries on Linux about six times smaller (12MiB -> 2MiB). Turns tigerbeetle was accidentally including 10 megabytes worth of debug info! Note that unfortunately stripping all debug info also prevents getting a nice stack trace in case of a crash. We are working on finding the minimum amount of debug information required to get just the stack traces.
#1423, #1426.

Cleanup error handling API for Java client to never surface internal errors as checked exceptions.
#1405

Add example for setting up TigerBeetle as a systemd service.
#1400

Drop support for .Net Standard 2.1.
#1397

Don't exit repl on help command.

Internals

#1422, #1420, #1417

Overhaul documentation-testing infrastructure to reduce code duplication.
#1398

Don't test NodeJS client on platforms for which there are no simple upstream installation scripts.
#1388

Use histogram in the benchmark script to reduce memory usage.

TigerTracks 🎧

Stripped

2023-12-20

“The exception confirms the rule in cases not excepted." ― Cicero.

Due to significant commits we had this last week, we decided to make an exception in our release schedule and cut one more release in 2023!

Still, the TigerBeetle team wishes everyone happy holidays! 🎁

Internals

#1362, #1367, #1374, #1375

Some CI-related stuff plus the -Drelease flag, which will bring back the joy of using the compiler from the command line 🤓.
#1373

Added value count to TableInfo, allowing future optimizations for paced compaction.

Safety And Performance

#1346

The simulator found a failure when the WAL gets corrupted near a checkpoint boundary, leading us to also consider scenarios where corrupted blocks in the grid end up "intersecting" with corruption in the WAL, making the state unrecoverable where it should be. We fixed it by extending the durability of "prepares", evicting them from the WAL only when there's a quorum of checkpoints covering this "prepare".
#1366

Fix a unit test that regressed after we changed an undesirable behavior that allowed prefetch to invoke its callback synchronously.
#1381

Relaxed a simulator's verification, allowing replicas of the core cluster to be missing some prepares, as long as they are from a past checkpoint.

Features

#1054

A highly anticipated feature lands on TigerBeetle: it's now possible to retrieve the transfers involved with a given account by using the new operation get_account_transfers.

Note that this feature itself is an ad-hoc API intended to be replaced once we have a proper Querying API. The real improvement of this PR is the implementation of range queries, enabling us to land exciting new features on the next releases.
#1368

Bump the client's maximum limit and the default value of concurrency_max to fully take advantage of the batching logic.

TigerTracks 🎧

Everybody needs somebody

2023-12-18

As the last release of the year 2023, the TigerBeetle team wishes everyone happy holidays! 🎁

Internals

#1359

We've established a rotation between the team for handling releases. As the one writing these release notes, I am now quite aware.
#1357

Fix panic in JVM unit test on Java 21. We test JNI functions even if they're not used by the Java client and the semantics have changed a bit since Java 11.
#1351, #1356, #1360

Move client sessions from the Superblock (database metadata) into the Grid (general storage). This simplifies control flow for various sub-components like Superblock checkpointing and Replica state sync.

Safety And Performance

#1352

An optimization for removes on secondary indexes makes a return. Now tombstone values in the LSM can avoid being compacted all the way down to the lowest level if they can be cancelled out by inserts.
#1257

Clients automatically batch pending similar requests 🎉! If a tigerbeetle client submits a request, and one with the same operation is currently in-flight, they will be grouped and processed together where possible (currently, only for CreateAccount and CreateTransfers). This should greatly improve the performance of workloads which submit a single operation at a time.

TigerTracks 🎧

Carouselambra

2023-12-11

Safety And Performance

#1339

Defense in depth: add checkpoint ID to prepare messages. Checkpoint ID is a hash that covers, via hash chaining, the entire state stored in the data file. Verifying that checkpoint IDs match provides a direct strong cryptographic guarantee that the state is the same across replicas, on top of existing guarantee that the sequence of events leading to the state is identical.

Internals

#1343, #1341, #1340

Gate the main branch on more checks: unit-tests for NodeJS and even more fuzzers.
#1332, #1348

Code cleanups after removal of storage size limit.

TigerTracks 🎧

Concrete Reservation

2023-12-04

Safety And Performance

#1330, #1319

Fix free set index. The free set is a bitset of free blocks in the grid. To speed up block allocation, the free set also maintains an index --- a coarser-grained bitset where a single bit corresponds to 1024 blocks. Maintaining consistency between a data structure and its index is hard, and thorough assertions are crucial. When moving free set to the grid, we discovered that, in fact, we don't have enough assertions in this area and, as a result, even have a bug! Assertions added, bug removed!
#1323, #1336, #1324

LSM tree fuzzer found a couple of bugs in its own code.

Features

#1331, #1322, #1328

Remove format-time limit on the size of the data file. Before, the maximum size of the data file affected the layout of the superblock, and there wasn't any good way to increase this limit, short of recreating the cluster from scratch. Now, this limit only applies to the in-memory data structures: when a data files grows large, it is sufficient to just restart its replica with a larger amount of RAM.
#1321.

We finally have the "installation" page in our docs!

Internals

#1334

Use Zig's new if (@inComptime()) builtin to compute checksum of an empty byte slice at compile time.
#1315

Fix unit tests for the Go client and add them to not rocket science set of checks.

TigerTracks 🎧

Times Like These

2023-11-27

Internals

#1306, #1308

When validating our releases, use the release branch instead of main to ensure everything is in sync, and give the Java validation some retry logic to allow for delays in publishing to Central.
#1310

Pad storage checksums from 128-bit to 256-bit. These are currently unused, but we're reserving the space for AEAD tags in future.
#1312

Remove a trailing comma in our Java client sample code.
#1313

Switch bootstrap.sh to use spaces only for indentation and ensure it's checked by our shellcheck lint.
#1314

Update our DESIGN.md to better reflect storage fault probabilities and add in a reference.
#1316

Add CHANGELOG.md validation to our tidy lint script. We now check line length limits and trailing whitespace.
#1317

In keeping with TigerStyle rename reserved_nonce to nonce_reserved.
#1318

Note in TigerStyle that callbacks go last in the list of parameters.
#1325

Add an exception for line length limits if there's a link in said line.

TigerTracks 🎧

Space Trash

2023-11-20

Safety And Performance

#1300

Recursively check for padding in structs used for data serialization, ensuring that no uninitialized bytes can be stored or transmitted over the network. Previously, we checked only if the struct had no padding, but not its fields.

Internals

#1299

Minor adjustments in the release process, making it easier to track updates in the documentation website when a new version is released, even if there are no changes in the documentation itself.
#1301

Fix outdated documentation regarding 128-bit balances.
#1302

Fix a bug discovered and reported during the Hackathon 2023, where the Node.js client's error messages were truncated due to an incorrect string concatenation adding a null byte 0x00 in the middle of the string.
#1291

Update the Node.js samples instructions, guiding the user to install all dependencies before the sample project.
#1295

We've doubled the Headers size to 256 bytes, paving the way for future improvements that will require extra space. Concurrently, this change also refactors a great deal of code. Some of the Header's fields are shared by all messages, however, each Command also requires specific pieces of information that are only used by its kind of message, and it was necessary to repurpose and reinterpret fields so that the same header could hold different data depending on the context. Now, commands have their own specialized data type containing the fields that are only pertinent to the context, making the API much safer and intent-clear.
#1304

With larger headers (see #1295) we have enough room to make the cluster ID a 128-bit integer, allowing operators to generate random cluster IDs without the cost of having a centralized ID coordinator. Also updates the documentation and sample programs to reflect the new maximum batch size, which was reduced from 8191 to 8190 items after we doubled the header.

TigerTracks 🎧

She smiled sweetly

2023-11-13

Safety And Performance

#1264

Implement last-mile release artifact verification in CI.
#1268

Bump the simulator's safety phase max-ticks to avoid false positives from the liveness check.
#1270

Fix a crash caused by a race between a commit and a repair acquiring a client-reply Write.
#1278

Fix a crash caused by a race between state (table) sync and a move-table compaction.

Both bugs didn't stand a chance in the Line of Fire of our deterministic simulator!

Internals

#1244

Specify which CPU features are supported in builds.
#1275

Improve shell.zig's directory handling, to guard against mistakes with respect to the current working directory.
#1277

Interpret a git hash as a VOPR seed, to enable reproducible simulator smoke tests in CI.
#1288

Explicitly target glibc 2.7 when building client libraries, to make sure TigerBeetle clients are compatible with older distributions.

2023-11-06

Safety And Performance

#1263

Revive the TigerBeetle VOPRHub! Some previous changes left it on it's Last Stand, but the bot is back in business finding liveness bugs: #1266

Features

#1260

Set the latest Docker image to track the latest release. Avoids language clients going out of sync with your default docker replica installations.

Internals

#1261

Move website doc generation for https://docs.tigerbeetle.com/ into the main repo.
#1265, #1243

Addressed some release quirks with the .NET and Go client builds.

2023-10-30

Safety And Performance

#1251

Prove a tighter upper bound for the size of manifest log. With this new bound, manifest log is guaranteed to fit in allocated memory and is smaller. Additionally, manifest log compaction is paced depending on the current length of the log, balancing throughput and time-to-recovery.
#1198

Recommend using ULID for event IDs. ULIDs are approximately sorted, which significantly improves common-case performance.

Internals

#1218

Rewrite Node.js client implementation to use the common C client underneath. While clients for other languages already use the underlying C library, the Node.js client duplicated some code for historical reasons, but now we can leave that duplication in the past. This Is A Photograph.

2023-10-25

Safety And Performance

#1240

Increase block size to reduce latencies due to compaction work. Today, we use a simplistic schedule for compaction, which causes latency spikes at the end of the bar. While the future solution will implement a smarter compaction pacing to distribute the work more evenly, we can get a quick win by tweaking the block and the bar size, which naturally evens out latency spikes.
#1246

The new release process changed the names of the published artifacts (the version is no longer included in the name). This broke our quick start scripts, which we have fixed. Note that we are in the process of rolling out the new release process, so some unexpected breakage is expected.
#1239, #1243

Speed up secondary index maintenance by statically distinguishing between insertions and updates. Faster than the speed of night!

Features

#1245

Include Docker images in the release.

Internals

#1234

Simplify superblock layout by using a linked list of blocks for manifest log, so that the superblock needs to store only two block references.

P.S. Note the PR number!

2023-10-23

This is the start of the changelog. A lot happened before this point and is lost in the mist of git history, but any notable change from this point on shall be captured by this document.

Safety And Performance

#1225

Remove bloom filters. TigerBeetle implements more targeted optimizations for both positive and negative lookups, making bloom filters a net loss.

Features

#1228

Increase alignment of data blocks to 128KiB (from 512 bytes). Larger alignment gives operators better control over physical layout of data on disk.

Internals

#1201, #1232

Overhaul of CI and release infrastructure. CI and releases are now driven by Zig code. The main branch is gated on integration tests for all clients.

This is done in preparation for the first TigerBeetle release.

Prehistory

For archeological inquiries, check out the state of the repository at the time of the first changelog:

0.15.4

published 0.15.4 • 4 months ago

0.15.3

published 0.15.3 • 9 months ago

0.15.2