iotaledger / iota / 30505941318

70%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(iota-rest-kv): refined logs (#12330)

# Description of change

This PR adds more refined logging to the `iota-rest-kv` crate.
Previously the service logs said almost nothing about its operations,
which made debugging difficult.

- Every incoming request is wrapped in a tracing span carrying a unique
`request_id`, the HTTP method, the matched route template, and the full
URI. The `request_id` is generated by the server (or taken from the
client's `x-request-id` header if present) and echoed back in the
response header. This makes it possible to correlate a client-reported
failure with the exact server-side log lines, which is especially handy
under high traffic since axum processes requests concurrently and their
log lines interleave.
- Each request logs one completion line with status code and latency:
`info` for success, `warn` for client errors, `error` for server errors.
`404` stays at `info` since a key miss is a normal outcome for a KV
lookup, not a client mistake.
- Bad request and internal error causes are recorded on the span's
`error` field. Clients still receive only a generic "internal server
error" for 500s; the details stay server-side.
- Handlers log the parsed request parameters at `debug` (item type, key,
number of keys, pagination options).
- Every BigTable call logs a `debug` line with table, column qualifier,
found/missing counts, and elapsed time.
- The level from `--log-level`/`LOG_LEVEL` now acts as the default of an
`EnvFilter`, so `RUST_LOG` can override it with per-module directives
(e.g. `RUST_LOG=iota_rest_kv=debug,iota_bigtable=debug,info`).
- The bumped `iota-bigtable` dependency logs transient gRPC errors at
`warn` on every retry together with the next backoff delay (previously
retries were completely silent), and logs its read/write calls at
`debug`.

> [!NOTE]
> For now we pin the commit hash, once the `iota-bigtable` PR is merged,
a new tag will be created and used in place of the commit hash.

## Links to any... (continued)

Coverage Stats

0 of 59 new or added lines in 4 files covered. (0.0%)

510 existing lines in 37 files now uncovered.

168712 of 245099 relevant lines covered (68.83%)

453638.41 hits per line