# alibaba/canal architecture

> Architecture diagram of the GitHub repository alibaba/canal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alibaba/canal
- Repository: https://github.com/alibaba/canal

## Overview

Canal captures MySQL changes by acting as a replica, parses binlog events, and makes them available for client consumption; adapter modules can transform those changes into target stores. The repository also includes Canal Admin for web-based configuration and operational management, plus Prometheus monitoring. The README documents the core capture behavior and major capabilities; sampled adapter code shows DML synchronization and ETL behavior. Admin wiring and several runtime links are not shown in the supplied excerpts, so those connections are marked unverified.

Main entry points: [`client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/Dml.java`](https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/Dml.java) (Change records), [`client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java`](https://github.com/alibaba/canal/blob/master/client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java) (Target sync services), [`driver/src/main/java/com/alibaba/otter/canal/parse/driver/mysql/MysqlQueryExecutor.java`](https://github.com/alibaba/canal/blob/master/driver/src/main/java/com/alibaba/otter/canal/parse/driver/mysql/MysqlQueryExecutor.java) (MySQL protocol driver), [`client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java`](https://github.com/alibaba/canal/blob/master/client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java) (Elasticsearch sync)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_capture["Binlog capture"]
  node_driver["MySQL protocol driver"]
  node_parser["Binlog parser"]
  node_event_sink["Event sink"]
end

subgraph group_delivery["Event delivery"]
  node_server["Canal server<br/>[CanalService.java]"]
  node_protocol["Client protocol"]
  node_client["Canal client"]
end

subgraph group_adapters["Client adapters"]
  node_adapter_launcher["Adapter launcher"]
  node_adapter_config["Adapter configuration<br/>[AdapterConfig.java]"]
  node_dml["Change records<br/>[Dml.java]"]
  node_sync_services["Target sync services"]
  node_etl["Full-load ETL"]
  node_es_sync["Elasticsearch sync<br/>[ESSyncService.java]"]
  node_hbase_sync["HBase sync"]
  node_phoenix_sync["Phoenix sync"]
  node_clickhouse_sync["ClickHouse sync"]
end

subgraph group_operations["Operations and management"]
  node_admin_ui["Admin web UI<br/>[CanalInstance.vue]"]
  node_admin_api["Admin API"]
  node_admin_services["Admin services"]
  node_admin_db[("Admin database<br/>[EbeanConfig.java]")]
  node_prometheus["Prometheus metrics"]
end

node_mysql[("MySQL master")]
node_consumer(("Consumer application"))
node_target_store[("Target data store")]
node_operator(("Canal operator"))
node_prometheus_scraper(("Metrics scraper"))

node_driver -->|"requests binlog"| node_mysql
node_mysql -->|"streams events"| node_driver
node_driver -.->|"passes byte stream"| node_parser
node_parser -.->|"forwards events"| node_event_sink
node_server -.->|"serves subscriptions"| node_consumer
node_consumer -.->|"uses connector"| node_client
node_adapter_launcher -.->|"loads settings"| node_adapter_config
node_sync_services -->|"reads changes"| node_dml
node_sync_services -->|"uses mappings"| node_adapter_config
node_es_sync -->|"reads changes"| node_dml
node_es_sync -.->|"writes indexes"| node_target_store
node_hbase_sync -->|"reads changes"| node_dml
node_phoenix_sync -->|"reads changes"| node_dml
node_clickhouse_sync -->|"reads changes"| node_dml
node_etl -.->|"imports full data"| node_target_store
node_sync_services -.->|"applies changes"| node_target_store
node_operator -.->|"manages instances"| node_admin_ui
node_admin_ui -.->|"sends requests"| node_admin_api
node_admin_api -.->|"delegates"| node_admin_services
node_admin_services -.->|"persists settings"| node_admin_db
node_prometheus_scraper -.->|"scrapes metrics"| node_prometheus

click node_driver "https://github.com/alibaba/canal/blob/master/driver/src/main/java/com/alibaba/otter/canal/parse/driver/mysql/MysqlQueryExecutor.java"
click node_parser "https://github.com/alibaba/canal/blob/master/parse/src/main/java/com/alibaba/otter/canal/parse/ha/HeartBeatHAController.java"
click node_event_sink "https://github.com/alibaba/canal/blob/master/sink/src/main/java/com/alibaba/otter/canal/sink/CanalEventDownStreamHandler.java"
click node_server "https://github.com/alibaba/canal/blob/master/server/src/main/java/com/alibaba/otter/canal/server/CanalService.java"
click node_protocol "https://github.com/alibaba/canal/blob/master/protocol/src/main/java/com/alibaba/otter/canal/protocol/ClientIdentity.java"
click node_client "https://github.com/alibaba/canal/blob/master/client/src/main/java/com/alibaba/otter/canal/client/CanalConnector.java"
click node_adapter_launcher "https://github.com/alibaba/canal/blob/master/client-adapter/launcher/src/main/java/com/alibaba/otter/canal/adapter/launcher/loader/CanalAdapterService.java"
click node_adapter_config "https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AdapterConfig.java"
click node_dml "https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/Dml.java"
click node_sync_services "https://github.com/alibaba/canal/blob/master/client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java"
click node_etl "https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AbstractEtlService.java"
click node_es_sync "https://github.com/alibaba/canal/blob/master/client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java"
click node_hbase_sync "https://github.com/alibaba/canal/blob/master/client-adapter/hbase/src/main/java/com/alibaba/otter/canal/client/adapter/hbase/service/HbaseSyncService.java"
click node_phoenix_sync "https://github.com/alibaba/canal/blob/master/client-adapter/phoenix/src/main/java/com/alibaba/otter/canal/client/adapter/phoenix/service/PhoenixSyncService.java"
click node_clickhouse_sync "https://github.com/alibaba/canal/blob/master/client-adapter/clickhouse/src/main/java/com/alibaba/otter/canal/client/adapter/clickhouse/service/ClickHouseBatchSyncService.java"
click node_admin_ui "https://github.com/alibaba/canal/blob/master/admin/admin-ui/src/views/canalServer/CanalInstance.vue"
click node_admin_api "https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/controller/CanalInstanceController.java"
click node_admin_services "https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/service/impl/CanalInstanceServiceImpl.java"
click node_admin_db "https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/config/EbeanConfig.java"
click node_prometheus "https://github.com/alibaba/canal/blob/master/prometheus/src/main/java/com/alibaba/otter/canal/prometheus/PrometheusService.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_driver,node_parser,node_event_sink toneBlue
class node_server,node_protocol,node_client,node_mysql,node_target_store toneAmber
class node_adapter_launcher,node_adapter_config,node_dml,node_sync_services,node_etl,node_es_sync,node_hbase_sync,node_phoenix_sync,node_clickhouse_sync toneMint
class node_admin_ui,node_admin_api,node_admin_services,node_admin_db,node_prometheus toneRose
class node_consumer,node_operator,node_prometheus_scraper toneIndigo
```

## Components

### Binlog capture

- [MySQL protocol driver](https://github.com/alibaba/canal/blob/master/driver/src/main/java/com/alibaba/otter/canal/parse/driver/mysql/MysqlQueryExecutor.java): `driver/src/main/java/com/alibaba/otter/canal/parse/driver/mysql/MysqlQueryExecutor.java`
- [Binlog parser](https://github.com/alibaba/canal/blob/master/parse/src/main/java/com/alibaba/otter/canal/parse/ha/HeartBeatHAController.java): `parse/src/main/java/com/alibaba/otter/canal/parse/ha/HeartBeatHAController.java`
- [Event sink](https://github.com/alibaba/canal/blob/master/sink/src/main/java/com/alibaba/otter/canal/sink/CanalEventDownStreamHandler.java): `sink/src/main/java/com/alibaba/otter/canal/sink/CanalEventDownStreamHandler.java`

### Event delivery

- [Canal server](https://github.com/alibaba/canal/blob/master/server/src/main/java/com/alibaba/otter/canal/server/CanalService.java): `server/src/main/java/com/alibaba/otter/canal/server/CanalService.java`
- [Client protocol](https://github.com/alibaba/canal/blob/master/protocol/src/main/java/com/alibaba/otter/canal/protocol/ClientIdentity.java): `protocol/src/main/java/com/alibaba/otter/canal/protocol/ClientIdentity.java`
- [Canal client](https://github.com/alibaba/canal/blob/master/client/src/main/java/com/alibaba/otter/canal/client/CanalConnector.java): `client/src/main/java/com/alibaba/otter/canal/client/CanalConnector.java`

### Client adapters

- [Adapter launcher](https://github.com/alibaba/canal/blob/master/client-adapter/launcher/src/main/java/com/alibaba/otter/canal/adapter/launcher/loader/CanalAdapterService.java): `client-adapter/launcher/src/main/java/com/alibaba/otter/canal/adapter/launcher/loader/CanalAdapterService.java`
- [Adapter configuration](https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AdapterConfig.java): `client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AdapterConfig.java`
- [Change records](https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/Dml.java): `client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/Dml.java`
- [Target sync services](https://github.com/alibaba/canal/blob/master/client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java): `client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java`
- [Full-load ETL](https://github.com/alibaba/canal/blob/master/client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AbstractEtlService.java): `client-adapter/common/src/main/java/com/alibaba/otter/canal/client/adapter/support/AbstractEtlService.java`
- [Elasticsearch sync](https://github.com/alibaba/canal/blob/master/client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java): `client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java`
- [HBase sync](https://github.com/alibaba/canal/blob/master/client-adapter/hbase/src/main/java/com/alibaba/otter/canal/client/adapter/hbase/service/HbaseSyncService.java): `client-adapter/hbase/src/main/java/com/alibaba/otter/canal/client/adapter/hbase/service/HbaseSyncService.java`
- [Phoenix sync](https://github.com/alibaba/canal/blob/master/client-adapter/phoenix/src/main/java/com/alibaba/otter/canal/client/adapter/phoenix/service/PhoenixSyncService.java): `client-adapter/phoenix/src/main/java/com/alibaba/otter/canal/client/adapter/phoenix/service/PhoenixSyncService.java`
- [ClickHouse sync](https://github.com/alibaba/canal/blob/master/client-adapter/clickhouse/src/main/java/com/alibaba/otter/canal/client/adapter/clickhouse/service/ClickHouseBatchSyncService.java): `client-adapter/clickhouse/src/main/java/com/alibaba/otter/canal/client/adapter/clickhouse/service/ClickHouseBatchSyncService.java`

### Operations and management

- [Admin web UI](https://github.com/alibaba/canal/blob/master/admin/admin-ui/src/views/canalServer/CanalInstance.vue): `admin/admin-ui/src/views/canalServer/CanalInstance.vue`
- [Admin API](https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/controller/CanalInstanceController.java): `admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/controller/CanalInstanceController.java`
- [Admin services](https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/service/impl/CanalInstanceServiceImpl.java): `admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/service/impl/CanalInstanceServiceImpl.java`
- [Admin database](https://github.com/alibaba/canal/blob/master/admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/config/EbeanConfig.java): `admin/admin-web/src/main/java/com/alibaba/otter/canal/admin/config/EbeanConfig.java`
- [Prometheus metrics](https://github.com/alibaba/canal/blob/master/prometheus/src/main/java/com/alibaba/otter/canal/prometheus/PrometheusService.java): `prometheus/src/main/java/com/alibaba/otter/canal/prometheus/PrometheusService.java`

### Other components

- **MySQL master**
- **Consumer application**
- **Target data store**
- **Canal operator**
- **Metrics scraper**

## Connections

- MySQL protocol driver → MySQL master: requests binlog (evidence: `README.md`)
- MySQL master → MySQL protocol driver: streams events (evidence: `README.md`)
- MySQL protocol driver → Binlog parser: passes byte stream
- Binlog parser → Event sink: forwards events
- Canal server → Consumer application: serves subscriptions
- Consumer application → Canal client: uses connector
- Adapter launcher → Adapter configuration: loads settings
- Target sync services → Change records: reads changes (evidence: `client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java`)
- Target sync services → Adapter configuration: uses mappings (evidence: `client-adapter/rdb/src/main/java/com/alibaba/otter/canal/client/adapter/rdb/service/RdbSyncService.java`)
- Elasticsearch sync → Change records: reads changes (evidence: `client-adapter/escore/src/main/java/com/alibaba/otter/canal/client/adapter/es/core/service/ESSyncService.java`)
- Elasticsearch sync → Target data store: writes indexes
- HBase sync → Change records: reads changes (evidence: `client-adapter/hbase/src/main/java/com/alibaba/otter/canal/client/adapter/hbase/service/HbaseSyncService.java`)
- Phoenix sync → Change records: reads changes (evidence: `client-adapter/phoenix/src/main/java/com/alibaba/otter/canal/client/adapter/phoenix/service/PhoenixSyncService.java`)
- ClickHouse sync → Change records: reads changes (evidence: `client-adapter/clickhouse/src/main/java/com/alibaba/otter/canal/client/adapter/clickhouse/service/ClickHouseBatchSyncService.java`)
- Full-load ETL → Target data store: imports full data
- Target sync services → Target data store: applies changes
- Canal operator → Admin web UI: manages instances
- Admin web UI → Admin API: sends requests
- Admin API → Admin services: delegates
- Admin services → Admin database: persists settings
- Metrics scraper → Prometheus metrics: scrapes metrics
