chore: add note for pipeline dryrun api

GreptimeTeam · Sep 10, 2024 · e1ac887 · e1ac887
1 parent 8f40653
commit e1ac887
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/user-guide/logs/manage-pipelines.md b/docs/user-guide/logs/manage-pipelines.md
@@ -158,12 +158,14 @@ transform:
     index: timestamp'
 ```
 
-The Pipeline has been successfully created at this point.
+Now that the Pipeline has been created successfully, you can test the Pipeline using the `dryrun` interface.
 
 ### Debug writing logs
 
 We can test the Pipeline using the `dryrun` interface. We will test it with erroneous log data where the value of the message field is in numeric format, causing the pipeline to fail during processing.
 
+**This API is only used to test the results of the Pipeline and does not write data to GreptimeDB.**
+
 
 ```bash
 curl -X "POST" "http://localhost:4000/v1/events/pipelines/dryrun?pipeline_name=test" \

diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/logs/manage-pipelines.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/logs/manage-pipelines.md
@@ -161,7 +161,9 @@ transform:
 
 ### 调试日志写入
 
-接下来使用一个错误的日志数据来测试，该日志中 message 字段的值为数字类型，这会导致 Pipeline 处理失败。
+我们可以使用 `dryrun` 接口测试 Pipeline。我们将使用错误的日志数据对其进行测试，其中消息字段的值为数字格式，会导致 Pipeline 在处理过程中失败。
+
+**此接口仅仅用于测试 Pipeline 的处理结果，不会将数据写入到 GreptimeDB 中。**
 
 ```bash
 curl -X "POST" "http://localhost:4000/v1/events/pipelines/dryrun?pipeline_name=test" \