summary refs log tree commit diff
path: root/docs/development/internal_documentation/room_and_user_statistics.md
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2021-11-21 02:39:02 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2021-11-21 02:39:02 +0000
commit1a8406f42ac3a7f63690c13cb8d8fd5547928632 (patch)
treeb87d0c0ca33f6f2eea33cf953aef9767183c702f /docs/development/internal_documentation/room_and_user_statistics.md
parentUpdate README.md (diff)
downloadsynapse-1a8406f42ac3a7f63690c13cb8d8fd5547928632.tar.xz
Move documentation files to their place in the hierarchy; update SUMMARY.md github/anoa/doc_hierarchy anoa/doc_hierarchy
Diffstat (limited to 'docs/development/internal_documentation/room_and_user_statistics.md')
-rw-r--r--docs/development/internal_documentation/room_and_user_statistics.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/development/internal_documentation/room_and_user_statistics.md b/docs/development/internal_documentation/room_and_user_statistics.md
new file mode 100644

index 0000000000..cc38c890bb --- /dev/null +++ b/docs/development/internal_documentation/room_and_user_statistics.md
@@ -0,0 +1,22 @@ +Room and User Statistics +======================== + +Synapse maintains room and user statistics in various tables. These can be used +for administrative purposes but are also used when generating the public room +directory. + + +# Synapse Developer Documentation + +## High-Level Concepts + +### Definitions + +* **subject**: Something we are tracking stats about – currently a room or user. +* **current row**: An entry for a subject in the appropriate current statistics + table. Each subject can have only one. + +### Overview + +Stats correspond to the present values. Current rows contain the most up-to-date +statistics for a room. Each subject can only have one entry.