From 8cf03773d64013aa877d0b8d30e68e636746f718 Mon Sep 17 00:00:00 2001
From: Daniel <daniel@harvey>
Date: Thu, 24 Oct 2019 17:29:25 +0200
Subject: [PATCH] DOC: Documentation for benchmarking.

---
 doc/devel/Benchmarking.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 doc/devel/Benchmarking.md

diff --git a/doc/devel/Benchmarking.md b/doc/devel/Benchmarking.md
new file mode 100644
index 00000000..a244a3a6
--- /dev/null
+++ b/doc/devel/Benchmarking.md
@@ -0,0 +1,13 @@
+# Manual Java-Side Benchmarking #
+
+Benchmarking can be done using the `TransactionBenchmark` class (in package
+`caosdb.server.database.misc`).
+
+- Single timings can be added to instances of that class via the
+  `addBenchmark(object, time)` method.  Multiple benchmarks for the same object
+  (typically just strings) can be averaged.
+- Benchmarks can be serialized into XML, `Container` and `Query` objects already
+  use this with their included benchmarks to output benchmarking results.
+- To work with the benchmarks of often used objects, use these methods:
+  - `Container.getTransactionBenchmark().addBenchmark()`
+  - `Query.addBenchmark()`
-- 
GitLab