lfit / releng-gerrit_to_platform / 25802805456

93%

Build Type

push

github

Committed by ModeSevenIndustrialSolutions

Commit Message

Feat(logging): Add centralised logging framework

Adds gerrit_to_platform._logging, an opt-in logging framework
configured via G2P_LOG_* environment variables or a new [logging]
section in gerrit_to_platform.ini.  The framework owns every
handler, formatter and filter; modules obtain loggers through a
single get_logger() helper.

Default behaviour is unchanged (WARNING to stderr) so existing
deployments at gerrit.linuxfoundation.org continue to behave as
they do today.  Verbose diagnostics, JSON output and a secondary
file sink are purely additive and operator-controlled.

Each hook invocation carries a short URL-safe correlation id
attached to every record as cid=...; an enclosing wrapper (e.g.
the gerrit-action hook wrapper) may seed the id by exporting an
environment variable named in correlation_id_env so the same id
appears in both the wrapper log and the package log.

Hook entry-points (patchset-created, comment-added, change-merged)
now call configure() and emit a structured trace covering hook
entry, event-parse, platform detection, workflow lookup, dispatch
attempt, dispatch result and exit (with elapsed_ms).  The github
client wrapper logs every dispatch and workflows-list call with
timing and outcome.  User-facing print() calls remain in place and
run parallel to the new logging stream.

A RedactingFilter is attached to every handler installed by
configure() and scrubs GitHub token shapes (gh[posr]_...),
Authorization headers, ?token= query-string parameters and
labelled token=/secret=/password= values.  Coverage in
tests/test_logging.py asserts no synthetic token reaches a
handler verbatim, plus precedence (env over INI), idempotent
configure(), broken-file-sink fallback, JSON formatter shape and
schema_version, and per-logger overrides.

The ephemeral gerrit-action and test-deploy-gerrit container
deployments need this so operators can extract per-event traces
from short-lived Docker / GitHub-Actions sandboxes where the only
post-mortem a... (continued)

Coverage Stats

249 of 274 new or added lines in 6 files covered. (90.88%)

14 existing lines in 2 files now uncovered.

516 of 556 relevant lines covered (92.81%)

0.93 hits per line