chore(engine): add runtime environment variables section to README (#678

)
reearth · Dec 6, 2024 · d0d6387 · d0d6387
1 parent 15cf563
commit d0d6387
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/engine/README.md b/engine/README.md
@@ -130,6 +130,18 @@ export FLOW_VAR_cityGmlPath="file:///root/53395658_bldg_6697_op.gml"
 export FLOW_VAR_targetPackages='["bldg", "fld"]'
 ```
 
+### Runtime Environment Variables
+| Name                                 | Description                                                        | Default |
+|--------------------------------------|--------------------------------------------------------------------|---------|
+| FLOW_RUNTIME_ACTION_LOG_DISABLE      | Whether to disable the Action log                                  | false   |
+| FLOW_RUNTIME_CHANNEL_BUFFER_SIZE     | Buffer size for channels exchanged by worker threads               | 256     |
+| FLOW_RUNTIME_EVENT_HUB_CAPACITY      | Capacity size of event hub channels                                | 8192    |
+| FLOW_RUNTIME_THREAD_POOL_SIZE        | Worker thread pool size                                            | 30      |
+| FLOW_RUNTIME_FEATURE_FLUSH_THRESHOLD | Sink node flush threadshold size                                   | 512     |
+| FLOW_RUNTIME_WORKER_NUM              | Worker number                                                      | 100     |
+| FLOW_RUNTIME_FEATURE_WRITER_DISABLE  | Whether to disable the ability to export data to the feature store | false   |
+| FLOW_RUNTIME_SLOW_ACTION_THRESHOLD   | Threshold for writing slow action logs(ms)                         | 300     |
+
 ## Usage
 
 ### Run workflow