diff --git a/doc/devel/Benchmarking.md b/doc/devel/Benchmarking.md new file mode 100644 index 0000000000000000000000000000000000000000..a244a3a64b771060fbf025fc0ee47054b9b95b48 --- /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()`