Idea #20955
closedCrunch log transition documentation issues
Description
From a practical perspective, it seems like Arvados 2.7.0 represents a "flag day" transition from using the old database-backed Crunch logs to using the new WebDAV log API.
- Workbench 2 no longer gets these logs from the database at all, using the new endpoint exclusively.
- With that, I don't believe any client code shipped with Arvados uses the old system anymore.
- The default configuration for
LimitLogBytesForJob
is now0
, which effectively stops Crunch from writing old-system logs.
I think this transition is underdocumented.
- The upgrade notes should explain the transition. If administrators have
LimitLogBytesForJob
configured, they should normally remove that and rely on the default setting. If they have custom client code reading the old logs, they can configure it to a higher value for now, but the old logging system is deprecated and they should work on porting those clients to use the new logging API. - Are there other places in the documentation we should note the deprecation of the old logging system? Maybe in the
logs
API documentation? - The third bullet point on
/doc/admin/logs-table-management.html
should be reframed to explain this is about the old logging system and on its way out. (Even administrators who have upgraded and transitioned to the new logging system may find old logs in their database they're wondering about, so we should leave the explanation in for now.)
Related issues
Updated by Brett Smith about 1 year ago
- Related to Feature #19889: access current container logs at /arvados/v1/containers/{uuid}/log/{filename} added
Updated by Brett Smith about 1 year ago
- Related to Idea #16442: Scalable + reliable container logging added
Updated by Peter Amstutz about 1 year ago
- Release set to 66
- Target version changed from Future to Development 2023-09-27 sprint
Updated by Peter Amstutz about 1 year ago
- Assigned To changed from Tom Clegg to Peter Amstutz
Updated by Peter Amstutz about 1 year ago
20955-log-update-doc @ 56add69a087e8c94f3e8c99fb04501f7f570aaeb
Updated by Peter Amstutz about 1 year ago
- Status changed from New to In Progress
Updated by Brett Smith about 1 year ago
Peter Amstutz wrote in #note-6:
20955-log-update-doc @ 56add69a087e8c94f3e8c99fb04501f7f570aaeb
I noticed a handful of typos. I believe everyone hates shuttling typo fixes over tickets, so I went ahead and pushed an additional commit to the branch to patch them up. If you have any questions about them, please let me know. If they look good to you, then this is good to merge, thanks.
Updated by Peter Amstutz about 1 year ago
Brett Smith wrote in #note-8:
Peter Amstutz wrote in #note-6:
20955-log-update-doc @ 56add69a087e8c94f3e8c99fb04501f7f570aaeb
I noticed a handful of typos. I believe everyone hates shuttling typo fixes over tickets, so I went ahead and pushed an additional commit to the branch to patch them up. If you have any questions about them, please let me know. If they look good to you, then this is good to merge, thanks.
I appreciate that, thank you.
Updated by Peter Amstutz about 1 year ago
- Status changed from In Progress to Resolved