20955: Typo fixes throughout 20955-log-update-doc
authorBrett Smith <brett.smith@curii.com>
Mon, 18 Sep 2023 02:47:57 +0000 (22:47 -0400)
committerBrett Smith <brett.smith@curii.com>
Mon, 18 Sep 2023 02:50:23 +0000 (22:50 -0400)
* "superceded"→"superseded"
* "via[d] the" repetition
* "database" echoed twice in one sentence
* Link hardcoded to doc.arvados.org→site.baseurl

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

doc/admin/logs-table-management.html.textile.liquid
doc/admin/upgrading.html.textile.liquid

index 0f127831c0be8c74508c8e92a74b3b52be886f9a..2f3aa20fd811de5662288e2724b24ab64a220028 100644 (file)
@@ -14,14 +14,14 @@ This page aims to provide insight about managing the ever growing API Server's l
 
 h3. Logs table purpose & behavior
 
-This database table is accessed viad the via "the @logs@ endpoint.":../api/methods/logs.html
+This database table is accessed via "the @logs@ endpoint.":../api/methods/logs.html
 
 This table currently serves several purposes:
 
 * Audit logging, permitting admins and users to look up the time and details of past changes to Arvados objects.
 * Logging other system events, specifically "file uploads and downloads from keep-web.":restricting-upload-download.html#audit_logs
 * The source for cache-invalidation events, published through websockets to Workbench to refresh the view.  It can also be monitored by the Python SDK "events module.":../sdk/python/events.html
-* Prior to Arvados 2.7, it was used a staging area for stdout/stderr text coming from users' containers, permitting users to see what their containers are doing while they are still running (i.e., before those text files are written to Keep).  Starting with Arvados 2.7, this is superceded by a more efficient mechanism and so these logs are disabled by default.  See "2.7.0 upgrade notes":upgrading.html#v2_7_0 for details.
+* Prior to Arvados 2.7, it was used a staging area for stdout/stderr text coming from users' containers, permitting users to see what their containers are doing while they are still running (i.e., before those text files are written to Keep).  Starting with Arvados 2.7, this is superseded by a more efficient mechanism, so these logs are disabled by default.  See "2.7.0 upgrade notes":upgrading.html#v2_7_0 for details.
 
 As a result, this table grows indefinitely, even on sites where policy does not require an audit log; making backups, migrations, and upgrades unnecessarily slow and painful.
 
index 28a1db1fd6ad03e983cb2c03cc9c5ddaf52a6e5e..9ae8cc9e8d598b4583ed43ba6414103d2bace6aa 100644 (file)
@@ -38,7 +38,7 @@ h2(#v2_7_0). v2.7.0 (2023-09-??)
 
 h3. New system for live container logs
 
-Starting with Arvados 2.7, a new system for fetching live container logs is in place.  This system features significantly reduced database load compared to previous releases.  When Workbench or another application need to access the logs of a process (running or completed), they should use the "log endpoint of container_requests.":https://doc.arvados.org/main/api/methods/container_requests.html which forwards requests to the running container.  This supercedes the previous system where compute processes would send all of their logs to the database, which produced significant database load.
+Starting with Arvados 2.7, a new system for fetching live container logs is in place.  This system features significantly reduced database load compared to previous releases.  When Workbench or another application needs to access the logs of a process (running or completed), they should use the "log endpoint of container_requests":{{ site.baseurl }}/api/methods/container_requests.html which forwards requests to the running container.  This supersedes the previous system where compute processes would send all of their logs to the database, which produced significant load.
 
 The legacy logging system is now disabled by default for all installations with the setting @Containers.Logging.LimitLogBytesForJob: 0@.  If you have an existing Arvados installation where you have customized this value and do not need the legacy container logging system, we recommend removing @LimitLogBytesForJob@ from your configuration.