Skip to content

Commit 5f646aa

Browse files
authored
refine diagrams (#600)
1 parent 51dbe3a commit 5f646aa

25 files changed

Lines changed: 358 additions & 14 deletions

docs/cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Underlying both the metadata and data layers is **Timeplus NativeLog**, the dist
1616

1717
The following diagram shows a more advanced cluster design with metadata, data, and compute nodes running on separate tiers.
1818

19-
![cluster-deployment](/img/cluster-deployment.png)
19+
![cluster-deployment](/img/cluster-deployment.svg)
2020

2121
## Distributed Ingest
2222

docs/k8s-helm.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ import TabItem from '@theme/TabItem';
55

66
You can deploy Timeplus Enterprise on a Kubernetes cluster with [Helm](https://helm.sh/). The source code of the chart can be find in our [github repo](https://github.com/timeplus-io/helm-charts/tree/main/charts/timeplus-enterprise).
77

8-
For visual learning, you can watch the following video:
9-
<iframe width="560" height="315" src="https://www.youtube.com/embed/kFyzYx1JI_8?si=WVszQMuFyW6Xcixm" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
10-
118
## Prerequisites
129

1310
- Ensure you have Helm 3.12 + installed in your environment. For details about how to install Helm, see the [Helm documentation](https://helm.sh/docs/intro/install/)

docs/materialized-perf-tuning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A **Materialized View** consists of four main components. Performance tuning can involve one or more of these components.
44

5-
![MatView](/img/mat-view.png)
5+
![MatView](/img/mat-view-perf.svg)
66

77
## Tune Sources
88

docs/materialized-view-checkpoint.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In general, the **checkpoint coordinator** periodically sends checkpoint markers
66

77
The following diagram illustrates this process:
88

9-
![MaterializedViewCheckpoint](/img/materialized-view-checkpoint.png)
9+
![MaterializedViewCheckpoint](/img/mat-view-checkpoint.png)
1010

1111
Each checkpoint round is assigned a new checkpoint **epoch**. Once a new checkpoint epoch is committed, older epochs can be garbage collected automatically.
1212

@@ -44,7 +44,7 @@ In this mode (applies to both **local file system checkpoints** and **RocksDB-ba
4444
3. Peer replicas consume these checkpoint records from the log and reconstruct them into checkpoint files for the current epoch.
4545
4. After replication completes, all Materialized View replicas hold identical checkpoint states.
4646

47-
![NativeLogCkptReplication](/img/materialized-view-nativelog-ckpt.png)
47+
![NativeLogCkptReplication](/img/mat-view-nativelog-ckpt.png)
4848

4949
By default, **NativeLog-based checkpoint replication** is used in cluster environments.
5050

@@ -78,7 +78,7 @@ There are two variants:
7878
1. The checkpoint coordinator serializes query states to the local file system in a new epoch.
7979
2. It asynchronously uploads the state files for that epoch to shared storage.
8080

81-
![SharedStorageCkpt](/img/materialized-view-shared-storage-ckpt.png)
81+
![SharedStorageCkpt](/img/mat-view-shared-storage-ckpt.png)
8282

8383
When using shared storage exclusively, Timeplus adopts a different high availability model for Materialized Views, governed by a centralized scheduler.
8484

@@ -121,7 +121,7 @@ This hybrid approach combines NativeLog with shared storage.
121121
3. It commits the object URIs / paths metadata records to NativeLog.
122122
4. Peer replicas consume these path metadata records, fetch the checkpoint files from shared storage, and reconstruct the checkpoint locally.
123123

124-
![NativeLogComboReplication](/img/materialized-view-hybrid-ckpt.png)
124+
![NativeLogComboReplication](/img/mat-view-hybrid-ckpt.png)
125125

126126
**Example**:
127127
```sql

docs/materialized-view-high-availability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Raft-based HA model is the default option. When you create a Materialized Vi
1010

1111
Internally, this model leverages a **NativeLog checkpoint shard**, which is replicated using Raft for fault tolerance.
1212

13-
![RaftBasedHA](/img/materialized-view-raft-ha.png)
13+
![RaftBasedHA](/img/mat-view-raft-ha.png)
1414

1515
### Initial Leader Election
1616

@@ -39,7 +39,7 @@ SETTINGS checkpoint_settings='replication_type=shared;shared_disk=...'
3939

4040
We call this a **Scheduled Materialized View**, since it is governed by the scheduler.
4141

42-
![SchedulerBasedHA](/img/materialized-view-scheduler-ha.png)
42+
![SchedulerBasedHA](/img/mat-view-scheduler-ha.png)
4343

4444
### Initial Placement
4545

docs/materialized-view-lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Materialized Views can exist in the following states. Some are **transient** (sh
2020

2121
The state transitions are illustrated in the diagram below:
2222

23-
![MaterializedViewStates](/img/materialized-view-states-transition.png)
23+
![MaterializedViewStates](/img/mat-view-states-transition.png)
2424

2525
## System Commands
2626

docs/materialized-view-monitoring.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
Timeplus provides detailed metrics and states to monitor Materialized Views.
44
The **Timeplus Console** offers visualizations for these metrics and states, but you can also query them directly.
55

6+
## Timeplus Console
7+
8+
Here are screenshots from Timeplus Materialized View monitoring in the Timeplus Console.
9+
10+
**High Level Information**
11+
12+
![HighLevelMatViewList](/img/mat-view-monitor-1.png)
13+
14+
**Detail Metrics**
15+
16+
![DetailMatViewMon](/img/mat-view-monitor-2.png)
17+
618
## Metrics
719

820
The `system.stream_metric_log` stream records performance metrics such as **events per second (eps)** and **megabytes per second (mbps)** for Materialized Views, streams, external streams, and external tables.

docs/materialized-view.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A **Materialized View** consists of 4 main components (illustrated in the diagra
2323
- Persists intermediate query state (e.g., for windowed aggregations or joins).
2424
- Ensures fault tolerance by allowing recovery and continuation from the last checkpoint after a failure.
2525

26-
![MatView](/img/mat-view.png)
26+
![MatView](/img/mat-view.svg)
2727

2828
When a Materialized View checkpoints its query state, it ensures durability and fault tolerance. If the process fails mid-execution, it can **restart from the last checkpoint** without reprocessing the entire stream from beginning.
2929

@@ -39,7 +39,7 @@ By combining other Timeplus features / components such as:
3939

4040
you can build **complex, end-to-end data processing pipelines** with Materialized Views.
4141

42-
![Pipeline](/img/pipelines.png)
42+
![Pipeline](/img/mat-view-pipelines.png)
4343

4444
## Create Materialized View
4545

static/img/cluster-deployment.svg

Lines changed: 217 additions & 0 deletions
Loading
-776 KB
Loading

0 commit comments

Comments
 (0)