add doc

zhangshenghang · Feb 13, 2025 · ae60c7d · ae60c7d
1 parent 2c4570d
commit ae60c7d
Show file tree

Hide file tree

Showing 6 changed files with 182 additions and 10 deletions.
diff --git a/config/seatunnel.yaml b/config/seatunnel.yaml
@@ -23,8 +23,8 @@ seatunnel:
     queue-type: blockingqueue
     print-execution-info-interval: 60
     print-job-metrics-info-interval: 60
-    print-job-event-info-interval: 31
-    event-queue-size: 101
+    print-job-event-info-interval: 30
+    event-queue-size: 100
     slot-service:
       dynamic-slot: true
     checkpoint:

diff --git a/docs/en/seatunnel-engine/rest-api-v1.md b/docs/en/seatunnel-engine/rest-api-v1.md
@@ -842,4 +842,46 @@ 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>
+
+------------------------------------------------------------------------------------------
+
+### Return Job Event Information
+
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/event/:jobId</b></code> <code>(Returns the list of job events)</code></summary>
+
+#### Parameters
+
+> | Parameter Name | Required | Type    | Description       |
+> |----------------|----------|---------|-------------------|
+> | jobId          | Yes      | string  | The Job ID        |
+
+#### Response
+
+```json
+[
+  {
+    "createdTime": 1739501227166,
+    "eventType": "LIFECYCLE_READER_OPEN"
+  },
+  {
+    "createdTime": 1739501227232,
+    "eventType": "LIFECYCLE_ENUMERATOR_OPEN"
+  },
+  {
+    "createdTime": 1739501227457,
+    "eventType": "LIFECYCLE_ENUMERATOR_CLOSE"
+  },
+  {
+    "createdTime": 1739501227516,
+    "eventType": "LIFECYCLE_WRITER_CLOSE"
+  },
+  {
+    "createdTime": 1739501228305,
+    "eventType": "LIFECYCLE_READER_CLOSE"
+  }
+]
+```
+
 </details>
diff --git a/docs/en/seatunnel-engine/rest-api-v2.md b/docs/en/seatunnel-engine/rest-api-v2.md
@@ -907,4 +907,48 @@ To get the metrics, you need to open `Telemetry` first, or you will get an empty
 
 More information about `Telemetry` can be found in the [Telemetry](telemetry.md) documentation.
 
-</details>
+</details>
+
+
+
+------------------------------------------------------------------------------------------
+
+### Return Job Event Information
+
+<details>
+ <summary><code>GET</code> <code><b>/event/:jobId</b></code> <code>(Returns the list of job events)</code></summary>
+
+#### Parameters
+
+> | Parameter Name | Required | Type    | Description       |
+> |----------------|----------|---------|-------------------|
+> | jobId          | Yes      | string  | The Job ID        |
+
+#### Response
+
+```json
+[
+  {
+    "createdTime": 1739501227166,
+    "eventType": "LIFECYCLE_READER_OPEN"
+  },
+  {
+    "createdTime": 1739501227232,
+    "eventType": "LIFECYCLE_ENUMERATOR_OPEN"
+  },
+  {
+    "createdTime": 1739501227457,
+    "eventType": "LIFECYCLE_ENUMERATOR_CLOSE"
+  },
+  {
+    "createdTime": 1739501227516,
+    "eventType": "LIFECYCLE_WRITER_CLOSE"
+  },
+  {
+    "createdTime": 1739501228305,
+    "eventType": "LIFECYCLE_READER_CLOSE"
+  }
+]
+```
+
+</details>
diff --git a/docs/zh/seatunnel-engine/rest-api-v1.md b/docs/zh/seatunnel-engine/rest-api-v1.md
@@ -849,3 +849,46 @@ network:
 获取日志文件内容：`http://localhost:5801/hazelcast/rest/maps/log/job-898380162133917698.log`
 
 </details>
+
+
+------------------------------------------------------------------------------------------
+
+### 返回作业的事件信息
+
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/event/:jobId</b></code> <code>(返回作业事件列表)</code></summary>
+
+#### 参数
+
+> | 参数名称  | 是否必传 |  参数类型  | 参数描述 |
+> |-------|------|--------|------|
+> | jobId | 是    | string | Job ID  |
+
+#### 响应
+
+```json
+[
+  {
+    "createdTime": 1739501227166,
+    "eventType": "LIFECYCLE_READER_OPEN"
+  },
+  {
+    "createdTime": 1739501227232,
+    "eventType": "LIFECYCLE_ENUMERATOR_OPEN"
+  },
+  {
+    "createdTime": 1739501227457,
+    "eventType": "LIFECYCLE_ENUMERATOR_CLOSE"
+  },
+  {
+    "createdTime": 1739501227516,
+    "eventType": "LIFECYCLE_WRITER_CLOSE"
+  },
+  {
+    "createdTime": 1739501228305,
+    "eventType": "LIFECYCLE_READER_CLOSE"
+  }
+]
+```
+
+</details>
diff --git a/docs/zh/seatunnel-engine/rest-api-v2.md b/docs/zh/seatunnel-engine/rest-api-v2.md
@@ -895,4 +895,46 @@ curl --location 'http://127.0.0.1:8080/submit-job/upload' --form 'config_file=@"
 
 更多关于`Telemetry`的信息可以在[Telemetry](telemetry.md)文档中找到。
 
-</details>
+</details>
+
+------------------------------------------------------------------------------------------
+
+### 返回作业的事件信息
+
+<details>
+ <summary><code>GET</code> <code><b>/event/:jobId</b></code> <code>(返回作业事件列表)</code></summary>
+
+#### 参数
+
+> | 参数名称  | 是否必传 |  参数类型  | 参数描述 |
+> |-------|------|--------|------|
+> | jobId | 是    | string | Job ID  |
+
+#### 响应
+
+```json
+[
+  {
+    "createdTime": 1739501227166,
+    "eventType": "LIFECYCLE_READER_OPEN"
+  },
+  {
+    "createdTime": 1739501227232,
+    "eventType": "LIFECYCLE_ENUMERATOR_OPEN"
+  },
+  {
+    "createdTime": 1739501227457,
+    "eventType": "LIFECYCLE_ENUMERATOR_CLOSE"
+  },
+  {
+    "createdTime": 1739501227516,
+    "eventType": "LIFECYCLE_WRITER_CLOSE"
+  },
+  {
+    "createdTime": 1739501228305,
+    "eventType": "LIFECYCLE_READER_CLOSE"
+  }
+]
+```
+
+</details>
diff --git a/...src/main/java/org/apache/seatunnel/engine/core/protocol/codec/SeaTunnelGetEventCodec.java b/...src/main/java/org/apache/seatunnel/engine/core/protocol/codec/SeaTunnelGetEventCodec.java
@@ -1,11 +1,12 @@
 /*
- * Copyright (c) 2008-2022, Hazelcast, Inc. All Rights Reserved.
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *    http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,