Skip to content

Commit e538f82

Browse files
committed
chore: document non-compliance
1 parent 172c8ff commit e538f82

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,16 @@ See the [crate documentation on docs.rs] for more detailed examples.
7777
issues are found, please [open an issue]!
7878

7979
`ajj` produces [`tracing`] spans and events that meet the [OpenTelemetry
80-
semantic conventions] for JSON-RPC servers with the following exception:
80+
semantic conventions] for JSON-RPC servers with the following exceptions:
8181

8282
- The `server.address` attribute is NOT set, as the server address is not always
8383
known to the ajj system.
84+
- `rpc.message` events are included in AJJ system spans for the batch request,
85+
which technically does not comply with semantic conventions. The semantic
86+
conventions do not specify how to handle batch requests, and assume that each
87+
message corresponds to a separate request. In AJJ, batch requests are a single
88+
message, and result in a single `rpc.message` event at receipt and at
89+
response.
8490

8591
## Note on code provenance
8692

0 commit comments

Comments
 (0)