[doc] Document event log levels#658
Merged
Merged
Conversation
Document the event log level feature shipped in apache#609 (issue apache#541): - New core options: event-log.level, event-log.type.<EVENT_TYPE>.level, event-log.standard.max-string-length, event-log.standard.max-array-elements, event-log.standard.max-depth. - Event Log section in monitoring.md now describes the JSON layout (including top-level eventType and logLevel), the three levels (OFF / STANDARD / VERBOSE), and the hierarchical per-event-type override resolution. - Built-in event type strings table for quick reference. Closes apache#541
…t notes Additional coverage based on the DESIGN doc (docs/PR-541/541-DESIGN.md): - Document the STANDARD-level truncation wrapper format (truncatedString / truncatedList / truncatedObject + omitted* counters) and note that consumers needing a stable schema should use VERBOSE. - Add a STANDARD-level truncated record example. - Note that fields like timestamp, logLevel, top-level eventType, and the event's id/type/scalar fields are never truncated. - Explain that setting any threshold to 0 disables that truncation, and setting all three to 0 makes STANDARD behave like VERBOSE. - Add eventLogTruncatedEvents to the Event and Action Metrics table. - Add a -D job-submission override example showing how a single type-level override does not clobber the rest of config.yaml. - Compatibility notes: STANDARD-by-default is a behavior change (use VERBOSE to restore), and pre-feature log records still parse.
2 tasks
github-actions
Bot
added
doc-included
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 overrideevent-log.standard.max-string-length,event-log.standard.max-array-elements,event-log.standard.max-depth—STANDARD-level truncation knobs (set to0to disable individually)docs/content/docs/operations/monitoring.md— new Event Log subsections:timestamp/logLevel/eventTypelayout, plus the full event objectOFF/STANDARD/VERBOSE, what is and is not truncated, and the truncation wrapper format (truncatedString/truncatedList/truncatedObjectwithomitted*counters), with a STANDARD-level truncated record example_input_event,_chat_request_event, etc.), hierarchical (Log4j-style) resolution order for dotted user-defined types,config.yamlexample, and-Djob-submission override exampleSTANDARD-by-default is a behavior change vs prior releases (useVERBOSEto restore); pre-feature log records still parseeventLogTruncatedEventscounter rowTests
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-neededdoc-not-neededdoc-included