summaryrefslogtreecommitdiff
path: root/src/mongo/s/analyze_shard_key_cmd.idl
diff options
context:
space:
mode:
authorCheahuychou Mao <mao.cheahuychou@gmail.com>2022-12-15 18:52:00 +0000
committerEvergreen Agent <no-reply@evergreen.mongodb.com>2022-12-16 11:31:40 +0000
commitb7d1b4b8b5c2290d0faa6557cab3d8d08af2283c (patch)
tree30980af51ca9613680165425af25e561296b3ba5 /src/mongo/s/analyze_shard_key_cmd.idl
parent49a208dc8950dfcc85ee65e85fb725be80dd4aba (diff)
downloadmongo-b7d1b4b8b5c2290d0faa6557cab3d8d08af2283c.tar.gz
SERVER-72031 Support calculating read distribution metrics from sampled read queries
Diffstat (limited to 'src/mongo/s/analyze_shard_key_cmd.idl')
-rw-r--r--src/mongo/s/analyze_shard_key_cmd.idl65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/mongo/s/analyze_shard_key_cmd.idl b/src/mongo/s/analyze_shard_key_cmd.idl
index 8105f23d5a0..9e681232857 100644
--- a/src/mongo/s/analyze_shard_key_cmd.idl
+++ b/src/mongo/s/analyze_shard_key_cmd.idl
@@ -96,6 +96,71 @@ structs:
validator: { gte: 0 }
optional: true
+ ReadSampleSize:
+ description: "The number of sampled read queries by command name."
+ strict: false
+ fields:
+ total:
+ type: long
+ default: 0
+ find:
+ type: long
+ default: 0
+ aggregate:
+ type: long
+ default: 0
+ count:
+ type: long
+ default: 0
+ distinct:
+ type: long
+ default: 0
+
+ WriteSampleSize:
+ description: "The number of sampled write queries by command name."
+ strict: false
+ fields:
+ total:
+ type: long
+ default: 0
+ update:
+ type: long
+ default: 0
+ delete:
+ type: long
+ default: 0
+ findAndModify:
+ type: long
+ default: 0
+
+ ReadDistributionMetrics:
+ description: "The metrics about the read distribution calculated using sampled read queries."
+ strict: true
+ fields:
+ sampleSize:
+ type: ReadSampleSize
+ numReadsTargetedOneShard:
+ type: long
+ cpp_name: numTargetedOneShard
+ validator: { gte: 0 }
+ optional: true
+ numReadsTargetedMultipleShards:
+ type: long
+ cpp_name: numTargetedMultipleShards
+ validator: { gte: 0 }
+ optional: true
+ numReadsTargetedAllShards:
+ type: long
+ cpp_name: numTargetedAllShards
+ validator: { gte: 0 }
+ optional: true
+ numDispatchedReadsByRange:
+ type: array<long>
+ cpp_name: numDispatchedByRange
+ description: "The number of dispatched read requests for each chunk range sorted from
+ MinKey to MaxKey."
+ optional: true
+
analyzeShardKeyResponse:
description: "The response for the 'analyzeShardKey' command."
strict: false