feat: structured logging helpers + get_issue instrumentation (#14) #24

Merged

Latte merged 2 commits from feat/get-issue-debug-logging into dev 2026-06-22 15:09:59 +00:00

Conversation 0 Commits 2 Files Changed 5

+285 -2

Bartender commented 2026-06-22 13:13:05 +00:00

Owner

Copy Link

Copy Source

Closes #14.

Adds reusable, secret-safe structured-logging helpers and instruments get_issue so nullable-field parsing (the class of failure behind #13) is diagnosable.

Helpers (logging_utils)

• log_event(logger, level, event, **context) — emit a named event with a context mapping; keys in SENSITIVE_CONTEXT_KEYS (token, authorization, password, …) are masked as ***.
• log_nullable_field(logger, event, field, value) — record whether a parsed field is None plus its runtime type, without dumping contents.
• sanitize_context(...) — shared masking primitive.
• The JSON formatter now serializes a record's context into the payload.

Instrumentation

• get_issue_tool emits get_issue.start, get_issue.payload_shape, and get_issue.field_check (labels/assignees/user) at DEBUG. Silent unless LOG_LEVEL=DEBUG.

Scope note

log_exception from the issue's suggestion was intentionally omitted: logging an exception message conflicts with the project's "no exception-detail leakage" posture, so only the exception type is ever logged (unchanged behaviour).

Tests & docs

• New tests/test_logging_utils.py: helpers, masking, formatter context, and the get_issue instrumentation.
• docs/observability.md documents the pattern and its reuse for other parsing-heavy endpoints.

Closes #14. Adds reusable, secret-safe structured-logging helpers and instruments `get_issue` so nullable-field parsing (the class of failure behind #13) is diagnosable. ## Helpers (`logging_utils`) - `log_event(logger, level, event, **context)` — emit a named event with a `context` mapping; keys in `SENSITIVE_CONTEXT_KEYS` (`token`, `authorization`, `password`, …) are masked as `***`. - `log_nullable_field(logger, event, field, value)` — record whether a parsed field is `None` plus its runtime type, without dumping contents. - `sanitize_context(...)` — shared masking primitive. - The JSON formatter now serializes a record's `context` into the payload. ## Instrumentation - `get_issue_tool` emits `get_issue.start`, `get_issue.payload_shape`, and `get_issue.field_check` (labels/assignees/user) at `DEBUG`. Silent unless `LOG_LEVEL=DEBUG`. ## Scope note `log_exception` from the issue's suggestion was intentionally omitted: logging an exception *message* conflicts with the project's "no exception-detail leakage" posture, so only the exception *type* is ever logged (unchanged behaviour). ## Tests & docs - New `tests/test_logging_utils.py`: helpers, masking, formatter context, and the `get_issue` instrumentation. - `docs/observability.md` documents the pattern and its reuse for other parsing-heavy endpoints.

Latte added 1 commit 2026-06-22 13:41:09 +00:00

feat: add structured logging helpers and instrument get_issue (#14) ... f53e1a3a5a

Adds reusable, secret-safe logging helpers to `logging_utils`:
- `log_event(logger, level, event, **context)` emits a named event with a
  sanitized `context` mapping (sensitive keys masked as `***`).
- `log_nullable_field(...)` records whether a parsed field is None plus its
  runtime type, without dumping its contents.
- `sanitize_context(...)` is the shared masking primitive.

The JSON formatter now serializes a record's `context` into the payload.

`get_issue_tool` is instrumented at DEBUG (`get_issue.start`,
`get_issue.payload_shape`, `get_issue.field_check` for labels/assignees/user)
so the nullable-field parsing that caused #13 is diagnosable going forward.

Adds tests for the helpers, the formatter, and the get_issue instrumentation,
and documents the pattern in docs/observability.md.

Latte force-pushed feat/get-issue-debug-logging from baacd9e9b5 to f53e1a3a5a 2026-06-22 13:41:09 +00:00 Compare

Latte added 1 commit 2026-06-22 13:59:22 +00:00

test: cover write-tool auth and backend error branches ... 538d6d964a

Every write tool's `except (Auth...)` re-raise and `except GiteaError ->
RuntimeError` wrapping was previously untested, leaving write_tools at 60%
coverage and the repo below the 80% gate. Adds parametrized error-path tests
for all 15 write tools (backend error wrapping + auth propagation), raising
write_tools coverage to 99% and total coverage above the gate.

Latte merged commit 10a307ac02 into dev 2026-06-22 15:09:59 +00:00

Latte deleted branch feat/get-issue-debug-logging 2026-06-22 15:09:59 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

Compat/Breaking

Breaking change, not backwards compatible

Kind/Bug

Something is not working

Kind/Chore

Maintenance, deps, CI/CD

Kind/Documentation

Documentation changes

Kind/Enhancement

Improve existing functionality

Kind/Feature

New functionality

Kind/Refactor

Code restructuring, no behavior change

Kind/Security

Security-related issue

Priority/Critical

Must be addressed immediately

Priority/High

Important, address soon

Priority/Low

Nice to have

Priority/Medium

Normal priority

Reviewed/Confirmed

Issue has been confirmed

Reviewed/Duplicate

Already tracked elsewhere

Reviewed/Won't Fix

Acknowledged but won't be addressed

Status/Blocked

Blocked by an external dependency

Status/In Progress

Currently being worked on

Status/Need More Info

Needs more information to proceed

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

Bartender (Bartender) Latte (Latte)

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Hiddenden/AegisGitea-MCP#24