Details
-
Improvement
-
Resolution: Won't Fix
-
Critical
-
None
-
5.0
-
DOC-S32-Dec21, DOC-2019-S02-Jan25, DOC-2019-S03-Feb08, DOC-2020-S16-Aug23, DOC-2021-Feb28-S4
-
3
Description
We have https://developer.couchbase.com/documentation/server/current/monitoring/monitoring-n1ql-query.html#story-h2-3 for profiling n1ql queries in 5.0+.
This page covers the REST API and another page covers how it works within the UI, but there's no information covering how to enable N1QL profiling from within the SDK, which honestly is where it's most important.
I understand that it's "just another query setting" which we already document how to change, but it's not obvious from the docs that this one exists.
Further to that profiling is going to be a huge component of performance tuning and monitoring and will compliment tracing nicely.
Therefore we should consider calling it out more obviously in the SDK docs and perhaps even consider promoting it to a more obvious place within the SDK APIs themselves.