From 23d3e05594a732cfc3880dc1986e160b22b6d41f Mon Sep 17 00:00:00 2001
From: Jorik Schellekens <joriks@matrix.org>
Date: Thu, 15 Aug 2019 11:05:10 +0100
Subject: [PATCH] EDU tracing data format documentation.

---
 docs/opentracing.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/opentracing.rst b/docs/opentracing.rst
index b91a2208a8fb..6a01f9c40a78 100644
--- 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
 ==================