Project

General

Profile

Actions

Idea #20955

closed

Crunch log transition documentation issues

Added by Brett Smith 6 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Story points:
-
Release relationship:
Auto

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 now 0, 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.)

Subtasks 1 (0 open1 closed)

Task #20960: Review 20955-log-update-doc ResolvedPeter Amstutz09/15/2023Actions

Related issues

Related to Arvados - Feature #19889: access current container logs at /arvados/v1/containers/{uuid}/log/{filename}ResolvedTom Clegg03/23/2023Actions
Related to Arvados Epics - Idea #16442: Scalable + reliable container loggingResolved03/15/202308/31/2023Actions
Actions #1

Updated by Brett Smith 6 months ago

  • Related to Feature #19889: access current container logs at /arvados/v1/containers/{uuid}/log/{filename} added
Actions #2

Updated by Brett Smith 6 months ago

  • Related to Idea #16442: Scalable + reliable container logging added
Actions #3

Updated by Peter Amstutz 6 months ago

  • Release set to 66
  • Target version changed from Future to Development 2023-09-27 sprint
Actions #4

Updated by Peter Amstutz 6 months ago

  • Assigned To set to Tom Clegg
Actions #5

Updated by Peter Amstutz 6 months ago

  • Assigned To changed from Tom Clegg to Peter Amstutz
Actions #7

Updated by Peter Amstutz 6 months ago

  • Status changed from New to In Progress
Actions #8

Updated by Brett Smith 6 months 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.

Actions #9

Updated by Peter Amstutz 6 months 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.

Actions #10

Updated by Peter Amstutz 6 months ago

  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF