SiyaoIsHiding commented on code in PR #2037:
URL: 
https://github.com/apache/cassandra-java-driver/pull/2037#discussion_r2101366329


##########
manual/core/request_id/README.md:
##########
@@ -0,0 +1,69 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+## Request Id
+
+### Quick overview
+
+Users can inject an identifier for each individual CQL request, and such ID 
can be written in to the custom payload to 
+correlate a request across the driver and the Apache Cassandra server.
+
+A request ID generator needs to generate both:
+- Session request ID: an identifier for an entire session.execute() call
+- Node request ID: an identifier for the execution of a CQL statement against 
a particular node. There can be one or more node requests for a single session 
request, due to retries or speculative executions.

Review Comment:
   I took the name "node request" v.s. "session request" from [c# opentelemetry 
](https://docs.datastax.com/en/developer/csharp-driver/3.22/features/opentelemetry/index.html#attributes)feature.
 
   > 
   db.operation.name | The type name of the operation being executed. | 
Session_Request({RequestType}) for session level calls and 
Node_Request({RequestType}) for node level calls
   -- | -- | --
   
   And Lukasz's outstanding request tracker interface 
[PR](https://github.com/apache/cassandra-java-driver/pull/1949/files#r1738385801).
   Do you think we should align with their naming?
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org
For additional commands, e-mail: pr-h...@cassandra.apache.org

Reply via email to