Percona Binary Log Server documentation

The repository contains the source files and resources for the documentation of the Percona Binary Log Server.

The Percona Binary Log Server is a command-line utility that serves as an enhanced version of mysqlbinlog in --read-from-remote-server mode. The utility acts as a replication client that can stream binary log events from remote Oracle MySQL or Percona Server for MySQL instances to both local filesystems and cloud storage, for example AWS S3.

Table of Contents

• About the Project
• How to Use These Docs
• Documentation Structure
• Contributing
• License
• Resources

About the Project

The Percona Binary Log Server provides a robust way to:

• Stream & Archive: Fetch binary logs and store them locally or in S3.
• Resume Operations: Automatically reconnect and resume from the last point of termination.
• Search: Quickly find binlog files by Timestamp or GTID set.
• Support Modern Standards: Built with C++20 and supports advanced MySQL replication features.

The repository serves as the central hub for user guides, operational manuals, and developer documentation to help the community effectively deploy and manage the server.

How to Use These Docs

If you are looking for the software itself, please visit the main repository.

The documentation is typically written in Markdown. You can browse the files directly here on GitHub or follow the links in our Resources section for rendered versions.

Documentation Structure

• docs/: Documentation source files, including user guides, architecture material, examples, and deployment guidance.

Contributing

We encourage contributions to improve the quality of our documentation! To contribute:

1. Fork the repository.
2. Create a new branch for your documentation updates.
3. Submit a Pull Request (PR) describing your changes.

Please review the Contributing Guide and the Code of Conduct before submitting changes.

If you find a bug in the documentation or have a feature request for the tool itself, please use the Jira issue tracker or the GitHub Issues page.

License

Percona Binary Log Server documentation is licensed under a Creative Commons Attribution 4.0 International License.

Resources

• Main Repository: Percona-Lab/percona-binlog-server
• Community Forum: Percona Community Forum
• Blog Posts: Percona Database Performance Blog

For more information about Percona's open-source software, visit percona.com.