docs: clarify descriptions for tracing cluster settings #81468
Conversation
|
This change is |
There was a problem hiding this comment.
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @arulajmani and @michae2)
pkg/sql/exec_util.go line 240 at r1 (raw file):
"sql.trace.stmt.enable_threshold", "enables tracing on all statements; statements executing for longer than "+ "this duration will have their trace recorded (set to 0 to disable); "+
"recorded" means something else in the context of tracing. When this setting is active, all traces are recorded. Talk about logging.
There was a problem hiding this comment.
Reviewable status:
pkg/sql/exec_util.go line 240 at r1 (raw file):
Previously, andreimatei (Andrei Matei) wrote…
"recorded" means something else in the context of tracing. When this setting is active, all traces are recorded. Talk about logging.
Done.
There was a problem hiding this comment.
Reviewable status:
pkg/sql/exec_util.go line 226 at r2 (raw file):
"enables tracing on all transactions; transactions open for longer than "+ "this duration will have their trace logged (set to 0 to disable); "+ "note that enabling this may have a non-trivial negative performance "+
nit: I'd strike "non-trivial"
The descriptions for sql.trace.txn.enable_threshold and sql.trace.stmt.enable_threshold suggested that tracing was only enabled for transactions and statements longer than the threshold duration. This is not true, however: tracing is enabled for everything, and only _logged_ for transactions and statements longer than the threshold duration. Make this clear in the descriptions. Also make the description for sql.trace.session_eventlog.enabled a "single" sentence to match the style of other descriptions. Release note: None
There was a problem hiding this comment.
Reviewable status:
pkg/sql/exec_util.go line 226 at r2 (raw file):
Previously, andreimatei (Andrei Matei) wrote…
nit: I'd strike "non-trivial"
Done.
|
You're welcome! Thanks for reviewing! bors r=andreimatei,arulajmani |
|
Build succeeded: |
|
Encountered an error creating backports. Some common things that can go wrong:
You might need to create your backport manually using the backport tool. error creating merge commit from 381c3c4 to blathers/backport-release-21.2-81468: POST https://api.github.com/repos/cockroachdb/cockroach/merges: 409 Merge conflict [] you may need to manually resolve merge conflicts with the backport tool. Backport to branch 21.2.x failed. See errors above. 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is otan. |
The descriptions for sql.trace.txn.enable_threshold and
sql.trace.stmt.enable_threshold suggested that tracing was only enabled
for transactions and statements longer than the threshold duration. This
is not true, however: tracing is enabled for everything, and only
logged for transactions and statements longer than the threshold
duration. Make this clear in the descriptions. Also make the description
for sql.trace.session_eventlog.enabled a "single" sentence to match the
style of other descriptions.
Release note: None