Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

[pull] dev from apache:dev #87

Merged
pull merged 1 commit into from
Dec 1, 2025
Merged

[pull] dev from apache:dev #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions docs/en/seatunnel-engine/rest-api-v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,26 @@ network:
`envOptions`, `pluginJarsUrls`, `isStartWithSavePoint` will return when job is running.
`finishedTime`, `errorMsg` will return when job is finished.

#### Metrics field description

| Field | Description |
| --- | --- |
| SourceReceivedCount | Total rows received from sources |
| SourceReceivedQPS | Source receive rate (rows/s) |
| SourceReceivedBytes | Total bytes received from sources |
| SourceReceivedBytesPerSeconds | Source receive rate (bytes/s) |
| SinkWriteCount | Sink write attempts (rows) |
| SinkWriteQPS | Sink write attempt rate (rows/s) |
| SinkWriteBytes | Sink write attempts (bytes) |
| SinkWriteBytesPerSeconds | Sink write attempt rate (bytes/s) |
| SinkCommittedCount | Sink committed rows after checkpoint succeeds |
| SinkCommittedQPS | Sink committed rate (rows/s) |
| SinkCommittedBytes | Sink committed bytes after checkpoint succeeds |
| SinkCommittedBytesPerSeconds | Sink committed rate (bytes/s) |
| TableSourceReceived* | Per-table source metrics, key format `TableSourceReceivedXXX#<table>` |
| TableSinkWrite* | Per-table sink write attempts, key format `TableSinkWriteXXX#<table>` |
| TableSinkCommitted* | Per-table sink committed metrics, key format `TableSinkCommittedXXX#<table>` |

When we can't get the job info, the response will be:

```json
Expand Down Expand Up @@ -256,14 +276,22 @@ This API has been deprecated, please use /hazelcast/rest/maps/job-info/:jobId in
"SinkWriteQPS": "",
"SinkWriteBytes": "",
"SinkWriteBytesPerSeconds": "",
"SinkCommittedCount": "",
"SinkCommittedQPS": "",
"SinkCommittedBytes": "",
"SinkCommittedBytesPerSeconds": "",
"TableSourceReceivedCount": {},
"TableSourceReceivedBytes": {},
"TableSourceReceivedBytesPerSeconds": {},
"TableSourceReceivedQPS": {},
"TableSinkWriteCount": {},
"TableSinkWriteQPS": {},
"TableSinkWriteBytes": {},
"TableSinkWriteBytesPerSeconds": {}
"TableSinkWriteBytesPerSeconds": {},
"TableSinkCommittedCount": {},
"TableSinkCommittedQPS": {},
"TableSinkCommittedBytes": {},
"TableSinkCommittedBytesPerSeconds": {}
},
"finishedTime": "",
"errorMsg": null,
Expand Down Expand Up @@ -839,4 +867,4 @@ Returns a list of logs from the requested node.
To get a list of logs from the current node: `http://localhost:5801/hazelcast/rest/maps/log`
To get the content of a log file: `http://localhost:5801/hazelcast/rest/maps/log/job-898380162133917698.log`

</details>
</details>
31 changes: 30 additions & 1 deletion docs/en/seatunnel-engine/rest-api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,14 +320,22 @@ This endpoint helps troubleshoot why jobs stay in `PENDING` by showing the pendi
"SinkWriteQPS": "",
"SinkWriteBytes": "",
"SinkWriteBytesPerSeconds": "",
"SinkCommittedCount": "",
"SinkCommittedQPS": "",
"SinkCommittedBytes": "",
"SinkCommittedBytesPerSeconds": "",
"TableSourceReceivedCount": {},
"TableSourceReceivedBytes": {},
"TableSourceReceivedBytesPerSeconds": {},
"TableSourceReceivedQPS": {},
"TableSinkWriteCount": {},
"TableSinkWriteQPS": {},
"TableSinkWriteBytes": {},
"TableSinkWriteBytesPerSeconds": {}
"TableSinkWriteBytesPerSeconds": {},
"TableSinkCommittedCount": {},
"TableSinkCommittedQPS": {},
"TableSinkCommittedBytes": {},
"TableSinkCommittedBytesPerSeconds": {}
},
"finishedTime": "",
"errorMsg": null,
Expand All @@ -343,6 +351,27 @@ This endpoint helps troubleshoot why jobs stay in `PENDING` by showing the pendi
`envOptions`, `pluginJarsUrls`, `isStartWithSavePoint` will return when job is running.
`finishedTime`, `errorMsg` will return when job is finished.

