weiqingy opened a new pull request, #658:
URL: https://github.com/apache/flink-agents/pull/658

   Linked issue: #541
   
   ### Purpose of change
   
   Documentation follow-up to #609 — that PR shipped the per-event-type 
configurable event log levels, but the user-facing docs were not updated. 
Reviewer asked that docs be supplemented before closing #541.
   
   This PR documents:
   
   **`docs/content/docs/operations/configuration.md`** — five new rows in the 
Core Options table:
   
   - `event-log.level` — global default (`OFF` / `STANDARD` / `VERBOSE`)
   - `event-log.type.<EVENT_TYPE>.level` — per-event-type override
   - `event-log.standard.max-string-length`, 
`event-log.standard.max-array-elements`, `event-log.standard.max-depth` — 
`STANDARD`-level truncation knobs (set to `0` to disable individually)
   
   **`docs/content/docs/operations/monitoring.md`** — new Event Log subsections:
   
   - **JSON Format** — top-level `timestamp` / `logLevel` / `eventType` layout, 
plus the full event object
   - **Event Log Levels** — semantics of `OFF` / `STANDARD` / `VERBOSE`, what 
is and is not truncated, and the truncation wrapper format (`truncatedString` / 
`truncatedList` / `truncatedObject` with `omitted*` counters), with a 
STANDARD-level truncated record example
   - **Per-event-type log levels** — reference table of built-in event type 
routing strings (`_input_event`, `_chat_request_event`, etc.), hierarchical 
(Log4j-style) resolution order for dotted user-defined types, `config.yaml` 
example, and `-D` job-submission override example
   - **Compatibility Notes** — `STANDARD`-by-default is a behavior change vs 
prior releases (use `VERBOSE` to restore); pre-feature log records still parse
   - **Event and Action Metrics** — new `eventLogTruncatedEvents` counter row
   
   ### Tests
   
   Docs-only change — no executable changes. Verified all referenced config 
keys, defaults, JSON field names, truncation wrapper shapes, and metric names 
against the code shipped in #609 (`AgentConfigOptions`, `EventLogLevel`, 
`EventLogLevelResolver`, `FileEventLogger`, `EventLogRecordJsonSerializer`, 
`EventLogRecordJsonDeserializer`, `JsonTruncator`, `BuiltInMetrics`).
   
   ### API
   
   No API change.
   
   ### Documentation
   
   - [ ] `doc-needed`
   - [ ] `doc-not-needed`
   - [x] `doc-included`
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to