stym06/rebuf

Rebuf is a library that can be used as a WAL which can be used for logging and later replaying the data bytes during downstream service failure

rebuf

rebuf is a Golang implementation of WAL (Write Ahead||After Logging) which can also be used to log data bytes during a downstream service issue which can later be replayed on-demand

Features

• Create and replay log data on any filesystem.
• Lightweight and easy to use.
• Efficient storage and retrieval of log data.

Installation

1. Clone the repository: git clone https://github.com/stym06/rebuf.git
2. Navigate to the project directory: cd rebuf
3. Install the necessary dependencies by running: go mod download

Usage

func writeToStdout(data []byte) error {
	slog.Info(string(data))
	return nil
}

func main() {

	logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

	//Init the RebufOptions
	rebufOptions := &rebuf.RebufOptions{
		LogDir:      "/Users/satyamraj/personal/rebuf/data",
		FsyncTime:   5 * time.Second,
		MaxLogSize:  50,
		MaxSegments: 5,
		Logger:      logger,
	}

	//Init Rebuf
	rebuf, err := rebuf.Init(rebufOptions)
	if err != nil {
		logger.Info("Error during Rebuf creation: " + err.Error())
	}

	defer rebuf.Close()

	// Write Bytes
	for i := 0; i < 30; i++ {
		logger.Info("Writing data: ", "iter", i)
		go rebuf.Write([]byte("Hello world"))
		time.Sleep(300 * time.Millisecond)
	}

	//Replay and write to stdout
	rebuf.Replay(writeToStdout)

	if err != nil {
		logger.Info(err.Error())
	}

	time.Sleep(30 * time.Second)

}

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact Information

If you have any questions or concerns, please feel free to reach out to the author on GitHub: @stym06.