https://github.com/backtrace-labs/stuffed-record-stream

Backtrace.io's resilient log record framing format
https://github.com/backtrace-labs/stuffed-record-stream

Last synced: 6 months ago
JSON representation

Backtrace.io's resilient log record framing format

• Host: GitHub
• URL: https://github.com/backtrace-labs/stuffed-record-stream
• Owner: backtrace-labs
• License: mit
• Created: 2021-01-11T20:19:59.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-02-05T19:43:45.000Z (almost 4 years ago)
• Last Synced: 2025-04-22T23:15:40.607Z (9 months ago)
• Language: C
• Homepage: https://www.backtrace.io
• Size: 29.3 KB
• Stars: 38
• Watchers: 12
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
% record_stream: a resilient self-synchronising format for log records

[Backtrace](https://www.backtrace.io)'s log record framing format

=================================================================

We use this self-synchronising format to store key metadata for our

server-side embedded crash database.  Operationally, the format has

proven itself resilient, flexible, and easy to tweak with ad hoc

scripts.  We are standardising on this format for persistent logs of

variable-length records.

This [blog post](https://engineering.backtrace.io/2021-01-11-stuff-your-logs/)

contains background and explains why you might to use such a format.

There is also a copy of the post in `doc/2021-01-11-stuff-your-logs.md`.

We released the source under the MIT license, but the scheme is simple

enough that mining the repository for ideas and coding an interface

tuned to one's specific needs might also make sense.