docs(auditlog_ng): update user-guide - #329
Merged
Merged
Conversation
- fold Overview into intro; drop duplicate section - normalize headings to Title Case; drop stray trailing colon - replace ✅/❌ with plain Yes/No in config tables - correct config-path precedence ordering (config > tenant > kwargs) - fix Validation section: ValidationError for schema failures, RuntimeError for closed client; remove nonexistent tenant_id UUID-validation claim - remove duplicate Import section and idiosyncratic 'Running the Unit Tests' section
jplbrun
force-pushed
the
docs/update-auditlog_ng-guide
branch
from
September 11, 2026 22:23
3375af8 to
1a77994
Compare
15 tasks
jplbrun
marked this pull request as ready for review
September 14, 2026 12:35
NicoleMGomes
approved these changes
Sep 14, 2026
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
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.
Description
Reworks the
auditlog_nguser guide (src/sap_cloud_sdk/core/auditlog_ng/user-guide.md) so it follows the conventions used by the other module user guides, and corrects several statements that did not match the actual client behavior.Structure aligned to the house convention
# Audit Log NG User Guideand merged the redundantOverviewinto the single intro paragraph.Prerequisites→Installation, added aQuick Startsection (minimalcreate_client(tenant=...)→ build event →send()→close()), and grouped the walkthrough, full example, one-off sends, serialization table, and auto-injection under a singleUsagesection.Yes/No, and dropped the duplicate import block and the module-specificRunning the Unit Testssection.Corrected content (verified against the code)
Validationsection replaced with anError Handlingsection that lists the exceptionssend()actually raises:ValidationErroron schema failure (subclass ofAuditLogNGError),ValueErrorfor an invalidcommon.tenant_id, andRuntimeErroron a closed client. The previous text incorrectly claimed atenant_idUUID check and used the wrong exception types.config=→tenant→ explicit kwargs).[a-zA-Z0-9._/~-]) to the pattern compiled inconfig.py.Recommended setup updated
bootstrap(app)as the recommended way to wire IAS context + telemetry for new apps, withStarletteIASTelemetryMiddlewareretained under aLegacysubsection for apps not yet onbootstrap().Related Issue
N/A
Type of Change
How to Test
src/sap_cloud_sdk/core/auditlog_ng/user-guide.mdand read it top to bottomChecklist
Breaking Changes
N/A
Additional Notes
None