#### Metrics field description

| Field | Description |
| --- | --- |
| IntermediateQueueSize | Size of intermediate queue between operators |
| SourceReceivedCount | Total rows received from sources |
| SourceReceivedQPS | Source receive rate (rows/s) |
| SourceReceivedBytes | Total bytes received from sources |
| SourceReceivedBytesPerSeconds | Source receive rate (bytes/s) |
| SinkWriteCount | Sink write attempts (rows) |
| SinkWriteQPS | Sink write attempt rate (rows/s) |
| SinkWriteBytes | Sink write attempts (bytes) |
| SinkWriteBytesPerSeconds | Sink write attempt rate (bytes/s) |
| SinkCommittedCount | Sink committed rows after checkpoint succeeds |
| SinkCommittedQPS | Sink committed rate (rows/s) |
| SinkCommittedBytes | Sink committed bytes after checkpoint succeeds |
| SinkCommittedBytesPerSeconds | Sink committed rate (bytes/s) |
| TableSourceReceived* | Per-table source metrics, key format `TableSourceReceivedXXX#<table>` |
| TableSinkWrite* | Per-table sink write attempts, key format `TableSinkWriteXXX#<table>` |
| TableSinkCommitted* | Per-table sink committed metrics, key format `TableSinkCommittedXXX#<table>` |

When we can't get the job info, the response will be:

```json
Expand Down
30 changes: 29 additions & 1 deletion docs/zh/seatunnel-engine/rest-api-v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,22 @@ network:
"SinkWriteQPS": "",
"SinkWriteBytes": "",
"SinkWriteBytesPerSeconds": "",
"SinkCommittedCount": "",
"SinkCommittedQPS": "",
"SinkCommittedBytes": "",
"SinkCommittedBytesPerSeconds": "",
"TableSourceReceivedCount": {},
"TableSourceReceivedBytes": {},
"TableSourceReceivedBytesPerSeconds": {},
"TableSourceReceivedQPS": {},
"TableSinkWriteCount": {},
"TableSinkWriteQPS": {},
"TableSinkWriteBytes": {},
"TableSinkWriteBytesPerSeconds": {}
"TableSinkWriteBytesPerSeconds": {},
"TableSinkCommittedCount": {},
"TableSinkCommittedQPS": {},
"TableSinkCommittedBytes": {},
"TableSinkCommittedBytesPerSeconds": {}
},
"finishedTime": "",
"errorMsg": null,
Expand All @@ -211,6 +219,26 @@ network:
`envOptions`, `pluginJarsUrls`, `isStartWithSavePoint` 字段在Job在RUNNING状态时会返回
`finishedTime`, `errorMsg` 字段在Job结束时会返回，结束状态为不为RUNNING，可能为FINISHED，可能为CANCEL

#### 指标字段说明

| 字段 | 说明 |
| --- | --- |
| SourceReceivedCount | 源端接收的行数 |
| SourceReceivedQPS | 源端接收速率（行/秒） |
| SourceReceivedBytes | 源端接收的字节数 |
| SourceReceivedBytesPerSeconds | 源端接收速率（字节/秒） |
| SinkWriteCount | Sink 写入尝试行数 |
| SinkWriteQPS | Sink 写入尝试速率（行/秒） |
| SinkWriteBytes | Sink 写入尝试字节数 |
| SinkWriteBytesPerSeconds | Sink 写入尝试速率（字节/秒） |
| SinkCommittedCount | checkpoint 成功后的 Sink 已提交行数 |
| SinkCommittedQPS | Sink 已提交速率（行/秒） |
| SinkCommittedBytes | checkpoint 成功后的 Sink 已提交字节数 |
| SinkCommittedBytesPerSeconds | Sink 已提交速率（字节/秒） |
| TableSourceReceived* | 按表汇总的源指标，键格式 `TableSourceReceivedXXX#<表>` |
| TableSinkWrite* | 按表汇总的 Sink 写入尝试，键格式 `TableSinkWriteXXX#<表>` |
| TableSinkCommitted* | 按表汇总的 Sink 已提交指标，键格式 `TableSinkCommittedXXX#<表>` |

