Skip to content

Commit fe53740

Browse files
committed
docs: adding note to describe the use of follower reads in metric collection
1 parent 9201951 commit fe53740

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ LIMIT
3030

3131
The Prometheus collectors will add additional labels to track the cluster name as well as the instance where the metrics are coming from.
3232

33+
> Note: All queries executed to retrieve metrics are run on a **read-only connection** with follower reads enabled by default (`SET default_transaction_use_follower_reads = 'true'`). Follower reads allow queries to be served by replicas that are not necessarily the leaseholder, using slightly historical data (typically up to a few seconds old). This approach minimizes the risk of creating contention or adding load on the primary leaseholder replicas, ensuring that metric collection does not interfere with the performance of foreground workloads.
34+
3335
## Database Security
3436

3537
It is recommended to use separate users for managing the configuration and to run the sidecar.

0 commit comments

Comments
 (0)