Skip to content

Commit 72a9c17

Browse files
committed
Add missing javadoc to MongodbObservation and MongodbObservationContext
JAVA-6197
1 parent 91c312c commit 72a9c17

2 files changed

Lines changed: 147 additions & 0 deletions

File tree

driver-core/src/main/com/mongodb/observability/micrometer/MongodbObservation.java

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ public KeyName[] getLowCardinalityKeyNames() {
8989
*/
9090
public enum TransactionLowCardinalityKeyNames implements KeyName {
9191

92+
/**
93+
* The database system name ({@code db.system.name}).
94+
*/
9295
SYSTEM {
9396
@Override
9497
public String asString() {
@@ -102,30 +105,45 @@ public String asString() {
102105
*/
103106
public enum OperationLowCardinalityKeyNames implements KeyName {
104107

108+
/**
109+
* The database system name ({@code db.system.name}).
110+
*/
105111
SYSTEM {
106112
@Override
107113
public String asString() {
108114
return "db.system.name";
109115
}
110116
},
117+
/**
118+
* The database namespace ({@code db.namespace}).
119+
*/
111120
NAMESPACE {
112121
@Override
113122
public String asString() {
114123
return "db.namespace";
115124
}
116125
},
126+
/**
127+
* The database collection name ({@code db.collection.name}).
128+
*/
117129
COLLECTION {
118130
@Override
119131
public String asString() {
120132
return "db.collection.name";
121133
}
122134
},
135+
/**
136+
* The database operation name ({@code db.operation.name}).
137+
*/
123138
OPERATION_NAME {
124139
@Override
125140
public String asString() {
126141
return "db.operation.name";
127142
}
128143
},
144+
/**
145+
* The database operation summary ({@code db.operation.summary}).
146+
*/
129147
OPERATION_SUMMARY {
130148
@Override
131149
public String asString() {
@@ -139,54 +157,81 @@ public String asString() {
139157
*/
140158
public enum CommandLowCardinalityKeyNames implements KeyName {
141159

160+
/**
161+
* The database system name ({@code db.system.name}).
162+
*/
142163
SYSTEM {
143164
@Override
144165
public String asString() {
145166
return "db.system.name";
146167
}
147168
},
169+
/**
170+
* The database namespace ({@code db.namespace}).
171+
*/
148172
NAMESPACE {
149173
@Override
150174
public String asString() {
151175
return "db.namespace";
152176
}
153177
},
178+
/**
179+
* The database collection name ({@code db.collection.name}).
180+
*/
154181
COLLECTION {
155182
@Override
156183
public String asString() {
157184
return "db.collection.name";
158185
}
159186
},
187+
/**
188+
* The database command name ({@code db.command.name}).
189+
*/
160190
COMMAND_NAME {
161191
@Override
162192
public String asString() {
163193
return "db.command.name";
164194
}
165195
},
196+
/**
197+
* The database query summary ({@code db.query.summary}).
198+
*/
166199
QUERY_SUMMARY {
167200
@Override
168201
public String asString() {
169202
return "db.query.summary";
170203
}
171204
},
205+
/**
206+
* The network transport ({@code network.transport}).
207+
*/
172208
NETWORK_TRANSPORT {
173209
@Override
174210
public String asString() {
175211
return "network.transport";
176212
}
177213
},
214+
/**
215+
* The server address ({@code server.address}).
216+
*/
178217
SERVER_ADDRESS {
179218
@Override
180219
public String asString() {
181220
return "server.address";
182221
}
183222
},
223+
/**
224+
* The server port ({@code server.port}).
225+
*/
184226
SERVER_PORT {
185227
@Override
186228
public String asString() {
187229
return "server.port";
188230
}
189231
},
232+
/**
233+
* The database response status code ({@code db.response.status_code}).
234+
*/
190235
RESPONSE_STATUS_CODE {
191236
@Override
192237
public String asString() {
@@ -200,54 +245,81 @@ public String asString() {
200245
*/
201246
public enum HighCardinalityKeyNames implements KeyName {
202247

248+
/**
249+
* The database query text ({@code db.query.text}).
250+
*/
203251
QUERY_TEXT {
204252
@Override
205253
public String asString() {
206254
return "db.query.text";
207255
}
208256
},
257+
/**
258+
* The client-side driver connection ID ({@code db.mongodb.driver_connection_id}).
259+
*/
209260
CLIENT_CONNECTION_ID {
210261
@Override
211262
public String asString() {
212263
return "db.mongodb.driver_connection_id";
213264
}
214265
},
266+
/**
267+
* The server-side connection ID ({@code db.mongodb.server_connection_id}).
268+
*/
215269
SERVER_CONNECTION_ID {
216270
@Override
217271
public String asString() {
218272
return "db.mongodb.server_connection_id";
219273
}
220274
},
275+
/**
276+
* The cursor ID ({@code db.mongodb.cursor_id}).
277+
*/
221278
CURSOR_ID {
222279
@Override
223280
public String asString() {
224281
return "db.mongodb.cursor_id";
225282
}
226283
},
284+
/**
285+
* The transaction number ({@code db.mongodb.txn_number}).
286+
*/
227287
TRANSACTION_NUMBER {
228288
@Override
229289
public String asString() {
230290
return "db.mongodb.txn_number";
231291
}
232292
},
293+
/**
294+
* The logical session ID ({@code db.mongodb.lsid}).
295+
*/
233296
SESSION_ID {
234297
@Override
235298
public String asString() {
236299
return "db.mongodb.lsid";
237300
}
238301
},
302+
/**
303+
* The exception message ({@code exception.message}).
304+
*/
239305
EXCEPTION_MESSAGE {
240306
@Override
241307
public String asString() {
242308
return "exception.message";
243309
}
244310
},
311+
/**
312+
* The exception type ({@code exception.type}).
313+
*/
245314
EXCEPTION_TYPE {
246315
@Override
247316
public String asString() {
248317
return "exception.type";
249318
}
250319
},
320+
/**
321+
* The exception stacktrace ({@code exception.stacktrace}).
322+
*/
251323
EXCEPTION_STACKTRACE {
252324
@Override
253325
public String asString() {

0 commit comments

Comments
 (0)