Skip to content

Commit ccb452c

Browse files
author
Philip Z
committed
docs: highlight automatic logs for debugging and operations
Signed-off-by: Philip Z <hello@teaql.io>
1 parent 0dde27d commit ccb452c

1 file changed

Lines changed: 30 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ TeaQL gives coding agents business-shaped APIs, model-aware guidance and
66
software checks. People review the business operation instead of reconstructing
77
pages of query-building, relationship-loading and persistence code.
88

9+
Automatic execution logs make those operations easier to debug and operate,
10+
without adding logging statements to every business method.
11+
912
[Try with your coding agent](#try-it-with-your-coding-agent) ·
10-
[Run the local example](#run-the-local-example)
13+
[Run the local example](#run-the-local-example) ·
14+
[See automatic logs](#automatic-logs-without-handwritten-logging-code)
1115

1216
## Why this is an AI native library
1317

@@ -38,7 +42,7 @@ and runtime.
3842
| A composed Q request | SQL construction and selected relation loading |
3943
| An E access path | Loaded-field checks and explicit NULL handling |
4044
| A mutation with an audit reason | Change tracking, Checker and configured Policy execution |
41-
| Intent and execution evidence | Query diagnostics and mutation audit delivery |
45+
| Business intent and audit reason | Automatic execution logs and trace context without per-operation logging code |
4246

4347
Reviewers still decide whether the requested data, business rules and
4448
authorization policy are correct. They have less application plumbing to
@@ -128,11 +132,31 @@ approval emits a warning; it is not automatic rejection. Marking for deletion
128132
stages a change—the audited Save performs it. Atomicity is provider/route scoped,
129133
not a distributed transaction across unrelated databases.
130134

131-
## Execution evidence helps the next development step
135+
## Automatic logs without handwritten logging code
136+
137+
**Debuggability and operability are core design goals.** The Q and Save
138+
examples above contain no logging calls: you declare the business intent,
139+
and the runtime produces the execution diagnostics and trace context.
140+
Configured audit sinks receive change events without each application
141+
method having to construct its own field-level diff.
142+
143+
The intent declarations already belong to the business operation:
144+
145+
- `comment` describes what the query does.
146+
- `purpose` explains why it runs.
147+
- `audit_as` gives the reason for a saved change.
148+
149+
No-code logging means no handwritten logger calls in each business method,
150+
not an application without code or intent declarations. Runtime startup
151+
still configures any required sink; custom formats and destinations use the
152+
logging extension points rather than edits to every business operation.
132153

133-
Logs are useful development context, not just an operations feature. They
134-
help an agent and a reviewer connect the requested behavior with what ran,
135-
and help an operator investigate a production change.
154+
- **Debugging:** connect a query's intent to generated SQL, execution outcome
155+
and the trace path when a screen or business operation behaves unexpectedly.
156+
- **Operations:** follow query and mutation activity and use audit reasons
157+
and safely exposed changes to investigate incidents.
158+
- **Review:** inspect the business operation without separately checking
159+
that every TeaQL execution path has a matching application logging statement.
136160

137161
Query and Mutation diagnostic logs are enabled by default and can be switched
138162
off independently. Logging off does not disable intent validation or Policy.

0 commit comments

Comments
 (0)