EDU tracing data format documentation.

matrix-org · Aug 16, 2019 · 23d3e05 · 23d3e05
1 parent 63179ef
commit 23d3e05
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/docs/opentracing.rst b/docs/opentracing.rst
@@ -92,6 +92,26 @@ two problems, namely:
   but that doesn't prevent another server sending you baggage which will be logged
   to OpenTracing's logs.
 
+==========
+EDU FORMAT
+==========
+
+EDUs can contain tracing data in their content. This is not specced but
+it could be of interest for other homeservers.
+
+Edu format:
+
+.. code-block:: json
+
+   edu: {
+     edu_type: "type"
+     content: {
+       context: {
+         ...opentracing_context
+       }
+     }
+   }
+
 ==================
 Configuring Jaeger
 ==================