apple / foundationdb

FoundationDB - the open source, distributed, transactional key-value store
https://apple.github.io/foundationdb/
Apache License 2.0
14.33k stars 1.3k forks source link

Add documentation to transaction profiling #5939

Closed Daniel-B-Smith closed 2 years ago

Daniel-B-Smith commented 2 years ago

The transaction profiling feature is very useful for (among other things) diagnosing hot shards. However, it is under-documented so not necessarily useful to new users.

apkar commented 2 years ago

cc @bnamasivayam

sfc-gh-ngoyal commented 2 years ago

We added some documentation on this feature a while ago. https://github.com/apple/foundationdb/blob/master/documentation/sphinx/source/transaction-profiler-analyzer.rst Feel free to enhance it.