15167: Adds mention about unlogged_attributes setting on Admin docs section.
authorLucas Di Pentima <ldipentima@veritasgenetics.com>
Tue, 30 Apr 2019 14:57:57 +0000 (11:57 -0300)
committerLucas Di Pentima <ldipentima@veritasgenetics.com>
Tue, 30 Apr 2019 14:57:57 +0000 (11:57 -0300)
Also, fixes discrepancies on minimum max_audit_log_age values.

Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <ldipentima@veritasgenetics.com>

doc/admin/logs-table-management.html.textile.liquid
lib/config/config.default.yml

index dedd960f883f5c768017a771f17dc54403342053..a1cdb18dcf49f154a2177012b26982ba3754af7b 100644 (file)
@@ -25,11 +25,24 @@ h3. API Server configuration
 
 To solve the problem mentioned above, the API server offers the possibility to limit the amount of log information stored on the table:
 
+<pre>
+# Attributes to suppress in events and audit logs.  Notably,
+# specifying ["manifest_text"] here typically makes the database
+# smaller and faster.
+#
+# Warning: Using any non-empty value here can have undesirable side
+# effects for any client or component that relies on event logs.
+# Use at your own risk.
+unlogged_attributes: []
+</pre>
+
+The above setting affects all events being logged, independently of how much time they will be kept on the database.
+
 <pre>
 # Time to keep audit logs (a row in the log table added each time an
 # Arvados object is created, modified, or deleted) in the PostgreSQL
 # database. Currently, websocket event notifications rely on audit
-# logs, so this should not be set lower than 600 (10 minutes).
+# logs, so this should not be set lower than 300 (5 minutes).
 max_audit_log_age: 1209600
 </pre>
 
index bea6387532f0d5ac476b82858ac46171162a0e06..5689ba1a0924982b740b366001f89eac41481718 100644 (file)
@@ -158,7 +158,7 @@ Clusters:
       # Arvados object is created, modified, or deleted.)
       #
       # Currently, websocket event notifications rely on audit logs, so
-      # this should not be set lower than 600 (5 minutes).
+      # this should not be set lower than 300 (5 minutes).
       MaxAge: 1209600
 
       # Maximum number of log rows to delete in a single SQL transaction.