Skip to content

bersler/OpenLogReplicator

Repository files navigation

OpenLogReplicator

OpenLogReplicator is an open-source Oracle database Change Data Capture (CDC) solution written in C++.

It reads transactions directly from Oracle redo log files (by parsing binary redo logs) and streams changes in JSON or Protobuf format to various targets.

Supported targets

  • Kafka
  • Flat file
  • Network stream (plain TCP/IP or ZeroMQ)
  • Discard (for testing)

License and user rights

OpenLogReplicator is released under the GNU General Public License (GPL).

If you have received software that is based on OpenLogReplicator, you are legally entitled to obtain the full corresponding source code of that software.

For details, see the LICENSE file.


Getting started

For a quick start, refer to the OpenLogReplicator tutorials repository.


Documentation

  1. Introduction to OpenLogReplicator
  2. User Manual
    1. Getting Started
    2. Architecture and Components
    3. Output Format
    4. Output Targets
    5. Supported Features
    6. Replication
    7. Startup
    8. Checkpointing
    9. Advanced Topics
  3. Reference Manual
  4. Configuration
    1. OpenLogReplicator.json
    2. source
    3. reader
    4. debug
    5. format
    6. filter
    7. table
    8. target
    9. writer
    10. memory
    11. metrics
    12. state
  5. Installation Guide
  6. Release Notes
  7. Metrics
  8. Troubleshooting Guide
  9. Log Message Guide
    1. Runtime Error Messages
    2. Data Error Messages
    3. Configuration Error Messages
    4. Redo Log Error Messages
    5. Internal Error Messages
    6. Warning Messages
    7. Internal Warning Messages
  10. Experimental Features

Additional resources

Community discussion is available via Gitter chat.


Debezium integration

OpenLogReplicator can be used together with Debezium CDC as a replacement for the LogMiner reader.

Debezium OLR minimal version OLR recommended version
2.x 1.3.0 1.9.0
3.x 1.3.0 1.9.0

Project maintenance and sustainability

OpenLogReplicator is primarily developed and maintained by its author.

Bug reports, feature requests, and discussions are welcome. Please note that ongoing development, maintenance, and support require significant time and effort.

  • Issue reports are handled on a best-effort basis.
  • Companies using OpenLogReplicator in production are encouraged to support its maintenance.

If OpenLogReplicator is critical to your systems, consider financially supporting the project or contributing improvements upstream instead of maintaining private forks.


Commercial support and collaboration

Professional support, priority bug fixes, and feature development are available.

If you are:

  • Running OpenLogReplicator in production
  • Building commercial products or services on top of it
  • Requiring guaranteed response times or roadmap influence

please consider the official support options at: https://www.bersler.com/openlogreplicator/support/


Support OpenLogReplicator

If you find OpenLogReplicator useful, consider supporting its development.

Your support directly helps ensure:

  • Continued maintenance
  • Faster bug fixes
  • New features
  • Long-term project sustainability

Any contribution is appreciated.

Sponsor via GitHub Donate via Libeapay Buy Me a Coffee