1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# Copyright (C) 2022-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
global:
cpp_namespace: "mongo::analyze_shard_key"
imports:
- "mongo/db/basic_types.idl"
enums:
QueryAnalyzerMode:
description: "The query analysis mode for a collection."
type: string
values:
kFull: "full"
kOff: "off"
SampledCommandName:
description: "The command name of a sampled read and write query."
type: string
values:
kFind: "find"
kAggregate: "aggregate"
kCount: "count"
kDistinct: "distinct"
kInsert: "insert"
kUpdate: "update"
kDelete: "delete"
kFindAndModify: "findAndModify"
structs:
QueryAnalyzerConfiguration:
description: "The query analyzer configuration for a collection as configured via the
configureQueryAnalyzer command."
strict: false
fields:
mode:
type: QueryAnalyzerMode
description: "The query analyzer mode."
sampleRate:
type: double
description: "The maximum number of queries to sample per second, in total across the
cluster (not per mongos or mongod)."
optional: true
CollectionQueryAnalyzerConfiguration:
description: "The query analyzer configuration for a collection as returned by the
_refreshQueryAnalyzerConfiguration command."
strict: false
fields:
ns:
type: namespacestring
description: "The namespace of the collection."
collectionUuid:
type: uuid
description: "The UUID of the collection."
sampleRate:
type: double
description: "The maximum number of queries to sample per second."
startTime:
type: date
description: "The time at which query sampling began."
CollectionSampleCountersCurrentOp:
description: "The per-collection report on number and size of sampled queries for the currentOp
command."
strict: false
fields:
desc:
type: string
description: "The string identifier for the query sampling currentOp document."
default: '"query analyzer"'
ns:
type: namespacestring
description: "The namespace of the collection."
collUuid:
type: uuid
description: "The UUID of the collection."
optional: true
sampleRate:
type: double
description: "The maximum number of queries to sample per second. Only reported by mongos."
optional: true
startTime:
type: date
description: "The time at which query sampling began."
sampledReadsCount:
type: long
description: "The number of read queries sampled."
sampledReadsBytes:
type: long
description: "The number of bytes stored for sampled read queries. Only reported by mongod."
optional: true
sampledWritesCount:
type: long
description: "The number of write queries sampled."
sampledWritesBytes:
type: long
description: "The number of bytes stored for sampled write queries. Only reported by mongod."
optional: true
QueryAnalysisServerStatus:
description: "The server-wide report on the number of sampled queries for the serverStatus
command."
strict: false
fields:
activeCollections:
type: long
description: "The number of collections that are actively being sampled."
totalCollections:
type: long
description: "The total number of collections that have been sampled."
totalSampledReadsCount:
type: long
description: "The total number of sampled read queries."
totalSampledWritesCount:
type: long
description: "The total number of sampled write queries."
totalSampledReadsBytes:
type: long
description: "The total number of bytes stored for sampled read queries."
optional: true
totalSampledWritesBytes:
type: long
description: "The total number of bytes stored for sampled write queries."
optional: true
|
