Skip to content

Commit 7d04999

Browse files
korawicakorawica
committed
📄 docs: update readme file.
1 parent 16dd1b9 commit 7d04999

File tree

3 files changed

+31
-43
lines changed

3 files changed

+31
-43
lines changed

‎README.md‎

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -118,19 +118,6 @@ For comprehensive API documentation, examples, and best practices:
118118
- **[Full Documentation](https://ddeutils.github.io/ddeutil-workflow/)** - Complete user guide and API reference
119119
- **[Getting Started](https://ddeutils.github.io/ddeutil-workflow/getting-started/)** - Quick start guide
120120
- **[API Reference](https://ddeutils.github.io/ddeutil-workflow/api/workflow/)** - Detailed API documentation
121-
- **[Optimized Tracing](docs/optimized-tracing.md)** - High-performance logging system (2-5x faster)
122-
123-
## ⚡ Performance Improvements
124-
125-
The workflow system now includes an optimized tracing system that provides significant performance improvements:
126-
127-
- **🚀 2-5x faster logging** with buffered I/O operations
128-
- **💾 60-80% reduction** in disk I/O operations
129-
- **🛡️ Built-in thread safety** with minimal overhead
130-
- **🔄 Backward compatible** - existing code automatically benefits
131-
- **📊 Lower memory footprint** for high-volume logging
132-
133-
See [Optimized Tracing Documentation](docs/optimized-tracing.md) for details and performance benchmarks.
134121

135122
## 🎯 Usage
136123

@@ -266,21 +253,21 @@ it will use default value and do not raise any error to you.
266253
> The config value that you will set on the environment should combine with
267254
> prefix, component, and name which is `WORKFLOW_{component}_{name}` (Upper case).
268255
269-
| Name | Component | Default | Description |
270-
|:-----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
271-
| **REGISTRY_CALLER** | CORE | `.` | List of importable string for the call stage. |
272-
| **REGISTRY_FILTER** | CORE | `ddeutil.workflow.templates` | List of importable string for the filter template. |
273-
| **CONF_PATH** | CORE | `./conf` | The config path that keep all template `.yaml` files. |
274-
| **STAGE_DEFAULT_ID** | CORE | `false` | A flag that enable default stage ID that use for catch an execution output. |
275-
| **GENERATE_ID_SIMPLE_MODE** | CORE | `true` | A flog that enable generating ID with `md5` algorithm. |
276-
| **DEBUG_MODE** | LOG | `true` | A flag that enable logging with debug level mode. |
277-
| **TIMEZONE** | LOG | `Asia/Bangkok` | A Timezone string value that will pass to `ZoneInfo` object. |
278-
| **FORMAT** | LOG | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format. |
279-
| **FORMAT_FILE** | LOG | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})` | A trace message format that use to write to target pointer. |
280-
| **DATETIME_FORMAT** | LOG | `%Y-%m-%d %H:%M:%S` | A datetime format of the trace log. |
281-
| **TRACE_HANDLERS** | LOG | `[{"type": "console"}]` | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default. |
282-
| **AUDIT_URL** | LOG | `file:./audits` | A pointer URL of audit log that use to write audit metrix. |
283-
| **AUDIT_ENABLE_WRITE** | LOG | `true` | A flag that enable writing audit log after end execution in the workflow release step. |
256+
| Name | Component | Default | Description |
257+
|:----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
258+
| **REGISTRY_CALLER** | CORE | `.` | List of importable string for the call stage. |
259+
| **REGISTRY_FILTER** | CORE | `ddeutil.workflow.templates` | List of importable string for the filter template. |
260+
| **CONF_PATH** | CORE | `./conf` | The config path that keep all template `.yaml` files. |
261+
| **STAGE_DEFAULT_ID** | CORE | `false` | A flag that enable default stage ID that use for catch an execution output. |
262+
| **GENERATE_ID_SIMPLE_MODE** | CORE | `true` | A flog that enable generating ID with `md5` algorithm. |
263+
| **DEBUG_MODE** | LOG | `true` | A flag that enable logging with debug level mode. |
264+
| **TIMEZONE** | LOG | `Asia/Bangkok` | A Timezone string value that will pass to `ZoneInfo` object. |
265+
| **FORMAT** | LOG | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format. |
266+
| **FORMAT_FILE** | LOG | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})` | A trace message format that use to write to target pointer. |
267+
| **DATETIME_FORMAT** | LOG | `%Y-%m-%d %H:%M:%S` | A datetime format of the trace log. |
268+
| **TRACE_HANDLERS** | LOG | `[{"type": "console"}]` | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default. |
269+
| **AUDIT_CONF** | LOG | `{"type": "file", "path": "./audits"}` | A pointer URL of audit log that use to write audit metrix. |
270+
| **AUDIT_ENABLE_WRITE** | LOG | `true` | A flag that enable writing audit log after end execution in the workflow release step. |
284271

285272
## :rocket: Deployment
286273

‎docs/configuration.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ The main configuration that use to dynamic changing with your objective of this
1414
application. If any configuration values do not set yet, it will use default value
1515
and do not raise any error to you.
1616

17-
| Name | Component | Default | Description |
18-
|:-----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
19-
| **REGISTRY_CALLER** | CORE | `.` | List of importable string for the call stage. |
20-
| **REGISTRY_FILTER** | CORE | `ddeutil.workflow.templates` | List of importable string for the filter template. |
21-
| **CONF_PATH** | CORE | `./conf` | The config path that keep all template `.yaml` files. |
22-
| **STAGE_DEFAULT_ID** | CORE | `false` | A flag that enable default stage ID that use for catch an execution output. |
23-
| **GENERATE_ID_SIMPLE_MODE** | CORE | `true` | A flog that enable generating ID with `md5` algorithm. |
24-
| **DEBUG_MODE** | LOG | `true` | A flag that enable logging with debug level mode. |
25-
| **TIMEZONE** | LOG | `Asia/Bangkok` | A Timezone string value that will pass to `ZoneInfo` object. |
26-
| **FORMAT** | LOG | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format. |
27-
| **FORMAT_FILE** | LOG | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})` | A trace message format that use to write to target pointer. |
28-
| **DATETIME_FORMAT** | LOG | `%Y-%m-%d %H:%M:%S` | A datetime format of the trace log. |
29-
| **TRACE_HANDLERS** | LOG | `[{"type": "console"}]` | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default. |
30-
| **AUDIT_URL** | LOG | `file:./audits` | A pointer URL of audit log that use to write audit metrix. |
31-
| **AUDIT_ENABLE_WRITE** | LOG | `true` | A flag that enable writing audit log after end execution in the workflow release step. |
17+
| Name | Component | Default | Description |
18+
|:----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
19+
| **REGISTRY_CALLER** | CORE | `.` | List of importable string for the call stage. |
20+
| **REGISTRY_FILTER** | CORE | `ddeutil.workflow.templates` | List of importable string for the filter template. |
21+
| **CONF_PATH** | CORE | `./conf` | The config path that keep all template `.yaml` files. |
22+
| **STAGE_DEFAULT_ID** | CORE | `false` | A flag that enable default stage ID that use for catch an execution output. |
23+
| **GENERATE_ID_SIMPLE_MODE** | CORE | `true` | A flog that enable generating ID with `md5` algorithm. |
24+
| **DEBUG_MODE** | LOG | `true` | A flag that enable logging with debug level mode. |
25+
| **TIMEZONE** | LOG | `Asia/Bangkok` | A Timezone string value that will pass to `ZoneInfo` object. |
26+
| **FORMAT** | LOG | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format. |
27+
| **FORMAT_FILE** | LOG | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})` | A trace message format that use to write to target pointer. |
28+
| **DATETIME_FORMAT** | LOG | `%Y-%m-%d %H:%M:%S` | A datetime format of the trace log. |
29+
| **TRACE_HANDLERS** | LOG | `[{"type": "console"}]` | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default. |
30+
| **AUDIT_CONF** | LOG | `{"type": "file", "path": "./audits"}` | A pointer URL of audit log that use to write audit metrix. |
31+
| **AUDIT_ENABLE_WRITE** | LOG | `true` | A flag that enable writing audit log after end execution in the workflow release step. |
3232

3333
## Execution Override
3434

‎tests/utils.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ def dotenv_setting() -> None:
3939
WORKFLOW_CORE_STAGE_DEFAULT_ID=true
4040
WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE=true
4141
WORKFLOW_LOG_TIMEZONE=Asia/Bangkok
42+
WORKFLOW_LOG_AUDIT_CONF='{{"type": "file", "path": "./audits"}}'
4243
WORKFLOW_LOG_AUDIT_ENABLE_WRITE=true
4344
WORKFLOW_LOG_TRACE_HANDLERS='[{{"type": "console"}}]'
4445
"""

0 commit comments

Comments
 (0)