当我们查询不到这个Job时，返回结果为：

```json
Expand Down
31 changes: 30 additions & 1 deletion docs/zh/seatunnel-engine/rest-api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,14 +314,22 @@ seatunnel:
"SinkWriteQPS": "",
"SinkWriteBytes": "",
"SinkWriteBytesPerSeconds": "",
"SinkCommittedCount": "",
"SinkCommittedQPS": "",
"SinkCommittedBytes": "",
"SinkCommittedBytesPerSeconds": "",
"TableSourceReceivedCount": {},
"TableSourceReceivedBytes": {},
"TableSourceReceivedBytesPerSeconds": {},
"TableSourceReceivedQPS": {},
"TableSinkWriteCount": {},
"TableSinkWriteQPS": {},
"TableSinkWriteBytes": {},
"TableSinkWriteBytesPerSeconds": {}
"TableSinkWriteBytesPerSeconds": {},
"TableSinkCommittedCount": {},
"TableSinkCommittedQPS": {},
"TableSinkCommittedBytes": {},
"TableSinkCommittedBytesPerSeconds": {}
},
"finishedTime": "",
"errorMsg": null,
Expand All @@ -337,6 +345,27 @@ seatunnel:
`envOptions`, `pluginJarsUrls`, `isStartWithSavePoint` 字段在Job在RUNNING状态时会返回
`finishedTime`, `errorMsg` 字段在Job结束时会返回，结束状态为不为RUNNING，可能为FINISHED，可能为CANCEL

#### 指标字段说明

| 字段 | 说明 |
| --- | --- |
| IntermediateQueueSize | 中间队列的大小 |
| SourceReceivedCount | 源端接收的行数 |
| SourceReceivedQPS | 源端接收速率（行/秒） |
| SourceReceivedBytes | 源端接收的字节数 |
| SourceReceivedBytesPerSeconds | 源端接收速率（字节/秒） |
| SinkWriteCount | Sink 写入尝试行数 |
| SinkWriteQPS | Sink 写入尝试速率（行/秒） |
| SinkWriteBytes | Sink 写入尝试字节数 |
| SinkWriteBytesPerSeconds | Sink 写入尝试速率（字节/秒） |
| SinkCommittedCount | checkpoint 成功后的 Sink 已提交行数 |
| SinkCommittedQPS | Sink 已提交速率（行/秒） |
| SinkCommittedBytes | checkpoint 成功后的 Sink 已提交字节数 |
| SinkCommittedBytesPerSeconds | Sink 已提交速率（字节/秒） |
| TableSourceReceived* | 按表汇总的源指标，键格式 `TableSourceReceivedXXX#<表>` |
| TableSinkWrite* | 按表汇总的 Sink 写入尝试，键格式 `TableSinkWriteXXX#<表>` |
| TableSinkCommitted* | 按表汇总的 Sink 已提交指标，键格式 `TableSinkCommittedXXX#<表>` |

当我们查询不到这个Job时，返回结果为：

```json
Expand Down
4 changes: 4 additions & 0 deletions seatunnel-api/src/main/java/org/apache/seatunnel/api/common/metrics/MetricNames.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ private MetricNames() {}
public static final String SINK_WRITE_BYTES = "SinkWriteBytes";
public static final String SINK_WRITE_QPS = "SinkWriteQPS";
public static final String SINK_WRITE_BYTES_PER_SECONDS = "SinkWriteBytesPerSeconds";
public static final String SINK_COMMITTED_COUNT = "SinkCommittedCount";
public static final String SINK_COMMITTED_BYTES = "SinkCommittedBytes";
public static final String SINK_COMMITTED_QPS = "SinkCommittedQPS";
public static final String SINK_COMMITTED_BYTES_PER_SECONDS = "SinkCommittedBytesPerSeconds";

public static final String INTERMEDIATE_QUEUE_SIZE = "IntermediateQueueSize";
}
Loading
Loading