Structured Event Logging Specification

[DokaIzk]

Title: docs: document structured logging format and standards

Labels: documentation logging
Complexity: trivial

Description:
Document the structured logging format used throughout the codebase. Include:

• Field naming conventions
• Log level usage guidelines
• Error logging standards
• Sensitive data masking rules

Acceptance Criteria:

• Logging specification document created
• Examples for each log type
• Guidelines for new code
• Linked from contributing guide

---

[Shackole]

@Shackole has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I'd like to take this one. I'll review how logging is actually used across the codebase and write it up clearly: naming conventions, when to use each log level, how errors should be logged, and rules for masking sensitive data. I'll include a concrete example for each log type, add a short guideline section for contributors writing new code, and link the doc from the contributing guide so it's easy to find.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Shackole to this issue.

[trinnode]

@trinnode has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hello Maintainer! Can I work on this issue!
Thank you

ℹ️ Repo Maintainers: To accept this application, review their application or assign @trinnode to this issue.

[drips-wave]

Congratulations, @trinnode! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @trinnode: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[drips-wave]

This issue has been marked as completed by a Drips Wave moderator for @trinnode as part of the Stellar Wave Program's 8th Wave 🥳

Moderator's reason: [Auto-assessed] The PR was successfully merged by maintainers (mergedAt: 2026-08-29T20:38:54Z) and fully implements structured logging documentation as requested in Issue #1297.

😎 @trinnode: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here.

🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

ℹ️ Note: This issue was marked complete via moderation. Points were issued even though the GitHub issue remains open.