canal README

The project's README from github.com/alibaba/canal. As one markdown file: README.md.

build status codecov maven license average time to resolve an issue percentage of issues still open Leaderboard

简介

canal [kə'næl],译意为水道/管道/沟渠,主要用途是基于 MySQL 数据库增量日志解析,提供增量数据订阅和消费

早期阿里巴巴因为杭州和美国双机房部署,存在跨机房同步的业务需求,实现方式主要是基于业务 trigger 获取增量变更。从 2010 年开始,业务逐步尝试数据库日志解析获取增量变更进行同步,由此衍生出了大量的数据库增量订阅和消费业务。

基于日志增量订阅和消费的业务包括

当前的 canal 支持源端 MySQL 版本包括 5.1.x , 5.5.x , 5.6.x , 5.7.x , 8.0.x

工作原理

MySQL主备复制原理

canal 工作原理

重要版本更新说明

  1. canal 1.1.x 版本(release_note),性能与功能层面有较大的突破,重要提升包括:
  1. canal 1.1.4版本,迎来最重要的WebUI能力,引入canal-admin工程,支持面向WebUI的canal动态管理能力,支持配置、任务、日志等在线白屏运维能力,具体文档:Canal Admin Guide

文档

多语言

canal 特别设计了 client-server 模式,交互协议使用 protobuf 3.0 , client 端可采用不同语言实现不同的消费逻辑,欢迎大家提交 pull request

canal 作为 MySQL binlog 增量获取和解析工具,可将变更记录投递到 MQ 系统中,比如 Kafka/RocketMQ,可以借助于 MQ 的多语言能力

基于canal开发的工具

相关开源&产品

问题反馈

本项目的Issues会被同步沉淀至阿里云开发者社区

canal (alibaba/canal)

Searching Database…

29.7K ·GitHub
Что это такое?Canal — это компонент от Alibaba для подписки на инкрементальные изменения binlog MySQL и их обработки. Он выдаёт себя за slave-сервер MySQL, получает события binlog с мастер-сервера MySQL и позволяет использовать разобранные изменения для обновления кеша, построения индексов или синхронизации баз данных.
Это библиотека, которую я встраиваю, или отдельный сервер?Это самостоятельная система клиент-сервер: процесс canal server общается с MySQL как с поддельным slave-сервером, а отдельные клиентские приложения (на Java, C#, Go, PHP, Python, Rust или Node.js) подключаются к нему по протоколу protobuf 3.0, чтобы получать изменения.
Как это запустить?Следуйте руководству QuickStart (или Docker QuickStart), чтобы настроить сервер canal, укажите ему мастер-сервер MySQL для начала выгрузки binlog, а затем напишите клиент на нужном языке для обработки разобранных событий или направьте их напрямую в Kafka или RocketMQ.
Нужно ли сначала настраивать репликацию MySQL?Да. Canal имитирует протокол репликации MySQL, поэтому на мастер-сервере MySQL должен быть включён binlog и настроено подключение так, как будто к нему подключён slave, ведь canal отправляет запрос dump точно так же, как настоящий slave.
Какие версии MySQL поддерживаются на самом деле?Сейчас поддерживаются версии MySQL на стороне источника: 5.1.x, 5.5.x, 5.6.x, 5.7.x и 8.0.x. Другие версии или сильно изменённые форки MySQL работать не гарантированно.
Кто обычно это использует и зачем это создали?Изначально это создали внутри Alibaba, чтобы синхронизировать данные между дата-центрами в Ханчжоу и США. Инструмент подходит командам, которым нужно зеркалирование баз данных, резервное копирование в реальном времени, поддержка поисковых индексов или сброс кеша при изменениях в БД.
Работает ли это на Linux-серверах в продакшене?Да. Canal — это серверный процесс на Java, который обычно разворачивают на Linux. Также есть официальный Docker-образ, который упрощает развёртывание.
Есть ли у canal веб-интерфейс для управления?Да, начиная с версии 1.1.4 в canal входит проект canal-admin, который предоставляет WebUI для динамического управления конфигурацией, задачами и логами без ручной правки файлов.
Может ли canal отправлять изменения напрямую в Kafka или RocketMQ?Да. Canal умеет отправлять разобранные события binlog прямо в Kafka или RocketMQ как цели доставки сообщений, поэтому не нужен отдельный самописный клиент-ретранслятор.
Поддерживает ли canal экземпляры Alibaba Cloud RDS?Да, есть встроенная поддержка подписки на binlog из Aliyun RDS for MySQL. Она также решает такие задачи, как автоматическое переключение master/slave при сбое и офлайн-разбор binlog из OSS.
Есть ли встроенный мониторинг для canal?Да, canal из коробки поддерживает метрики Prometheus, поэтому можно отслеживать его производительность и состояние без дополнительной настройки.
Creator
alibaba
Size
23.7 MB
Stars
29.7K
Age
13y
Commits · 90 Days