Opened 2 years ago

Last modified 8 weeks ago

#24542 accepted enhancement

Improve logging for Exonerator

Reported by: iwakeh Owned by: karsten
Priority: Medium Milestone:
Component: Metrics/ExoneraTor Version:
Severity: Normal Keywords:
Cc: metrics-team Actual Points:
Parent ID: Points:
Reviewer: irl Sponsor:

Description

When looking at #24534 I noticed there is hardly any useful logging.
Both backend and web-frontend need better logging. The web-part has no logs so far and the logs of the backend consist mainly of one message, which should rather be on debug than info level:

INFO o.t.m.e.QueryServlet:315 Returned a database connection to the pool after 105 millis.

Child Tickets

Change History (4)

comment:1 Changed 2 years ago by karsten

Agreed, logging could be more useful. That's one of the reasons why I wrote this high-level specification of processes behind Tor Metrics which coincidentally covers ExoneraTor. Would you want to review that document and maybe send a new .md file saying what additional log statements we should write in those cases? It might help to lift this discussion to a conceptual level first, also as a means to unify how we're logging across code bases.

comment:2 Changed 3 months ago by karsten

Cc: metrics-team added
Reviewer: irl
Status: newneeds_review

We should move this forward, not only in ExoneraTor but also in our other code bases. Let's start here. Please review commit 54ad288 in my task-24542 branch. Maybe imagine being the backup operator of the ExoneraTor service and having to debug a problem using these logs while I'm on vacation.

comment:3 Changed 8 weeks ago by irl

Status: needs_reviewmerge_ready

Yes, these log messages look helpful. I don't know what the coverage would be now for helpful log messages (maybe it's complete) now but this is certainly a step in the correct direction.

comment:4 Changed 8 weeks ago by karsten

Owner: changed from metrics-team to karsten
Status: merge_readyaccepted

Great, thanks for looking! Merged. The coverage is roughly 1/2 of the ExoneraTor code with the updater being complete now and the server not being started. Changing status to accepted for the remaining changes.

Note: See TracTickets for help on using tickets.