update documentation

open-telemetry · Oct 3, 2023 · 093ab7f · 093ab7f
1 parent db6524d
commit 093ab7f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/tools/trace_analyzer/README.md b/tools/trace_analyzer/README.md
@@ -54,6 +54,19 @@ The following screenshot shows the output of the `-span-events=<n>` option.
 
 ![Span event record dump](./imgs/span_event_record.png)
 
+## Test sorting
+
+The option `-test-sorting` can be used to test all the combinations of sorting
+arrow records. This option is useful to ensure that the default sorting is
+working correctly.
+
+> Note: This option should not be combined with any other option.
+ 
+The following screenshot is an example of the output. At the end, the best
+combination is displayed.
+
+![Test sorting](./imgs/test_sorting.png)
+
 ## Schema-stats output
 
 For each batch (i.e. instance of ExportTraceServiceRequest), the following

diff --git a/tools/trace_analyzer/imgs/test_sorting.png b/tools/trace_analyzer/imgs/test_sorting.png